Provides support for the built-in iOS dynamic animations
Requires: iOS 7.0 and later
The following APIs are supported on iOS 7 and later.
The animator provides physics-related capabilities and animations using the iOS physics engine. Each animator is independent of other animators you create. An animator is comprised of behaviors and items. Behaviors define the rules of the animation, while items are the view objects to be animated. An item in the animator can be given multiple behaviors as long as those behaviors belong to the same animator.
To use these dynamic animations, first create the items to animate, then:
1. Create an animator using the Titanium.UI.iOS.createAnimator method.
2. Set the referenceView property to establish the coordinate system for the animations.
3. Create and add items to one or more of the following behaviors:
4. Add these behaviors to the animator with the addBehavior method.
5. Start the animator with startAnimator method.
Once all items are at rest, the animator automatically pauses, and resumes if a behavior parameter changes, or a behavior or item is added or removed.
See the behaviors listed above for examples of animating items.
The Titanium view object set to the Animator's referenceView property establishes the coordinate system for the animation behaviors and items. Each item that needs to be animated must be a child of the reference view.
By default, when you create a collision behavior, the behavior uses the edge's of the reference view as its boundary, so any item within this view cannot be pushed out of it.
Use the following lists as references when specifying your animation behaviors.
Points
The following list notes the location of notable points in the coordinate system, where WIDTH and HEIGHT are the width and height of the reference view, respectively.
Note that on iOS a point is equivalent to a display pixel.
Vectors
Gravity and push forces may be specified as vectors with the gravityDirection and
pushDirection properties, respectively. The following list notes the direction and its
corresponding vector:
Angles
Gravity and push forces may be specified with the angle and magnitude properties.
Specify all angle values as radians (360 degrees = 2 * pi radians). The following list notes
the direction and its corresponding angle:
The name of the API that this proxy corresponds to.
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.
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.
Default: true
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
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.
Titanium View object to initialize as the reference view for the animator.
Titanium View object to initialize as the reference view for the animator.
When adding behavior and dynamic items to the animator, the animator bases its coordindate system on the reference view.
Returns true if the animator is running else false.
Returns true if the animator is running else false.
Adds a dynamic behavior to the animator.
Specify an instance of one of the following Titanium behavior proxies:
Behavior to add to the animator.
Adds the specified callback as an event listener for the named event.
Name of the event.
Callback function to invoke when the event is fired.
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.
A dictionary of properties to apply.
Fires a synthesized event to any registered listeners.
Name of the event.
A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.
Removes the specified behavior from the animator.
Specifiy an instance of one of the following Titanium behavior proxies:
Behavior to remove from the animator.
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);
Name of the event.
Callback function to remove. Must be the same function passed to addEventListener.
Sets the value of the behaviors property.
New value for the property.
Sets the value of the bubbleParent property.
New value for the property.
Sets the value of the lifecycleContainer property.
New value for the property.
Sets the value of the referenceView property.
New value for the property.
Updates the animator's state information with the current state of the specified item.
When an item is first added to the animator, the animator reads the initial state of the item, then takes responsibility for updating it. If you actively make changes to the item's properties, such as changing its position or dimensions, use this method to update the item's new state.
Item to update with new state information.
Fired when the animator paused its animations.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the animator resumes its animations.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.