Drag[en]gine Script Module DragonScript  1.23
Dragengine.Animators.ADRuleTrackTo Class Reference

Definition of track to animator rule. More...

Inheritance diagram for Dragengine.Animators.ADRuleTrackTo:
Dragengine.Animators.ADRule

Public Member Functions

AnimatorRule buildRule (Animator animator)
 Build engine animator rule using the stored definition. More...
 
void debug (Console console)
 
ARTrackToLocked getLockedAxis ()
 Locked axis. More...
 
ARTrackToAxis getTrackAxis ()
 Ttrack axis. More...
 
String getTrackBone ()
 Name of track bone or empty string to use none. More...
 
ARTrackToAxis getUpAxis ()
 Up axis. More...
 
ARTrackToUp getUpTarget ()
 Up target. More...
 
ADRuleTrackTo new ()
 Create animation rule definition. More...
 
ADRuleTrackTo new (AnimatorDefinition fromDef, AnimatorDefinition toDef, ADRuleTrackTo rule)
 Create copy of animation rule definition. More...
 
void setLockedAxis (ARTrackToLocked axis)
 Set locked axis. More...
 
void setTrackAxis (ARTrackToAxis axis)
 Set track axis. More...
 
void setTrackBone (String boneName)
 Set name of track bone or empty string to use none. More...
 
void setUpAxis (ARTrackToAxis axis)
 Set up axis. More...
 
void setUpTarget (ARTrackToUp target)
 Set up target. More...
 
- Public Member Functions inherited from Dragengine.Animators.ADRule
void addBone (String bone)
 Add bone. More...
 
void addTargetLink (ADRuleTargetLink targetLink)
 Add target link. More...
 
void addVertexPositionSet (String vertexPositionSet)
 Add vertex position set. More...
 
void forEachTarget (Block ablock)
 Visit target links with a block. More...
 
float getBlendFactor ()
 Blend factor. More...
 
AnimatorRuleBlendMode getBlendMode ()
 Blend mode. More...
 
String getBoneAt (int index)
 Bone at index. More...
 
int getBoneCount ()
 Count of bones. More...
 
bool getEnabled ()
 Rule is enabled. More...
 
bool getInvertBlendFactor ()
 Invert blend factor (1 - blendFactor). More...
 
ADRuleTargetLink getTargetLinkAt (int index)
 Target link at index. More...
 
int getTargetLinkCount ()
 Count of target links. More...
 
String getVertexPositionSetAt (int index)
 Vertex position set at index. More...
 
int getVertexPositionSetCount ()
 Count of vertex position sets. More...
 
void removeAllTargetLinks ()
 Remove all target links. More...
 
void setBlendFactor (float factor)
 Set blend factor. More...
 
void setBlendMode (AnimatorRuleBlendMode mode)
 Set blend mode. More...
 
void setEnabled (bool enabled)
 Set if rule is enabled. More...
 
void setInvertBlendFactor (bool invertBlendFactor)
 Set invert blend factor (1 - blendFactor). More...
 
void setName (String name)
 Set name of rule. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Dragengine.Animators.ADRule
String debugCommon (String type)
 
ADRule new (AnimatorDefinition fromDef, AnimatorDefinition toDef, ADRule rule)
 Create copy of animation rule definition. More...
 

Detailed Description

Definition of track to animator rule.

Once defined a rule can be added to an animator using the stored definition.

Member Function Documentation

◆ buildRule()

AnimatorRule Dragengine.Animators.ADRuleTrackTo.buildRule ( Animator  animator)

Build engine animator rule using the stored definition.

Reimplemented from Dragengine.Animators.ADRule.

◆ debug()

void Dragengine.Animators.ADRuleTrackTo.debug ( Console  console)

◆ getLockedAxis()

ARTrackToLocked Dragengine.Animators.ADRuleTrackTo.getLockedAxis ( )

Locked axis.

◆ getTrackAxis()

ARTrackToAxis Dragengine.Animators.ADRuleTrackTo.getTrackAxis ( )

Ttrack axis.

◆ getTrackBone()

String Dragengine.Animators.ADRuleTrackTo.getTrackBone ( )

Name of track bone or empty string to use none.

◆ getUpAxis()

ARTrackToAxis Dragengine.Animators.ADRuleTrackTo.getUpAxis ( )

Up axis.

◆ getUpTarget()

ARTrackToUp Dragengine.Animators.ADRuleTrackTo.getUpTarget ( )

Up target.

◆ new() [1/2]

ADRuleTrackTo Dragengine.Animators.ADRuleTrackTo.new ( )

Create animation rule definition.

Reimplemented from Dragengine.Animators.ADRule.

◆ new() [2/2]

ADRuleTrackTo Dragengine.Animators.ADRuleTrackTo.new ( AnimatorDefinition  fromDef,
AnimatorDefinition  toDef,
ADRuleTrackTo  rule 
)

Create copy of animation rule definition.

Version
1.13

◆ setLockedAxis()

void Dragengine.Animators.ADRuleTrackTo.setLockedAxis ( ARTrackToLocked  axis)

Set locked axis.

◆ setTrackAxis()

void Dragengine.Animators.ADRuleTrackTo.setTrackAxis ( ARTrackToAxis  axis)

Set track axis.

◆ setTrackBone()

void Dragengine.Animators.ADRuleTrackTo.setTrackBone ( String  boneName)

Set name of track bone or empty string to use none.

◆ setUpAxis()

void Dragengine.Animators.ADRuleTrackTo.setUpAxis ( ARTrackToAxis  axis)

Set up axis.

◆ setUpTarget()

void Dragengine.Animators.ADRuleTrackTo.setUpTarget ( ARTrackToUp  target)

Set up target.


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