| Package | fl.motion |
| Class | public class Keyframe |
| Inheritance | Keyframe  KeyframeBase Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS3 |
| Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
position, scale, rotation, skew, and color.
A keyframe can, optionally, define one or more of these properties.
For instance, one keyframe may affect only position,
while another keyframe at a different point in time may affect only scale.
Yet another keyframe may affect all properties at the same time.
Within a motion tween, each time index can have only one keyframe.
A keyframe also has other properties like blend mode, filters, and cacheAsBitmap,
which are always available. For example, a keyframe always has a blend mode.
Note: In Flash CS3, many of the properties and methods supported by this class were members of this class, exclusively. Flash CS4 introduced a base class, KeyframeBase, for those properties and methods of this class, and they are now shared by other classes through the inheritance chain. If you have been working in Flash CS3, notice that these properties and methods are still supported by the Keyframe class, but are members of the KeyframeBase class in releases of Flash Professional after Flash CS3. As with any other class in this reference, select Show Inherited Public Properties and Show Inherited Public Methods to see all of the properties and methods supported by this class.
Related API Elements
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | adjustColorObjects : Dictionary = null
Stores AdjustColor instances mapped to their corresponding index in the filters Array for this keyframe. | KeyframeBase | |
| blank : Boolean = false
Indicates that the target object should not be displayed on this keyframe. | KeyframeBase | |
| blendMode : String = "normal"
A value from the BlendMode class that specifies how Flash Player
mixes the display object's colors with graphics underneath it. | KeyframeBase | |
| cacheAsBitmap : Boolean = false
If set to true, Flash Player caches an internal bitmap representation of the display object. | KeyframeBase | |
| color : Color
A color object that adjusts the color transform in the target object. | KeyframeBase | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| filters : Array
An array that contains each filter object to be applied to the target object at a particular keyframe. | KeyframeBase | |
| firstFrame : String
Stores the name of the first frame for motion tweens, which affects graphic symbols only. | KeyframeBase | |
| index : int
The keyframe's unique time value in the motion tween. | KeyframeBase | |
| label : String
A string used to describe the keyframe. | KeyframeBase | |
| loop : String
Stores the value of the Loop checkbox for motion tweens, which affects graphic symbols only. | KeyframeBase | |
| matrix : Matrix = null
Stores matrix property if one exists for this keyframe. | KeyframeBase | |
| matrix3D : Object = null
Stores matrix3d property if one exists for this keyframe. | KeyframeBase | |
| opaqueBackground : Object = null
Controls whether target object has an opaque background. | KeyframeBase | |
| orientToPath : Boolean = false
If set to true, this property causes the target object to rotate automatically
to follow the angle of its path. | KeyframeBase | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| rotateDirection : String = "auto"
Controls how the target object rotates during a motion tween,
with a value from the RotateDirection class. | KeyframeBase | |
| rotateTimes : uint = 0
Adds rotation to the target object during a motion tween, in addition to any existing rotation. | KeyframeBase | |
| rotation : Number
Indicates the rotation of the target object in degrees
from its original orientation as applied from the transformation point. | KeyframeBase | |
| rotationConcat : Number = NaN
The rotation (z-axis) values of the target object in the motion relative to previous orientation as applied from the transformation point,
as opposed to absolute rotation values, and separate from skewY values. | KeyframeBase | |
| rotationX : Number = NaN
Stores rotationX property for this keyframe. | KeyframeBase | |
| rotationY : Number = NaN
Stores rotationY property for this keyframe. | KeyframeBase | |
| scaleX : Number = NaN
Indicates the horizontal scale as a percentage of the object as applied from the transformation point. | KeyframeBase | |
| scaleY : Number = NaN
Indicates the vertical scale as a percentage of the object as applied from the transformation point. | KeyframeBase | |
| skewX : Number = NaN
Indicates the horizontal skew angle of the target object in degrees as applied from the transformation point. | KeyframeBase | |
| skewY : Number = NaN
Indicates the vertical skew angle of the target object in degrees as applied from the transformation point. | KeyframeBase | |
| tweens : Array
An array that contains each tween object to be applied to the target object at a particular keyframe. | Keyframe | ||
| tweenScale : Boolean = true
A flag that controls whether scale will be interpolated during a tween. | Keyframe | ||
| tweensLength : int [override] [read-only]
The number of frames for the tween. | Keyframe | ||
| tweenSnap : Boolean = false
Stores the value of the Snap checkbox for motion tweens, which snaps the object to a motion guide. | Keyframe | ||
| tweenSync : Boolean = false
Stores the value of the Sync checkbox for motion tweens, which affects graphic symbols only. | Keyframe | ||
| useRotationConcat : Boolean = false
If set to true, this property causes the target object to rotate when data for motion is supplied by addpropertyarray. | KeyframeBase | |
| visible : Boolean = true
Controls whether target object is visible. | KeyframeBase | |
| x : Number = NaN
The horizontal position of the target object's transformation point in its parent's coordinate space. | KeyframeBase | |
| y : Number = NaN
The vertical position of the target object's transformation point in its parent's coordinate space. | KeyframeBase | |
| z : Number = NaN
The depth (z-axis) position of the target object's transformation point in its parent's coordinate space. | KeyframeBase | |
| Method | Defined By | ||
|---|---|---|---|
Constructor for keyframe instances. | Keyframe | ||
|
Indicates whether the keyframe has an influence on a specific animation property. | KeyframeBase | |
Retrieves an ITween object for a specific animation property. | Keyframe | ||
|
Retrieves the value of a specific tweenable property on the keyframe. | KeyframeBase | |
|
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 one of the four AdjustColor properties to the AdjustColor object for the given filter index. | KeyframeBase | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Changes the value of a specific tweenable property on the keyframe. | KeyframeBase | |
|
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 | |
tweens | property |
public var tweens:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS3 |
| Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
An array that contains each tween object to be applied to the target object at a particular keyframe. One tween can target all animation properties (as with standard tweens on the Flash authoring tool's timeline), or multiple tweens can target individual properties (as with separate custom easing curves).
tweenScale | property |
public var tweenScale:Boolean = true| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS3 |
| Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
A flag that controls whether scale will be interpolated during a tween.
If false, the display object will stay the same size during the tween, until the next keyframe.
tweensLength | property |
tweenSnap | property |
public var tweenSnap:Boolean = false| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS3 |
| Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Stores the value of the Snap checkbox for motion tweens, which snaps the object to a motion guide. This property is used in the Copy and Paste Motion feature in Flash CS4 but does not affect motion tweens defined using ActionScript. It is included here for compatibility with the Flex 2 compiler.
tweenSync | property |
public var tweenSync:Boolean = false| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS3 |
| Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Stores the value of the Sync checkbox for motion tweens, which affects graphic symbols only. This property is used in the Copy and Paste Motion feature in Flash CS4 but does not affect motion tweens defined using ActionScript. It is included here for compatibility with the Flex 2 compiler.
Keyframe | () | Constructor |
getTween | () | method |
public function getTween(target:String = ""):fl.motion:ITween| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS3 |
| Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Retrieves an ITween object for a specific animation property.
Parameters
target:String (default = " |
fl.motion:ITween — An object that implements the ITween interface.
|
Related API Elements
Mon Nov 28 2011, 06:48 AM -08:00