Titanium.UI.Animation
The Animation object defines an animation that can be applied to a view.
An animation object describes the properties of an animation. At its most basic, an animation object represents a single-phase animation with an end state and a duration.
When animate is called on a View, the view is animated from its current state to the state described by the animation object. The properties that can be animated include the view's position, size, colors, transformation matrix and opacity.
You can also specify an animation curve or easing function to control the pace of the animation. To use an easing function, set the animation's curve property to one of the ANIMATION_CURVE constants defined in Titanium.UI. For example, ANIMATION_CURVE_EASE_IN specifies an animation that starts slowly and then speeds up.
Animations can be set to reverse themselves automatically on completion, and to repeat a given number of times. For more complicated effects, multiple animations can be combined in sequence, starting one animation when the previous animation completes.
Use the Titanium.UI.createAnimation method to create an animation object.
Note that on SDKs older than 9.1.0, when you animate a view's size or position the actual layout properties (such as top, left, width, height) are not changed by the animation. See the description of the animate method for more information.
As of 9.1.0, the animated properties should reflect their final values just before the complete event and/or the <Ti.UI.View.animate> callback is fired.
iOS Platform Notes
iOS supports both 2D and 3D matrix transformations in animations.
iOS also supports transitions between windows or views. You can create a transition by creating an animation object and setting the view property to the view you want to transition to. The transition property specifies the transition effect to apply. Use one of the transition style constants defined in Titanium.UI.iOS.AnimationStyle.
Android Platform Notes
Android supports 2D matrix transformations. Note that the Matrix2D.rotate method operates differently on Android. Called with a single argument, it rotates from zero to the specified angle. That is, it ignores any existing rotation. Called with two arguments, it interprets the first argument as a "from" angle and the second argument as a "to" angle.
Extends: Titanium.Proxy · Since: 0.9 · Platforms: android, iphone, ipad, macos
Properties #
anchorPoint#
Type: Point
Coordinate of the view about which to pivot an animation.
Used on Android only. For iOS, use Titanium.UI.View.anchorPoint.
Anchor point is specified as a fraction of the view's size. For example, {0, 0} is at
the view's top-left corner, {0.5, 0.5} at its center and {1, 1} at its bottom-right
corner.
This property's value will overwrite the anchorPoint used in the matrix's creation dictionary.
See the "Using an anchorPoint" example for a demonstration.
apiName#
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.
backgroundColor#
Type: String, Titanium.UI.Color
Value of the backgroundColor property at the end of the animation, as a color name
or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
bounce#
Type: Number
The animation bounce. If set, the animation uses the iOS 17+ spring animation.
When bounce is 0, there are no bounces, positive values indicate increasing amounts of bounciness up to a maximum
of 1.0 (corresponding to undamped oscillation), and negative values indicate overdamped springs with a minimum value of -1.0.
bubbleParent#
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.
color#
Type: String, Titanium.UI.Color
Value of the color property at the end of the animation, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
dampingRatio#
Type: Number
The damping ratio for the spring animation as it approaches its quiescent state.
Use a value between 0 and 1. For a smoother deceleration use values closer to 1.
To increase oscillation use value closer to 0.
lifecycleContainer#
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.
repeat#
Type: Number
Number of times the animation should be performed.
If autoreverse is true, then one repeat of the animation consists of the animation
being played once forward, and once backward.
springVelocity#
Type: Number
The initial spring velocity.
For smooth start to the animation, match this value to the velocity of view as it was prior to attachment.
A value of 1 corresponds to the total animation distance traversed in one second.
For example, if the total animation distance is 200 points and you want the start of the
animation to match a view velocity of 100 pt/s, use a value of 0.5.
transform#
Type: Titanium.UI.Matrix2D, Titanium.UI.Matrix3D
Animate the view from its current transform to the specified transform.
Over the course of the animation, the view interpolates from its current transform to the
specified transform.
3D transforms are only supported on iOS.
transition#
Type: Number
Transition type to use during a transition animation.
The new view being transitioned to should NOT be a child of another view or
of the animating view. The animation replaces the current view from the
view hierarchy and adds the new view to it.
view#
Type: Titanium.UI.View
New view to transition to.
Specify the transition property with one of the transition style constants defined
in Titanium.UI.iOS.AnimationStyle to select the effect to apply.
The new view being transitioned to should NOT be a child of another view or
of the animating view. The animation replaces the current view from the
view hierarchy and adds the new view to it.
zIndex#
Type: Number
Value of the zIndex property at the end of the animation.
Refer to Titanium.UI.View.zIndex for an explanation of z-index.
Methods #
addEventListener #
Adds the specified callback as an event listener for the named event.
| 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 |
applyProperties #
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.
| Name | Type | Summary | Optional |
|---|---|---|---|
props | Dictionary | A dictionary of properties to apply. | No |
fireEvent #
Fires a synthesized event to any registered listeners.
| 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 |
removeEventListener #
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 | 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 |
Events #
cancel #
Fired when the animation is canceled.
complete #
Fired when the animation completes.
start #
Fired when the animation starts.
Examples #
Simple Animation Applied to a View
Create a simple animation and apply it to the view. In this example, the view will animate from red to black to orange over 2 seconds.
var view = Titanium.UI.createView({
backgroundColor:'red'
});
var animation = Titanium.UI.createAnimation();
animation.backgroundColor = 'black';
animation.duration = 1000;
var animationHandler = function() {
animation.removeEventListener('complete',animationHandler);
animation.backgroundColor = 'orange';
view.animate(animation);
};
animation.addEventListener('complete',animationHandler);
view.animate(animation);Animation Using Matrix Transforms
The following example uses a transformation matrix to animate a view when the view is clicked. The animation rotates and scales the view, then returns it to its original size and position. The entire animation is repeated three times.
var box = Ti.UI.createView({
backgroundColor : 'red',
height : '100',
width : '100'
});
win.add(box);
box.addEventListener('click', function() {
var matrix = Ti.UI.createMatrix2D();
matrix = matrix.rotate(180);
matrix = matrix.scale(2, 2);
var a = Ti.UI.createAnimation({
transform : matrix,
duration : 2000,
autoreverse : true,
repeat : 3
});
box.animate(a);
});
win.add(box);Using an anchorPoint (Android and iOS)
Create a button and a blue square view. For each click of the button, apply a 90 degree rotation animation pivoted at one of a series of anchor points. In particular, note that an anchor point is configured using the <Titanium.UI.Animation.anchorPoint> property for Android and the <Titanium.UI.View.anchorPoint> property for iOS.
var animationType = [
{ name: 'Top Left', anchorPoint: {x:0, y:0} },
{ name: 'Top Right', anchorPoint: {x:1, y:0} },
{ name: 'Bottom Left', anchorPoint: {x:0, y:1} },
{ name: 'Bottom Right', anchorPoint: {x:1, y:1} },
{ name: 'Center', anchorPoint: {x:0.5, y:0.5} }
];
var animationTypeLength = animationType.length;
var animationCount = 0;
var animationTypePointer = 0;
var t = Ti.UI.createMatrix2D();
t = t.rotate(90);
// animation properties
var a = {
transform: t,
duration: 2000,
autoreverse: true
};
Ti.UI.backgroundColor = 'white';
var win = Ti.UI.createWindow();
var view = Ti.UI.createView({
backgroundColor:'#336699',
width:100, height:100
});
win.add(view);
var button = Ti.UI.createButton({
title:'Animate ' + animationType[animationTypePointer].name,
height: (Ti.UI.Android) ? 80 : 40,
width: (Ti.UI.Android) ? 300 : 200,
top:30
});
win.add(button);
function updateButton(name){
button.title = 'Animate ' + name;
}
button.addEventListener('click', function(){
// set new anchorPoint on animation for Android
a.anchorPoint = animationType[animationTypePointer].anchorPoint;
// set new anchorPoint on view for iOS
view.anchorPoint = animationType[animationTypePointer].anchorPoint;
animationCount++;
// determine position of next object in animationType array or return to first item
// using modulus operator
animationTypePointer = animationCount % animationTypeLength;
// animate view, followed by callback to set next button title
view.animate(a, function(){
updateButton(animationType[animationTypePointer].name);
});
});
win.open();