Titanium.UI.iOS.CollisionBehavior

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.

Extends: Titanium.Proxy · Since: 3.2.0, 3.2.0, 9.2.0 · Platforms: iphone, ipad, macos

Properties

apiName

extended

3.2.0

3.2.0

3.2.0

9.2.0

Type: String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Button
returns Ti.UI.Button.

boundaryIdentifiers

0.9

0.9

0.9

9.2.0

Type: Array<BoundaryIdentifier>

Boundary identfiers added to this behavior.

bubbleParent

extended

3.0.0

3.0.0

3.0.0

9.2.0

Type: Boolean

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

Some proxies (most commonly views) have a relationship to other proxies, often
established by the add() method. For example, for a button added to a window, a
click event on the button would bubble up to the window. Other common parents are
table sections to their rows, table views to their sections, and scrollable views
to their views. Set this property to false to disable the bubbling to the proxy's parent.

collisionMode

0.9

0.9

0.9

9.2.0

Type: Number

Specifies the collision behavior.

items

0.9

0.9

0.9

9.2.0

Type: Array<Titanium.UI.View>

Items added to this behavior.

lifecycleContainer

extended

3.6.0

Type: Titanium.UI.Window, Titanium.UI.TabGroup

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks
will also be called on the proxy. Proxies that require the activity lifecycle will need this property set
to the appropriate containing Window or TabGroup.

referenceInsets

0.9

0.9

0.9

9.2.0

Type: Padding

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.

treatReferenceAsBoundary

0.9

0.9

0.9

9.2.0

Type: Boolean

Use the animator's reference view as the boundary.

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

Methods

addBoundary

0.9

0.9

0.9

9.2.0

Adds a boundary to this behavior.

Parameters:

Name	Type	Summary	Optional
boundary	BoundaryIdentifier	Boundary to add to the behavior.	No

addEventListener

extended

0.9

0.9

0.9

9.2.0

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

Parameters:

Name	Type	Summary	Optional
name	String	Name of the event.	No
callback	Callback<Titanium.Event>	Callback function to invoke when the event is fired.	No

addItem

0.9

0.9

0.9

9.2.0

Adds an item to this behavior.

Parameters:

Name	Type	Summary	Optional
item	Titanium.UI.View	View object to add to the behavior.	No

applyProperties

extended

3.0.0

3.0.0

3.0.0

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that
myproxy[key] = value.

Parameters:

Name	Type	Summary	Optional
props	Dictionary	A dictionary of properties to apply.	No

fireEvent

extended

0.9

0.9

0.9

9.2.0

Fires a synthesized event to any registered listeners.

Parameters:

Name	Type	Summary	Optional
name	String	Name of the event.	No
event	Dictionary	A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.	Yes

removeAllBoundaries

0.9

0.9

0.9

9.2.0

Removes all boundaries from this behavior.

removeBoundary

0.9

0.9

0.9

9.2.0

Removes the specified boundary from this behavior.

Parameters:

Name	Type	Summary	Optional
boundary	BoundaryIdentifier	Boundary to remove.	No

removeEventListener

extended

0.9

0.9

0.9

9.2.0

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

Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function
in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);

Parameters:

Name	Type	Summary	Optional
name	String	Name of the event.	No
callback	Callback<Titanium.Event>	Callback function to remove. Must be the same function passed to addEventListener.	No

removeItem

0.9

0.9

0.9

9.2.0

Removes the specified item from this behavior.

Parameters:

Name	Type	Summary	Optional
item	Titanium.UI.View	Item to remove.	No

Events

boundarycollision

0.9

0.9

0.9

9.2.0

Fired when an item collides with a boundary.

Event Properties:

Name	Type	Summary
item	Titanium.UI.View	Item that collided with the boundary.
identifier	String	Identifier of the boundary the item collided with.
point	Point	Point of the collision when it started. Only returned when start is true.
start	Boolean	Returns true if the collision started else false.

itemcollision

0.9

0.9

0.9

9.2.0

Fired when two items collide.

Event Properties:

Name	Type	Summary
item1	Titanium.UI.View	Item that collided with item2.
item2	Titanium.UI.View	Item that collided with item1.
point	Point	Point of the collision when it started. Only returned when start is true.
start	Boolean	Returns true if the collision started else false.

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. <img src="./collision.gif" height="455" style="border:1px solid black"/>

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();