fl.motion.Motion (ActionScript 3.0)

	Property	Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		duration : int Controls the Motion instance's length of time, measured in frames.	MotionBase
		is3D : Boolean Specifies whether the motion contains 3D property changes.	MotionBase
		keyframes : Array An array of keyframes that define the motion's behavior over time.	MotionBase
		keyframesCompact : Array A compact array of keyframes, where each index is occupied by a keyframe.	Motion
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		source : Source An object that stores information about the context in which the motion was created, such as frame rate, dimensions, transformation point, and initial position, scale, rotation, and skew.	Motion

Public Methods

	Method		Defined By
		Motion(xml:XML = null) Constructor for Motion instances.	Motion
		addFilterPropertyArray(index:int, name:String, values:Array, startFrame:int = -1, endFrame:int = -1):void Modifies a filter property in all corresponding keyframes for a Motion object.	MotionBase
		addKeyframe(newKeyframe:KeyframeBase):void Adds a keyframe object to the Motion instance.	MotionBase
		addPropertyArray(name:String, values:Array, startFrame:int = -1, endFrame:int = -1):void Stores an array of values in corresponding keyframes for a declared property of the Motion class.	MotionBase
		fromXMLString(xmlString:String):Motion [static] A method needed to create a Motion instance from a string of XML.	Motion
		getColorTransform(index:int):flash.geom:ColorTransform [override] Retrieves an interpolated ColorTransform object at a specific time index in the Motion instance.	Motion
		getCurrentKeyframe(index:int, tweenableName:String = ""):KeyframeBase Retrieves the keyframe that is currently active at a specific frame in the Motion instance.	MotionBase
		getFilters(index:Number):Array [override] Retrieves an interpolated array of filters at a specific time index in the Motion instance.	Motion
		getMatrix3D(index:int):Object Returns the Matrix3D object for the specified index position of the frame of animation.	MotionBase
		getNextKeyframe(index:int, tweenableName:String = ""):KeyframeBase Retrieves the next keyframe after a specific frame in the Motion instance.	MotionBase
		getValue(index:Number, tweenableName:String):Number Retrieves the value for an animation property at a point in time.	MotionBase
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		initFilters(filterClasses:Array, gradientSubarrayLengths:Array, startFrame:int = -1, endFrame:int = -1):void Initializes the filters list for the target object and copies the list of filters to each Keyframe instance of the Motion object.	MotionBase
		interpolateFilter(fromFilter:BitmapFilter, toFilter:BitmapFilter, progress:Number):BitmapFilter [static] Blends filters smoothly from one filter object to another.	Motion
		interpolateFilters(fromFilters:Array, toFilters:Array, progress:Number):Array [static] Blends filters smoothly from one array of filter objects to another.	Motion
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		overrideTargetTransform(scale:Boolean = true, skew:Boolean = true, rotate:Boolean = true):void	MotionBase
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setValue(index:int, tweenableName:String, value:Number):void Sets the value of a specific tweenables property at a given time index in the Motion instance.	MotionBase
		toString():String Returns the string representation of the specified object.	Object
		useRotationConcat(index:int):Boolean Rotates the target object when data for the motion is supplied by the addPropertyArray() method.	MotionBase
		valueOf():Object Returns the primitive value of the specified object.	Object

Property Detail

keyframesCompact

property

keyframesCompact:Array

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

A compact array of keyframes, where each index is occupied by a keyframe. By contrast, a sparse array has empty indices (as in the keyframes property). In the compact array, no null values are used to fill indices between keyframes. However, the index of a keyframe in keyframesCompact likely does not match its index in the keyframes array.

This property is primarily used for compatibility with the Flex MXML compiler, which generates a compact array from the motion XML.

Implementation
public function get keyframesCompact():Array
public function set keyframesCompact(value:Array):void

See also

keyframes

source

property

public var source:Source

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

An object that stores information about the context in which the motion was created, such as frame rate, dimensions, transformation point, and initial position, scale, rotation, and skew.

Constructor Detail

Motion

()

Constructor

public function Motion(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 Motion instances. By default, one initial keyframe is created automatically, with default transform properties.

Parameters

xml:XML (default = null) — Optional E4X XML object defining a Motion instance.

Method Detail

fromXMLString

()

method

public static function fromXMLString(xmlString:String):Motion

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

A method needed to create a Motion instance from a string of XML.

Parameters

xmlString:String — A string of motion XML.

Returns

Motion — A new Motion instance.

getColorTransform

()

method

override public function getColorTransform(index:int):flash.geom:ColorTransform

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Retrieves an interpolated ColorTransform object at a specific time index in the Motion instance.

Parameters

index:int — The time index of a frame in the Motion instance, as an integer greater than or equal to zero.

Returns

flash.geom:ColorTransform — The interpolated ColorTransform object.

See also

flash.geom.ColorTransform

getFilters

()

method

override public function getFilters(index:Number):Array

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Retrieves an interpolated array of filters at a specific time index in the Motion instance.

Parameters

index:Number — The time index of a frame in the Motion instance, as an integer greater than or equal to zero.

Returns

Array — The interpolated array of filters. If there are no applicable filters, returns an empty array.

See also

flash.filters

interpolateFilter

()

method

public static function interpolateFilter(fromFilter:BitmapFilter, toFilter:BitmapFilter, progress:Number):BitmapFilter

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Blends filters smoothly from one filter object to another.

Parameters

	`fromFilter:BitmapFilter` — The starting filter object.

	`toFilter:BitmapFilter` — The ending filter object.

	`progress:Number` — The percent of the transition as a decimal, where `0` is the start and `1` is the end.

Returns

BitmapFilter — The interpolated filter object.

See also

flash.filters

interpolateFilters

()

method

public static function interpolateFilters(fromFilters:Array, toFilters:Array, progress:Number):Array

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Blends filters smoothly from one array of filter objects to another.

Parameters

	`fromFilters:Array` — The starting array of filter objects.

	`toFilters:Array` — The ending array of filter objects.

	`progress:Number` — The percent of the transition as a decimal, where `0` is the start and `1` is the end.

Returns

Array — The interpolated array of filter objects.

See also

flash.filters

Flash CS4 Professional ActionScript 3.0 Language Reference Language Reference only	Home \| All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Frames No Frames
Motion	Properties \| Methods

Package	fl.motion
Class	public class Motion
Inheritance	Motion MotionBase Object