Drag[en]gine Script Module DragonScript  1.23
Dragengine.Scenery.AnimatorController Class Reference

Animator or animator instance controller. More...

Inheritance diagram for Dragengine.Scenery.AnimatorController:

Public Member Functions

Management
Animator getAnimator ()
 Owner animator or null if not owned by animator. More...
 
AnimatorInstance getAnimatorInstance ()
 Onwer animator instance or null if not owned by animator instance. More...
 
int getControllerIndex ()
 Controller index. More...
 
Controllers
String getName ()
 Name. More...
 
void setName (String name)
 Set name. More...
 
float getLower ()
 Lower limit. More...
 
float getUpper ()
 Upper limit. More...
 
void setRange (float lower, float upper)
 Set value range. More...
 
float getValue ()
 Value. More...
 
void setValue (float value)
 Set value. More...
 
float getRelativeValue ()
 Value mapped from range (minimum..maximum) to range (0..1). More...
 
void setRelativeValue (float value)
 Set value from range (0..1) mapped to range (minimum..maximum). More...
 
Vector getVector ()
 Vector. More...
 
void setVector (Vector vector)
 Set vector. More...
 
Vector getRotation ()
 Vector as rotation in degrees. More...
 
void setRotation (Vector rotation)
 Set vector from rotation in degrees. More...
 
bool getFrozen ()
 Controller is frozen. More...
 
void setFrozen (bool frozen)
 Set if controller is frozen. More...
 
bool getClamp ()
 Controller value is clamped instead of wrapped around if outside range. More...
 
void setClamp (bool clamp)
 Set if controller value is clamped instead of wrapped around if outside range. More...
 
void increment (float amount)
 Increment controller value. More...
 
void setToLower ()
 Set controller value to lower value. More...
 
void setToCenter ()
 Set controller value to center value. More...
 
void setToUpper ()
 Set controller value to upper value. More...
 
void reverse ()
 Set controller value to maximum - currentValue. More...
 
void setValueFrom (AnimatorController controller)
 Set controller value and vector from another controller. More...
 
void setAllFrom (AnimatorController controller)
 Set entire controller configuration from another controller. More...
 
bool isAtLower ()
 Controller value is at lower value. More...
 
bool isAtUpper ()
 Controller value is at upper value. More...
 

Detailed Description

Animator or animator instance controller.

Wraps a animator or animator instance controller by controller index. Valid only as long as the wrapped animator or animator instance does not change controller layout.

If wrapping a animator instance controller any changes to a controller triggers an update in the game engine.

If wrapping a animator controller the user is responsible to call Animator.contentChanged() after changing one or more controllers. Animator controllers should not be changed if possible after being used in animator instances.

This is a native class.

Member Function Documentation

◆ getAnimator()

Animator Dragengine.Scenery.AnimatorController.getAnimator ( )

Owner animator or null if not owned by animator.

◆ getAnimatorInstance()

AnimatorInstance Dragengine.Scenery.AnimatorController.getAnimatorInstance ( )

Onwer animator instance or null if not owned by animator instance.

◆ getClamp()

bool Dragengine.Scenery.AnimatorController.getClamp ( )

Controller value is clamped instead of wrapped around if outside range.

◆ getControllerIndex()

int Dragengine.Scenery.AnimatorController.getControllerIndex ( )

Controller index.

◆ getFrozen()

bool Dragengine.Scenery.AnimatorController.getFrozen ( )

Controller is frozen.

◆ getLower()

float Dragengine.Scenery.AnimatorController.getLower ( )

Lower limit.

◆ getName()

String Dragengine.Scenery.AnimatorController.getName ( )

Name.

◆ getRelativeValue()

float Dragengine.Scenery.AnimatorController.getRelativeValue ( )

Value mapped from range (minimum..maximum) to range (0..1).

◆ getRotation()

Vector Dragengine.Scenery.AnimatorController.getRotation ( )

Vector as rotation in degrees.

◆ getUpper()

float Dragengine.Scenery.AnimatorController.getUpper ( )

Upper limit.

◆ getValue()

float Dragengine.Scenery.AnimatorController.getValue ( )

Value.

◆ getVector()

Vector Dragengine.Scenery.AnimatorController.getVector ( )

◆ increment()

void Dragengine.Scenery.AnimatorController.increment ( float  amount)

Increment controller value.

◆ isAtLower()

bool Dragengine.Scenery.AnimatorController.isAtLower ( )

Controller value is at lower value.

◆ isAtUpper()

bool Dragengine.Scenery.AnimatorController.isAtUpper ( )

Controller value is at upper value.

◆ reverse()

void Dragengine.Scenery.AnimatorController.reverse ( )

Set controller value to maximum - currentValue.

◆ setAllFrom()

void Dragengine.Scenery.AnimatorController.setAllFrom ( AnimatorController  controller)

Set entire controller configuration from another controller.

◆ setClamp()

void Dragengine.Scenery.AnimatorController.setClamp ( bool  clamp)

Set if controller value is clamped instead of wrapped around if outside range.

◆ setFrozen()

void Dragengine.Scenery.AnimatorController.setFrozen ( bool  frozen)

Set if controller is frozen.

◆ setName()

void Dragengine.Scenery.AnimatorController.setName ( String  name)

Set name.

◆ setRange()

void Dragengine.Scenery.AnimatorController.setRange ( float  lower,
float  upper 
)

Set value range.

◆ setRelativeValue()

void Dragengine.Scenery.AnimatorController.setRelativeValue ( float  value)

Set value from range (0..1) mapped to range (minimum..maximum).

◆ setRotation()

void Dragengine.Scenery.AnimatorController.setRotation ( Vector  rotation)

Set vector from rotation in degrees.

◆ setToCenter()

void Dragengine.Scenery.AnimatorController.setToCenter ( )

Set controller value to center value.

◆ setToLower()

void Dragengine.Scenery.AnimatorController.setToLower ( )

Set controller value to lower value.

◆ setToUpper()

void Dragengine.Scenery.AnimatorController.setToUpper ( )

Set controller value to upper value.

◆ setValue()

void Dragengine.Scenery.AnimatorController.setValue ( float  value)

Set value.

◆ setValueFrom()

void Dragengine.Scenery.AnimatorController.setValueFrom ( AnimatorController  controller)

Set controller value and vector from another controller.

◆ setVector()

void Dragengine.Scenery.AnimatorController.setVector ( Vector  vector)

Set vector.


The documentation for this class was generated from the following file: