Package | spark.effects.animation |
Class | public class SimpleMotionPath |
Inheritance | SimpleMotionPath MotionPath Object |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
This class is a simple subclass of MotionPath for defining
two keyframes to hold the valueFrom
, valueTo
, and
valueBy
properties.
The MotionPath class itself can define any number of keyframes.
Default MXML Propertykeyframes
Related API Elements
Property | Defined By | ||
---|---|---|---|
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
interpolator : IInterpolator
The interpolator determines how in-between values in an animation
are calculated. | MotionPath | ||
keyframes : Vector.<Keyframe>
A sequence of Keyframe objects that represent the time/value pairs
that the property takes during the animation. | MotionPath | ||
property : String
The name of the property on the effect target to be animated. | MotionPath | ||
valueBy : Object
Optional property which specifies the delta used to calculate
either the valueFrom or valueTo value. | SimpleMotionPath | ||
valueFrom : Object
The starting value for the property during the animation. | SimpleMotionPath | ||
valueTo : Object
The value that the named property will animate to. | SimpleMotionPath |
Method | Defined By | ||
---|---|---|---|
SimpleMotionPath(property:String = null, valueFrom:Object = null, valueTo:Object = null, valueBy:Object = null)
Constructor. | SimpleMotionPath | ||
Returns a copy of this MotionPath object, including copies
of each keyframe. | MotionPath | ||
Calculates and returns an interpolated value, given the elapsed
time fraction. | MotionPath | ||
Indicates whether an object has a specified property defined. | Object | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Returns the string representation of the specified object. | Object | ||
Returns the primitive value of the specified object. | Object |
valueBy | property |
valueBy:Object
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Optional property which specifies the delta used to calculate
either the valueFrom
or valueTo
value.
Providing this optional property lets the effect
calculate the necessary from/to values if either
are not provided or are to be determined dynamically when the animation
begins.
The way that the valueBy
value is used depends on which of the
other values are set. If neither are set, then the valueFrom
value is determined from the current property value in the target,
and the valueTo
value is valueFrom + valueBy
.
If one or the other is set, but not both, then
the unset value is calculated by the other value:
valueTo = valueFrom + valueBy
or
valueFrom = valueTo - valueBy
). If both are set, then the
valueBy
property is ignored.
Note that since valueBy
is of type
Object, the effect cannot directly calculate the other values
from it. It uses the effect's interpolator
to calculate the values by calling the interpolator's increment()
and decrement()
methods.
If no interpolator is set, then it will use NumberInterpolator by default.
Implementation
public function get valueBy():Object
public function set valueBy(value:Object):void
valueFrom | property |
valueFrom:Object
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
The starting value for the property during the animation.
A value of Null or NaN (in the case of Numbers) specifies that a
value must be determined dynamically at runtime, either by
getting the value from the target property directly or calculating
it if the other value is valid and there is also a valid
valueBy
value supplied.
Implementation
public function get valueFrom():Object
public function set valueFrom(value:Object):void
valueTo | property |
valueTo:Object
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
The value that the named property will animate to.
A value of Null or NaN (in the case of Numbers) element specifies that a
value must be determined dynamically at runtime, either by
getting the value from the target property directly or calculating
it if the other value is valid and there is also a valid valueBy
value supplied.
Implementation
public function get valueTo():Object
public function set valueTo(value:Object):void
SimpleMotionPath | () | Constructor |
public function SimpleMotionPath(property:String = null, valueFrom:Object = null, valueTo:Object = null, valueBy:Object = null)
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Constructor. You can specify both the
valueFrom
and valueTo
parameters,
or specify the valueBy
parameter and either the valueFrom
or valueTo
parameter.
If you omit these parameters, Flex calculates them from the effect target.
property:String (default = null ) — The name of the property being animated.
| |
valueFrom:Object (default = null ) — The initial value of the property.
| |
valueTo:Object (default = null ) — The final value of the property.
| |
valueBy:Object (default = null ) — An optional parameter that specifies the delta with
which to calculate either the from or to values, if one is omitted.
|
Wed Nov 21 2018, 06:34 AM -08:00