away3d.animators.BonesAnimator

Public Properties

	Property		Defined by
		currentFrame : int Returns the current keyframe number	Animator
		cycleNumber : int Returns the number of the current loop cycle	Animator
		delay : Number Defines the delay to the start of the animation in seconds	Animator
		fps : Number Defines the keyframes per second of the animation	Animator
		interpolate : Boolean Defines whether the animation interpolates between channel points.	Animator
		isPlaying : Boolean Returns true when the animation is playing	Animator
		length : Number Defines the total length of the animation in seconds	Animator
		loop : Boolean Defines whether the animation will loop.	Animator
		name : String The name of the animation used as a unique reference.	Animator
		progress : Number Represents the progress of the animation playhead from the start (0) to the end (1) of the animation.	Animator
		target : Object3D Defines the 3d object to which the animation is applied.	Animator
		totalFrames : Number Returns the total length of the animation in frames	Animator

	Property	Defined by
		_currentFrame : uint	Animator
		_fraction : Number	Animator
		ini : Init Instance of the Init object used to hold and parse default property values specified by the initialiser object in the 3d object constructor.	Animator
		_invFraction : Number	Animator
		_progress : Number = 0	Animator
		_target : Object3D	Animator
		_time : Number	Animator

Public Methods

	Method		Defined by
		BonesAnimator (target:Object3D = null, init:Object = null) Creates a new `BonesAnimator`	BonesAnimator
		addChannel(channel:Channel):void Adds an animation channel to the animation timeline.	BonesAnimator
		addOnCycle(listener:Function):void Default method for adding a cycle event listener.	Animator
		addOnEnterKeyFrame(listener:Function):void Default method for adding an enterKeyFrame event listener	Animator
		clone(animator:Animator = null):Animator Duplicates the animators properties to another `Animator` object	BonesAnimator
		gotoAndPlay(frame:uint):void	Animator
		gotoAndStop(frame:uint):void	Animator
		play():void	Animator
		removeOnCycle(listener:Function):void Default method for removing a cycle event listener	Animator
		removeOnEnterKeyFrame(listener:Function):void Default method for removing a enterKeyFrame event listener	Animator
		stop():void	Animator
		update(time:Number):void Updates the position of the playhead to the given time in seconds.	Animator

	Method	Defined by
		getDefaultFps():Number	Animator
		updateProgress(val:Number):void	BonesAnimator
		updateTarget():void	BonesAnimator

Summary	Defined by
cycle	Dispatched when a looping animation starts a new cycle.	Animator
enterKeyFrame	Dispatched when entering a new keyframe.	Animator
start	Dispatched when the animation starts.	Animator
stop	Dispatched when the animation stops.	Animator

Constructor detail

BonesAnimator

()

constructor

public function BonesAnimator(target:Object3D = null, init:Object = null)Parameters

	`target:Object3D` (default = `null`) — [optional] Defines the 3d object to which the animation is applied.

	`init:Object` (default = `null`) — [optional] An initialisation object for specifying default instance properties.

Init Parameters

Method detail

addChannel

()

method

public function addChannel(channel:Channel):void

Adds an animation channel to the animation timeline.

Parameters

channel:Channel

clone

()

method

public override function clone(animator:Animator = null):Animator

Duplicates the animators properties to another Animator object

Parameters

animator:Animator (default = null) — [optional] The new animator instance into which all properties are copied

Returns

Animator — The new animator instance with duplicated properties applied

updateProgress

()

method

protected override function updateProgress(val:Number):void Parameters

val:Number

updateTarget

()

method

protected override function updateTarget():void

Wiki link

Click to go to the wiki page for 'away3d.animators.BonesAnimator'

Code examples

Comments

Away3D FP10 Trunk (as on 06-Dec-2010)	All Packages \| All Classes \| Index \| Frames No Frames
Class BonesAnimator		Properties \| Methods \| Events

Package	away3d.animators
Class	public class BonesAnimator
Inheritance	BonesAnimator Animator flash.events.EventDispatcher