ParentAnimation Reference

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

ParentAnimation Client Reference

The ParentAnimation serves as a base class for all animations that contain children (such as , , etc.). It does not actually play the animations, so any classes that inherit from it must do so. Any animation that requires nested child animations must inherit from this class, although it will likely want to inherit off of or which will actually play their child animations.

ParentAnimation Client Properties

NameDescription
animationsArray of child animations to be played (there are no assumptions placed on order because it will matter for some derived animations like , but not for others like ). To manipulate the child animations, use the functions add, clear, remove, and removeAt.
durationLength of the animation in seconds. The default is 1.
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.
id
isActivetrue if animation is active, false if not.
isInitialized
isPlayingtrue if animation is playing, false if not.
isUpdating
percentCompletePercentage of the animation already played.
target

ParentAnimation Client Methods

NameDescription
add Add an animation as a child of this animation.
beginUpdate
clear Clear the array of child animations.
dispose Dispose of the child animations
endUpdate
getAnimatedValue Determine the state of the animation after the given percentage of its duration has elapsed
initialize Initialize the parent along with any child animations that have not yet been initialized themselves
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
remove Remove the animation from the array of child animations.
removeAt Remove the animation at a given index from the array of child animations.
setOwner Make this animation the child of another animation
setValue Set the current state of the animation
stop Stop playing the animation.
updated

ParentAnimation Client Events

NameDescription
disposing
ended Adds an event handler for the ended event.
propertyChanged
started Adds an event handler for the started event.
step Adds an event handler for the step event.