SingleAnimator Documentation
Author: Ralf Bokelberg, Alex Uhlmann
Last Modified: 09/24/05 19:03:18
Summary
SingleAnimator class:
SingleAnimator Properties:
SingleAnimator Methods:
version: Documentation not provided.
description:
SingleAnimator allows to animate a single property or method in a more intuitive way than via Animator. You can animate a property or method on a specified object. Specify the object via the construtor or the property animationTarget. The identifier parameter accepts either a function as a String or a property as a String.
Example 1: fade out a sound. You could have used the Volume class, too.
var mySound:Sound = new Sound(this);
mySound.attachSound("mySoundID");
mySound.start();
var mySingleAnimator:SingleAnimator = new SingleAnimator(mySound,"setVolume",[100,0],3000);
mySingleAnimator.run();
There are many ways to use this class. One way is to specify the duration, easing equation and callback properties outside the current method, either with setting the properies directly or with the animationStyle() method like it is used in de.alex_uhlmann.animationpackage.drawing.
Example 2:
var mySingleAnimator:SingleAnimator = new SingleAnimator(animationTarget);
mySingleAnimator.animationStyle(2000,Circ.easeIn,"onCallback");
mySingleAnimator.run("myProperty",50);
new SingleAnimator(animationTarget).run("myProperty",50,2000,Circ.easeInOut,"onCallback");
Example 5: By default, the start value of your animation is 0. You can explicitly define the start values either via the setStartValue or run method or via the constructor. Here is one example for the constructor solution. This also might come in handy using composite classes, like Sequence.var mySingleAnimator:SingleAnimator = new SingleAnimator(animationTarget,"myProperty",50,2000,Circ.easeInOut); mySingleAnimator.animate(50,100);
var mySingleAnimator:SingleAnimator = new SingleAnimator(animationTarget,"myProperty",[0,50],2000,Circ.easeIn); mySingleAnimator.run();
usage:
var mySingleAnimator:SingleAnimator = new SingleAnimator(animationTarget);
var mySingleAnimator:SingleAnimator = new SingleAnimator(animationTarget, identifier, amount, duration, callback);
var mySingleAnimator:SingleAnimator = new SingleAnimator(animationTarget, identifier, amount, duration, easing, callback);
var mySingleAnimator:SingleAnimator = new SingleAnimator(animationTarget, identifier, values);
var mySingleAnimator:SingleAnimator = new SingleAnimator(animationTarget, identifier, values, duration, callback);
var mySingleAnimator:SingleAnimator = new SingleAnimator(animationTarget, identifier, values, duration, easing, callback);
parameters:
(Object) Object to animate.
(Number) Duration of animation in milliseconds or frames. Default is milliseconds.
(Object) Easing equation in Robert Penner style. Default equation is Linear.easeNone. www.robertpenner.com/easing/
(String) Function to invoke after animation. See AnimationCore class.
description:
usage:
myInstance.run();
myInstance.run(identifier, amount);
myInstance.run(identifier, amount, duration);
myInstance.run(identifier, amount, duration, callback);
myInstance.run(identifier, amount, duration, easing, callback);
myInstance.run(identifier, values, duration);
myInstance.run(identifier, values, duration, callback);
myInstance.run(identifier, values, duration, easing, callback);
parameters:
returns: void
description: similar to the run() method. Offers start and end parameters.
usage:
myInstance.animate(start, end);
parameters:
returns: void
description: jumps to a specific step of the animation and stays there.
usage:
myInstance.goto(percentage);
parameters:
returns: void
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.:
See also "Customizable easing equations" in readme for more information.var myRotation:Rotation = new Rotation(mc); myRotation.animationStyle(2000,[Back.easeOut,4]); myRotation.run(360);
usage:
myInstance.animationStyle(duration);
myInstance.animationStyle(duration, callback);
myInstance.animationStyle(duration, easing, callback);
parameters:
returns: Void.
description: rounds animation results to integers. (might be usefull for animating pixelfonts). Default is false.
usage:
myInstance.roundResult(rounded);
parameters:
true rounds the result. Animates with integers. Less accuracy. false animates with floating point numbers.returns: Void.
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:
true or false.returns: Void.
description: returns the optimization mode. See setOptimizationMode for more information.
usage: getOptimizationMode();
returns: Boolean
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:
returns: Void.
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.
description: sets the current tween mode used by the instance. Please check with AnimationCore.setTweenModes for more information.
usage: setTweenMode();
parameters:
returns: true if setting tween mode was successful,
false if not successful.
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.
description: sets the current duration mode used by the instance. Please check with AnimationCore.setTweenModes for more information.
usage: setDurationMode();
parameters:
returns: true if setting duration mode was successful,
false if not successful.
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.
description: pauses the animation if not locked. Call resume() to continue animation.
usage: myInstance.pause();
parameters:
returns: true if instance was successfully paused.
false if instance could not be paused, because it was locked.
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.
description: locks the animation to prevent pausing, resuming and stopping. Default is unlocked.
usage: myInstance.lock();
returns: Void.
description: unlocks the animation to allow pausing, resuming and stopping. Default is unlocked.
usage: myInstance.unlock();
returns: Void.
description: checks if the instance is currently animated.
usage: myInstance.isTweening();
returns: true if instance is tweening,
false if instance is not tweening.
description: returns the original, starting value of the current tween.
usage: myInstance.getStartValue();
returns: Number
description: sets the original, starting value of the current tween.
usage: myInstance.setStartValue(startValue);
parameters:
returns: Boolean, indicates if the assignment was performed.
description: returns the targeted value of the current tween.
usage: myInstance.getEndValue();
returns: Number
description: sets the targeted value of the current tween.
usage: myInstance.setEndValue(endValue);
parameters:
returns: Boolean, indicates if the assignment was performed.
description: returns the current value of the current tween. In degrees.
usage: myInstance.getCurrentValue();
returns: Number
description: returns the current state of the animation in percentage. Especially usefull in combination with goto().
usage: myInstance.getCurrentPercentage();
returns: Number
description: returns the elapsed time or frames since the current tween started tweening.
usage: myInstance.getDurationElapsed();
returns: Number
description: returns the remaining time or frames since the current tween started tweening.
usage: myInstance.getDurationRemaining();
returns: Number
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:
myInstance.addEventListener(event, listener);
myInstance.addEventListener(event, listener, handler);
parameters:
returns: Void.
description: Removes a listener from a subscribed event.
usage:
myInstance.removeEventListener(event, listener);
myInstance.removeEventListener(event, listener, handler);
parameters:
returns: Void.
description: GDispatcher specific feature. Removes all listeners for a specific event, or for all events.
usage:
myInstance.removeAllEventListeners();
myInstance.removeAllEventListeners(event);
parameters:
returns: Void.
description: GDispatcher specific feature. Checks if a listener is already subscribed to a certain event.
usage:
myInstance.eventListenerExists(event, listener);
myInstance.eventListenerExists(event, listener, handler);
parameters:
returns: true if event exists on listener.
false if event doesn't exist on listener.
description: returns a unique ID of the instance. Usefull for associative arrays.
usage: myInstance.getID();
returns: Number
description: returns the name of the class.
usage: myInstance.toString();
returns: String