Skip to content
Titanium SDK
Version13.1.1

You are reading 13.1.1. See this page in 13.4.1.

Titanium.UI.iOS.CollisionBehavior

proxyiPhoneiPadmacOSsince iPhone 3.2.0, iPad 3.2.0, macOS 9.2.0

Extends Titanium.Proxy

Dynamic behavior to support collisions between items and boundaries.

A collision behavior specifies the behavior when items collide with each other and boundaries. To define a collision behavior:

  1. Use the Titanium.UI.iOS.createCollisionBehavior method to create and define the behavior.
  2. Use the addItem method to add items to the behavior.
  3. Use the addBoundary method to add custom boundaries for the item to collide with. By default, the behavior uses the Animator object's reference view as the boundary.
  4. Add the behavior to an Animator object.

Examples

Simple Example

The following example creates many blocks scattered across the top of the window, which start falling after the window opens. The item and boundary collisions are reported to the console.

var win = Ti.UI.createWindow({backgroundColor: 'white', fullscreen: true});

// Create an Animator object using the window as the coordinate system
var animator = Ti.UI.iOS.createAnimator({referenceView: win});

// Create a default collision behavior, using the window edges as boundaries
var collision = Ti.UI.iOS.createCollisionBehavior();

// Listen for collisions
function report(e) {
    Ti.API.info(JSON.stringify(e.type));
};
collision.addEventListener('itemcollision', report);
collision.addEventListener('boundarycollision', report);

// Simulate Earth's gravity
var gravity = Ti.UI.iOS.createGravityBehavior({
    gravityDirection: {x: 0.0, y: 1.0}
});

var WIDTH = Ti.Platform.displayCaps.platformWidth;
var HEIGHT = Ti.Platform.displayCaps.platformHeight;

// Create a bunch of random blocks; add to the window and behaviors
var blocks = [];   
for (var i = 0; i < 25; i++) {
    var r = Math.round(Math.random() * 255);
    var g = Math.round(Math.random() * 255);
    var b = Math.round(Math.random() * 255);
    var rgb = 'rgb(' + r +"," + g + "," + b + ")";

    blocks[i] = Ti.UI.createView({
        width: 25,
        height: 25,
        top: Math.round(Math.random() * (HEIGHT / 4) + 25),
        left: Math.round(Math.random() * (WIDTH - 25) + 25),
        backgroundColor: rgb
    });
    win.add(blocks[i]);
    collision.addItem(blocks[i]);
    gravity.addItem(blocks[i]);
}

animator.addBehavior(collision);
animator.addBehavior(gravity);

// Start the animation when the window opens
win.addEventListener('open', function(e){
    animator.startAnimator();
});

win.open();

Properties 7

apiName

Stringsince Android 3.2.0, iPhone 3.2.0, iPad 3.2.0, macOS 9.2.0read-only

Inherited from Titanium.Proxy

The name of the API that this proxy corresponds to.

boundaryIdentifiers

Array<BoundaryIdentifier>read-only

Boundary identfiers added to this behavior.

bubbleParent

Booleansince Android 3.0.0, iPhone 3.0.0, iPad 3.0.0, macOS 9.2.0

Inherited from Titanium.Proxy

Indicates if the proxy will bubble an event to its parent.

Default: true

Insets to apply when using the animator's reference view as the boundary.

The treatReferenceAsBoundary property needs to be set to true to use this property.

Default: All insets are zero.

Use the animator's reference view as the boundary.

Set to true to enable this behavior or false to disable it.

Default: true

Methods 9

Adds a boundary to this behavior.

Parameters
ParametersTypeDescription
boundaryBoundaryIdentifier

Boundary to add to the behavior.

3 fields
identifier String

Arbitrary identifier for the boundary

point1 Point

Start point for the boundary

point2 Point

End point for the boundary

Inherited from Titanium.Proxy

Adds the specified callback as an event listener for the named event.

Parameters
ParametersTypeDescription
nameString

Name of the event.

callbackCallback<Titanium.Event>

Callback function to invoke when the event is fired.

4 fields
bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.

source Object

Source object that fired the event.

type String

Name of the event fired.

Adds an item to this behavior.

Parameters
ParametersTypeDescription
itemTitanium.UI.View

View object to add to the behavior.

Inherited from Titanium.Proxy

Fires a synthesized event to any registered listeners.

Parameters
ParametersTypeDescription
nameString

Name of the event.

event?Dictionary

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

Removes the specified boundary from this behavior.

Parameters
ParametersTypeDescription
boundaryBoundaryIdentifier

Boundary to remove.

3 fields
identifier String

Arbitrary identifier for the boundary

point1 Point

Start point for the boundary

point2 Point

End point for the boundary

Inherited from Titanium.Proxy

Removes the specified callback as an event listener for the named event.

Parameters
ParametersTypeDescription
nameString

Name of the event.

callbackCallback<Titanium.Event>

Callback function to remove. Must be the same function passed to addEventListener.

4 fields
bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.

source Object

Source object that fired the event.

type String

Name of the event fired.

Events 2

Fired when an item collides with a boundary.

Event properties
Event propertiesTypeDescription
itemTitanium.UI.View

Item that collided with the boundary.

identifierString

Identifier of the boundary the item collided with.

pointPoint

Point of the collision when it started. Only returned when start is true.

startBoolean

Returns true if the collision started else false.

Fired when two items collide.

Event properties
Event propertiesTypeDescription
item1Titanium.UI.View

Item that collided with item2.

item2Titanium.UI.View

Item that collided with item1.

pointPoint

Point of the collision when it started. Only returned when start is true.

startBoolean

Returns true if the collision started else false.