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

Definition of state snapshot animator rule. More...

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

Public Member Functions

AnimatorRule buildRule (Animator animator)
 Build engine animator rule using the stored definition. More...
 
void debug (Console console)
 
bool getEnableOrientation ()
 Orientation manipulation is enabled. More...
 
bool getEnablePosition ()
 Pposition manipulation is enabled. More...
 
bool getEnableSize ()
 Size manipulation is enabled. More...
 
bool getEnableVertexPositionSet ()
 Vertex position set manipulation is enabled. More...
 
int getID ()
 Identifier to snapshot state using animator instance. More...
 
bool getUseLastState ()
 Last state is used. More...
 
ADRuleStateSnapshot new ()
 Create animation rule definition. More...
 
ADRuleStateSnapshot new (AnimatorDefinition fromDef, AnimatorDefinition toDef, ADRuleStateSnapshot rule)
 Create copy of animation rule definition. More...
 
void setEnableOrientation (bool enable)
 Set if orientation manipulation is enabled. More...
 
void setEnablePosition (bool enable)
 Set if position manipulation is enabled. More...
 
void setEnableSize (bool enable)
 Set if size manipulation is enabled. More...
 
void setEnableVertexPositionSet (bool enable)
 Set if vertex position set manipulation is enabled. More...
 
void setID (int identifier)
 Set identifier to snapshot state using animator instance. More...
 
void setUseLastState (bool useLastState)
 Set if last state is used. 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 state snapshot animator rule.

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

Member Function Documentation

◆ buildRule()

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

Build engine animator rule using the stored definition.

Reimplemented from Dragengine.Animators.ADRule.

◆ debug()

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

◆ getEnableOrientation()

bool Dragengine.Animators.ADRuleStateSnapshot.getEnableOrientation ( )

Orientation manipulation is enabled.

◆ getEnablePosition()

bool Dragengine.Animators.ADRuleStateSnapshot.getEnablePosition ( )

Pposition manipulation is enabled.

◆ getEnableSize()

bool Dragengine.Animators.ADRuleStateSnapshot.getEnableSize ( )

Size manipulation is enabled.

◆ getEnableVertexPositionSet()

bool Dragengine.Animators.ADRuleStateSnapshot.getEnableVertexPositionSet ( )

Vertex position set manipulation is enabled.

Version
1.17

◆ getID()

int Dragengine.Animators.ADRuleStateSnapshot.getID ( )

Identifier to snapshot state using animator instance.

◆ getUseLastState()

bool Dragengine.Animators.ADRuleStateSnapshot.getUseLastState ( )

Last state is used.

◆ new() [1/2]

ADRuleStateSnapshot Dragengine.Animators.ADRuleStateSnapshot.new ( )

Create animation rule definition.

Reimplemented from Dragengine.Animators.ADRule.

◆ new() [2/2]

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

Create copy of animation rule definition.

Version
1.13

◆ setEnableOrientation()

void Dragengine.Animators.ADRuleStateSnapshot.setEnableOrientation ( bool  enable)

Set if orientation manipulation is enabled.

◆ setEnablePosition()

void Dragengine.Animators.ADRuleStateSnapshot.setEnablePosition ( bool  enable)

Set if position manipulation is enabled.

◆ setEnableSize()

void Dragengine.Animators.ADRuleStateSnapshot.setEnableSize ( bool  enable)

Set if size manipulation is enabled.

◆ setEnableVertexPositionSet()

void Dragengine.Animators.ADRuleStateSnapshot.setEnableVertexPositionSet ( bool  enable)

Set if vertex position set manipulation is enabled.

Version
1.17

◆ setID()

void Dragengine.Animators.ADRuleStateSnapshot.setID ( int  identifier)

Set identifier to snapshot state using animator instance.

◆ setUseLastState()

void Dragengine.Animators.ADRuleStateSnapshot.setUseLastState ( bool  useLastState)

Set if last state is used.


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