InterpolatedAnimation Reference

Modified on 2010/05/04 23:38 by Stephen Walther — Categorized as: Uncategorized

InterpolatedAnimation Client Reference

The InterpolatedAnimation assigns a range of values between startValue and endValue to the designated property.

InterpolatedAnimation Client Properties

durationLength of the animation in seconds. The default is 1.
endValueEnd of the range of values
eventsThe collection of event handlers for this behavior. This property should only be used by derived behaviors and should not be publicly called by other code.
fpsNumber of steps per second. The default is 25.
isActivetrue if animation is active, false if not.
isPlayingtrue if animation is playing, false if not.
percentCompletePercentage of the animation already played.
propertyProperty of the target element to set when animating
propertyKeyOptional key of the property to be set (which indicates the value propertypropertyKey, like style'backgroundColor'). Note that for the style property, the key must be in a JavaScript friendly format (i.e. backgroundColor instead of background-color).
startValueStart of the range of values

InterpolatedAnimation Client Methods

dispose Dispose the animation
getAnimatedValue Determine the state of the animation after the given percentage of its duration has elapsed
getValue Get the current value from the property
interpolate The interpolate function is used to find the appropriate value between starting and ending values given the current percentage.
onEnd The onEnd method is called just after the animation is played each time.
onStart The onStart method is called just before the animation is played each time.
onStep The onStep method is called repeatedly to progress the animation through each frame
pause Pause the animation if it is playing. Calling play will resume where the animation left off.
play Play the animation from the beginning or where it was left off when paused.
play Create an animation, play it immediately, and dispose it when finished.
raiseEnded Raise the ended event
raisePropertyChangedRaises a change notification event.
raiseStarted Raise the started event
raiseStep Raise the step event
setOwner Make this animation the child of another animation
setValue Set the current value of the property
stop Stop playing the animation.

InterpolatedAnimation Client Events

ended Adds an event handler for the ended event.
started Adds an event handler for the started event.
step Adds an event handler for the step event.