Class sandy.core.transform.VertexInterpolator

Implemented Interfaces

Interpolator3D

Description

VertexInterpolator

Method Index

new VertexInterpolator()
getCurrentAnimation(), getCurrentAnimationId(), getEndMatrix(), getMatrix(), getStartMatrix(), getType(), gotoAnimation(), gotoNextAnimation(), toString()

Inherited from BasicInterpolator

Constructor Detail

VertexInterpolator

public function VertexInterpolator(o:Object3D, f:Function, animator:Array, loop:Boolean)

Create a new VertexInterpolator.

This class realise a interpolation of the vertices of the object it is apply to

Parameters

oObject3D The object3D that will be updated by the interpolator.
fFunction The function generating the interpolation value. You can use what you want even if Sandy recommends the Ease class The function must return a number between [0,1] and must have a parameter between [0,1] too.
animatorArray of AnimationData the array that contains all the animation data ie the vertex position per frame.
loopBoolean True if the interpolator can loop through its array of animations (default value) or not.

Method Detail

getCurrentAnimationId

public function getCurrentAnimationId(Void):Number

Get the ID of the current animation.

Parameters

Void

Return

Number the ID of the current animation

getCurrentAnimation

public function getCurrentAnimation(Void):AnimationData

Get the current animation object.

Parameters

Void

Return

AnimationData the currnet animation object.

gotoAnimation

public function gotoAnimation(id:Number):Boolean

Allows you to go directly on a specified animation.

Parameters

idNumber The animation ID you want to play.

Return

Boolean true if the operation succeed, false otherwise.

gotoNextAnimation

public function gotoNextAnimation(Void):Void

Go to the next animation.

Parameters

Void

getMatrix

public function getMatrix(Void):Matrix4

Description copied from BasicInterpolator

Returns the associated matrix.

Overrides

getMatrix() in sandy.core.transform.BasicInterpolator

getStartMatrix

public function getStartMatrix(Void):Matrix4

getEndMatrix

public function getEndMatrix(Void):Matrix4

getType

public function getType(Void):TransformType

Returns the type of the interpolation.

Parameters

Void

Return

TransformType the type of the interpolation

Overrides

getType() in sandy.core.transform.BasicInterpolator

toString

public function toString():String

Returns a string representation of this class.

Return

String The equivalent string.