BETA ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Hide Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes

Language Reference only
Filters: Retrieving Data from Server...
Retrieving Data from Server...
fl.motion 

SimpleEase  - AS3 Flash

(Beta)
Packagefl.motion
Classpublic class SimpleEase
InheritanceSimpleEase Inheritance Object
Implements ITween

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

The SimpleEase class allows you to control an animation with the kind of percentage easing that is used in the Flash timeline.

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  ease : Number
A percentage between -1 (100% ease in or acceleration) and 1 (100% ease out or deceleration).
SimpleEase
  target : String
The name of the animation property to target.
SimpleEase
Public Methods
 MethodDefined By
  
SimpleEase(xml:XML = null)
Constructor for SimpleEase instances.
SimpleEase
  
easeNone(time:Number, begin:Number, change:Number, duration:Number):Number
[static] Calculates an interpolated value for a numerical property of animation, using a linear tween of constant velocity.
SimpleEase
  
easeQuadPercent(time:Number, begin:Number, change:Number, duration:Number, percent:Number):Number
[static] Calculates an interpolated value for a numerical property of animation, using a percentage of quadratic easing.
SimpleEase
  
getValue(time:Number, begin:Number, change:Number, duration:Number):Number
Calculates an interpolated value for a numerical property of animation, using a percentage of quadratic easing.
SimpleEase
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

ease

property
ease:Number

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

A percentage between -1 (100% ease in or acceleration) and 1 (100% ease out or deceleration). Defaults to 0, which means that the tween animates at a constant speed, without acceleration or deceleration.

The default value is 0.



Implementation
    public function get ease():Number
    public function set ease(value:Number):void

target

property 
target:String

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

The name of the animation property to target.

The default value is "".



Implementation
    public function get target():String
    public function set target(value:String):void

Related API Elements

Constructor Detail

SimpleEase

()Constructor
public function SimpleEase(xml:XML = null)

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Constructor for SimpleEase instances.

Parameters
xml:XML (default = null) — Optional E4X XML object defining a SimpleEase object in Motion XML format.
Method Detail

easeNone

()method
public static function easeNone(time:Number, begin:Number, change:Number, duration:Number):Number

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Calculates an interpolated value for a numerical property of animation, using a linear tween of constant velocity. The function signature matches that of the easing functions in the fl.motion.easing package.

Parameters

time:Number — This value is between 0 and duration, inclusive. You can choose any unit(for example, frames, seconds, milliseconds), but your choice must match the duration unit.
 
begin:Number — The value of the animation property at the start of the tween, when time is 0.
 
change:Number — The change in the value of the animation property over the course of the tween. This value can be positive or negative. For example, if an object rotates from 90 to 60 degrees, the change is -30.
 
duration:Number — The length of time for the tween. This value must be greater than zero. You can choose any unit (for example, frames, seconds, milliseconds), but your choice must match the time unit.

Returns
Number — The interpolated value at the specified time.

Related API Elements

easeQuadPercent

()method 
public static function easeQuadPercent(time:Number, begin:Number, change:Number, duration:Number, percent:Number):Number

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Calculates an interpolated value for a numerical property of animation, using a percentage of quadratic easing. The function signature matches that of the easing functions in the fl.motion.easing package.

Parameters

time:Number — This value is between 0 and duration, inclusive. You can choose any unit (for example, frames, seconds, milliseconds), but your choice must match the duration unit.
 
begin:Number — The value of the animation property at the start of the tween, when time is 0.
 
change:Number — The change in the value of the animation property over the course of the tween. This value can be positive or negative. For example, if an object rotates from 90 to 60 degrees, the change is -30.
 
duration:Number — The length of time for the tween. This value must be greater than zero. You can choose any unit (for example, frames, seconds, milliseconds), but your choice must match the time unit.
 
percent:Number — A percentage between -1 (100% ease in or acceleration) and 1 (100% ease out or deceleration).

Returns
Number — The interpolated value at the specified time.

Related API Elements

getValue

()method 
public function getValue(time:Number, begin:Number, change:Number, duration:Number):Number

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Calculates an interpolated value for a numerical property of animation, using a percentage of quadratic easing. The percent value is read from the SimpleEase instance's ease property rather than being passed into the method. Using this property allows the function signature to match the ITween interface.

Parameters

time:Number — This value is between 0 and duration, inclusive. You can choose any unit (for example, frames, seconds, milliseconds), but your choice must match the duration unit.
 
begin:Number — The value of the animation property at the start of the tween, when time is 0.
 
change:Number — The change in the value of the animation property over the course of the tween. This value can be positive or negative. For example, if an object rotates from 90 to 60 degrees, the change is -30.
 
duration:Number — The length of time for the tween. This value must be greater than zero. You can choose any unit (for example, frames, seconds, milliseconds), but your choice must match the time unit.

Returns
Number — The interpolated value at the specified time.

Related API Elements