Packageaway3d.animators
Classpublic class BonesAnimator
InheritanceBonesAnimator Inheritance Animator Inheritance flash.events.EventDispatcher



Public Properties
 PropertyDefined By
 InheritedcurrentFrame : int
[read-only] Returns the current keyframe number
Animator
 InheritedcycleNumber : int
[read-only] Returns the number of the current loop cycle
Animator
 Inheriteddelay : Number
Defines the delay to the start of the animation in seconds
Animator
 Inheritedfps : Number
Defines the keyframes per second of the animation
Animator
 Inheritedinterpolate : Boolean
Defines whether the animation interpolates between channel points.
Animator
 InheritedisPlaying : Boolean
[read-only] Returns true when the animation is playing
Animator
 Inheritedlength : Number
Defines the total length of the animation in seconds
Animator
 Inheritedloop : Boolean
Defines whether the animation will loop.
Animator
 Inheritedname : String
The name of the animation used as a unique reference.
Animator
 Inheritedprogress : Number
Represents the progress of the animation playhead from the start (0) to the end (1) of the animation.
Animator
 Inheritedtarget : Object3D
Defines the 3d object to which the animation is applied.
Animator
 InheritedtotalFrames : Number
[read-only] Returns the total length of the animation in frames
Animator
Protected Properties
 PropertyDefined By
 Inherited_currentFrame : uint
Animator
 Inherited_fraction : Number
Animator
 Inheritedini : 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
 Inherited_invFraction : Number
Animator
 Inherited_progress : Number = 0
Animator
 Inherited_target : Object3D
Animator
 Inherited_time : Number
Animator
Public Methods
 MethodDefined 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
 Inherited
addOnCycle(listener:Function):void
Default method for adding a cycle event listener.
Animator
 Inherited
addOnEnterKeyFrame(listener:Function):void
Default method for adding an enterKeyFrame event listener
Animator
  
clone(animator:Animator = null):Animator
[override] Duplicates the animators properties to another Animator object
BonesAnimator
 Inherited
gotoAndPlay(frame:uint):void
Animator
 Inherited
gotoAndStop(frame:uint):void
Animator
 Inherited
play():void
Animator
 Inherited
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
Animator
 Inherited
removeOnEnterKeyFrame(listener:Function):void
Default method for removing a enterKeyFrame event listener
Animator
 Inherited
stop():void
Animator
 Inherited
update(time:Number):void
Updates the position of the playhead to the given time in seconds.
Animator
Protected Methods
 MethodDefined By
 Inherited
getDefaultFps():Number
Animator
  
updateProgress(val:Number):void
[override]
BonesAnimator
  
[override]
BonesAnimator
Events
 Event Summary Defined By
 InheritedDispatched when a looping animation starts a new cycle.Animator
 InheritedDispatched when entering a new keyframe.Animator
 InheritedDispatched when the animation starts.Animator
 InheritedDispatched when the animation stops.Animator
Constructor Detail
BonesAnimator()Constructor
public function BonesAnimator(target:Object3D = null, init:Object = null)

Creates a new BonesAnimator

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####
Method Detail
addChannel()method
public function addChannel(channel:Channel):void

Adds an animation channel to the animation timeline.

Parameters

channel:Channel

clone()method 
override public 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 
override protected function updateProgress(val:Number):void

Parameters

val:Number

updateTarget()method 
override protected function updateTarget():void