- animate
- goto
- animationStyle
- orientToPath
- orientOnPath
- addChild
- removeChild
- accept
- getChildren
- roundResult
- forceEnd
- getOptimizationMode
- setOptimizationMode
- getTweenMode
- setTweenMode
- getDurationMode
- setDurationMode
- stop
- pause
- resume
- lock
- unlock
- isTweening
- getStartValue
- getEndValue
- getCurrentValue
- getCurrentPercentage
- getDurationElapsed
- getDurationRemaining
- addEventListener
- removeEventListener
- removeAllEventListeners
- eventListenerExists
- getID
- toString

var myMOP:MoveOnPath = new MoveOnPath(mc);

var myMOP:MoveOnPath = new MoveOnPath(mc, duration);

var myMOP:MoveOnPath = new MoveOnPath(mc, duration, callback);

var myMOP:MoveOnPath = new MoveOnPath(mc, duration, easing, callback);

animate

description: animates the contents of the composite.

usage:

myInstance.animate(start, end);

parameters:

• start (Number) start value. Percentage.
• end (Number) end value. Percentage.

returns: void

goto

description: jumps to a specific step of the animation and stays there.

usage:

instance.goto(percentage);

parameters:

• percentage (Number) Percentage value of the animation.

returns: void

animationStyle

description: set the animation style properties for your animation. Notice that if your easing equation supports additional parameters you can send those parameters with the easing parameter in animationStyle. You have to send an Array as easing parameter. The first element has to be the easing equation in Robert Penner style. The following parameters can be your additional parameters. i.e.:

				var myRotation:Rotation = new Rotation(mc);
				myRotation.animationStyle(2000,[Back.easeOut,4]);
				myRotation.run(360);
				

See also "Customizable easing equations" in readme for more information.

usage:

myInstance.animationStyle(duration);

myInstance.animationStyle(duration, callback);

myInstance.animationStyle(duration, easing, callback);

parameters:

• duration (Number) Duration of animation in milliseconds or frames. Default is milliseconds.
• easing (Object) Easing equation in Robert Penner style. Default equation is Linear.easeNone. www.robertpenner.com/easing/
• callback (String) Function to invoke after animation. See APCore class.

returns: Void.

orientToPath

description: offers the opportunity to rotate the object towards the curve while animating. Default is false. If true the object orientates towards the curve. If false the object's rotation will not be altered. See class documentation.

usage:

myInstance.orientToPath(rotateTo);

parameters:

• rotateTo (Boolean) true or false.

returns: void

orientOnPath

description: offers the opportunity to rotate the object on the curve while animating. Default is false. If true the object orientates on the curve. If false the object's rotation will not be altered. See class documentation.

usage:

myInstance.orientToPath(rotateOn);

parameters:

• rotateOn (Boolean) true or false.

returns: void

addChild

description: adds a primitive or composite to the composite instance of Parallel See class description.

usage:

myInstance.addChild(component);

parameters:

• component (IAnimatable) Must be compatible to IAnimatable.

returns: IAnimatable class that was added.

removeChild

description: removes a primitive or composite from the composite instance of Parallel See class description.

usage:

myInstance.removeChild(component);

parameters:

• component (IAnimatable) Must be compatible to IAnimatable.

returns: Void.

accept

description: Allow a visitor to visit its elements. See Visitor design pattern [GoF].

usage:

myInstance.accept(visitor);

parameters:

• visitor (IVisitor) Must be compatible to de.alex_uhlmann.animationpackage.utility.IVisitor.

returns: Void.

getChildren

description: returns an Array of all children of the sequence. Could contain other Sequences.

usage: myInstance.getChildren();

returns: Array

roundResult

description: rounds animation results to integers. (might be usefull for animating pixelfonts). Default is false.

usage:

myInstance.roundResult(rounded);

parameters:

• rounded (Boolean) true rounds the result. Animates with integers. Less accuracy. false animates with floating point numbers.

returns: Void.

forceEnd

description: Flash does not guaranteed that time-based tweening will reach the end value(s) of your animation. By default AnimationPackage guarantees that the end value(s) will be reached. The forceEnd method allows you to disable this guarantee and only accept the values from your easing equation. In certain situations this can lead to a smoother ending of the animation. Notice that in frame-based tweening the end value(s) will always be reached.

usage:

myInstance.forceEnd(forceEndVal);

parameters:

• forceEndVal (Boolean) true or false.

returns: Void.

getOptimizationMode

description: returns the optimization mode. See setOptimizationMode for more information.

usage: getOptimizationMode();

returns: Boolean

setOptimizationMode

description: Allows to explicitly remove parts of the animation that don't change during the animation. This can add additional performance to your animation. Note that setting this method to true has side effects. If all start and end values match, the animation won't start and will immediatly invoke an onEnd event. The order of values returned by getStartValue(s), getCurrentValue(s), getEndValue(s) and the value property of the eventObject returned by EventDispatcher might change if you set this method to true. You can still retrieve the parts of the animation that are actually animated if you access the Animator instance of your animation class via myAnimator. Ask myInstance.myAnimator.setter to retrieve all currently animated parts of the animation. See Animator documentation. Of cource, if you know your input values you would probably look at them.

Note that the AnimationCore class offers a static setOptimizationModes method (note the last "s" at the end) that allows you to remove parts of 'all' your animations that don't change during the animation.

usage:

myInstance.setOptimizationMode(optimize);

parameters:

• optimize (Boolean)

returns: Void.

getTweenMode

description: returns the current tween mode used by the instance. Please check with AnimationCore.setTweenModes for more information.

usage: getTweenMode();

returns: String that specifies the tween mode. Either AnimationCore.INTERVAL or AnimationCore.FRAMES.

setTweenMode

description: sets the current tween mode used by the instance. Please check with AnimationCore.setTweenModes for more information.

usage: setTweenMode();

parameters:

• t (String) Either AnimationCore.INTERVAL for time-based tweening or AnimationCore.FRAMES for frame-based tweening.

returns: true if setting tween mode was successful, false if not successful.

getDurationMode

description: returns the current duration mode used by the instance. Please check with AnimationCore.setTweenModes for more information.

usage: getDurationMode();

returns: String that specifies the duration mode. Either AnimationCore.MS or AnimationCore.FRAMES.

setDurationMode

description: sets the current duration mode used by the instance. Please check with AnimationCore.setTweenModes for more information.

usage: setDurationMode();

parameters:

• d (String) Either AnimationCore.MS for milliseconds or AnimationCore.FRAMES.

returns: true if setting duration mode was successful, false if not successful.

stop

description: stops the animation if not locked..

usage: myInstance.stop();

returns: true if instance was successfully stopped. false if instance could not be stopped, because it was locked.

pause

description: pauses the animation if not locked. Call resume() to continue animation.

usage: myInstance.pause();

parameters:

• duration (Number) optional property. Number of milliseconds or frames to pause before continuing animation.

returns: true if instance was successfully paused. false if instance could not be paused, because it was locked.

resume

description: continues the animation if not locked.

usage: myInstance.resume();

returns: true if instance was successfully resumed. false if instance could not be resumed, because it was locked.

lock

description: locks the animation to prevent pausing, resuming and stopping. Default is unlocked.

usage: myInstance.lock();

returns: Void.

unlock

description: unlocks the animation to allow pausing, resuming and stopping. Default is unlocked.

usage: myInstance.unlock();

returns: Void.

isTweening

description: checks if the instance is currently animated.

usage: myInstance.isTweening();

returns: true if instance is tweening, false if instance is not tweening.

getStartValue

description: returns the original, starting value of the current tween. Percentage.

usage: myInstance.getStartValue();

returns: Number

getEndValue

description: returns the targeted value of the current tween. Percentage.

usage: myInstance.getEndValue();

returns: Number

getCurrentValue

description: returns the current value of the current tween. Percentage.

usage: myInstance.getCurrentValue();

returns: Number

getCurrentPercentage

description: returns the current state of the animation in percentage. Especially usefull in combination with goto().

usage: myInstance.getCurrentPercentage();

returns: Number

getDurationElapsed

description: returns the elapsed time or frames since the current tween started tweening.

usage: myInstance.getDurationElapsed();

returns: Number

getDurationRemaining

description: returns the remaining time or frames since the current tween started tweening.

usage: myInstance.getDurationRemaining();

returns: Number

addEventListener

description: Subscribe to a predefined event. The following standard EventDispatcher events are broadcasted

onStart, broadcasted when animation starts.
onUpdate, broadcasted when animation updates.
onEnd, broadcasted when animation ends.

The even object returned, contains the following properties:

type (String) event broadcasted.
target (Object) event source.
value (Number) value to animate.

usage:

myMOC.addEventListener(event, listener);

myMOC.addEventListener(event, listener, handler);

parameters:

• event (String) Event to subscribe listener to. GDispatcher specific feature allows to subscribe to all events from an event source if the string "ALL" is passed.
• listener (Object) The listener object to subscribe to the specified event.
• handler (String) Optional. GDispatcher specific feature. The name of a function to call. This function will be called within the scope of the object specified in the second parameter.

returns: Void.

removeEventListener

description: Removes a listener from a subscribed event.

usage:

myMOC.removeEventListener(event, listener);

myMOC.removeEventListener(event, listener, handler);

parameters:

• event (String) Event to remove subscribed listener from. GDispatcher specific feature allows to remove subscribtion to all events if the string "ALL" is passed. Works only if listener has been subscribed via the "ALL" string in addEventListener.
• listener (Object) The listener object to unsubscribe from the specified event.
• handler (String) Optional. GDispatcher specific feature. Only needed if the listener has been subscribed with a handler function.

returns: Void.

removeAllEventListeners

description: GDispatcher specific feature. Removes all listeners for a specific event, or for all events.

usage:

myMOC.removeAllEventListeners();

myMOC.removeAllEventListeners(event);

parameters:

• event (String) Event to remove all subscribed listeners from. If not specified, all listeners to any event will be removed.

returns: Void.

eventListenerExists

description: GDispatcher specific feature. Checks if a listener is already subscribed to a certain event.

usage:

myMOC.eventListenerExists(event, listener);

myMOC.eventListenerExists(event, listener, handler);

parameters:

• event (String) Event to check subscription.
• listener (Object) The listener object to check subscription.
• handler (String) The handler function to check subscription.

returns: true if event exists on listener. false if event doesn't exist on listener.

getID

description: returns a unique ID of the instance. Usefull for associative arrays.

usage: myInstance.getID();

returns: Number

toString

description: returns the name of the class.

usage: myInstance.toString();

returns: String