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

Definition of group animator rule. More...

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

Public Member Functions

void addRule (ADRule rule)
 Add rule. More...
 
AnimatorRule buildRule (Animator animator)
 Build engine animator rule using the stored definition. More...
 
void forEachRule (Block ablock)
 Visit rules using block. More...
 
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...
 
ADRule getRuleAt (int index)
 Rule at index. More...
 
int getRuleCount ()
 Count of rules. More...
 
bool getUseCurrentState ()
 Use current animation state instead of empty state. More...
 
ADRuleGroup new ()
 Create animation rule definition. More...
 
ADRuleGroup new (AnimatorDefinition fromDef, AnimatorDefinition toDef, ADRuleGroup rule)
 Create copy animation rule definition. More...
 
void removeAllRules ()
 Remove all rules. More...
 
void removeRule (ADRule rule)
 Remove rule. More...
 
void setApplicationType (ARGroupApplication applicationType)
 Set application type. 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 setUseCurrentState (bool useCurrentState)
 Set if current animation state is used instead of empty state. 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 group animator rule.

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

Member Function Documentation

◆ addRule()

void Dragengine.Animators.ADRuleGroup.addRule ( ADRule  rule)

Add rule.

◆ buildRule()

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

Build engine animator rule using the stored definition.

Reimplemented from Dragengine.Animators.ADRule.

◆ forEachRule()

void Dragengine.Animators.ADRuleGroup.forEachRule ( Block  ablock)

Visit rules using block.

◆ getEnableOrientation()

bool Dragengine.Animators.ADRuleGroup.getEnableOrientation ( )

Orientation manipulation is enabled.

◆ getEnablePosition()

bool Dragengine.Animators.ADRuleGroup.getEnablePosition ( )

Pposition manipulation is enabled.

◆ getEnableSize()

bool Dragengine.Animators.ADRuleGroup.getEnableSize ( )

Size manipulation is enabled.

◆ getEnableVertexPositionSet()

bool Dragengine.Animators.ADRuleGroup.getEnableVertexPositionSet ( )

Vertex position set manipulation is enabled.

Version
1.17

◆ getRuleAt()

ADRule Dragengine.Animators.ADRuleGroup.getRuleAt ( int  index)

Rule at index.

◆ getRuleCount()

int Dragengine.Animators.ADRuleGroup.getRuleCount ( )

Count of rules.

◆ getUseCurrentState()

bool Dragengine.Animators.ADRuleGroup.getUseCurrentState ( )

Use current animation state instead of empty state.

◆ new() [1/2]

ADRuleGroup Dragengine.Animators.ADRuleGroup.new ( )

Create animation rule definition.

Reimplemented from Dragengine.Animators.ADRule.

◆ new() [2/2]

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

Create copy animation rule definition.

Version
1.13

◆ removeAllRules()

void Dragengine.Animators.ADRuleGroup.removeAllRules ( )

Remove all rules.

◆ removeRule()

void Dragengine.Animators.ADRuleGroup.removeRule ( ADRule  rule)

Remove rule.

◆ setApplicationType()

void Dragengine.Animators.ADRuleGroup.setApplicationType ( ARGroupApplication  applicationType)

Set application type.

◆ setEnableOrientation()

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

Set if orientation manipulation is enabled.

◆ setEnablePosition()

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

Set if position manipulation is enabled.

◆ setEnableSize()

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

Set if size manipulation is enabled.

◆ setEnableVertexPositionSet()

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

Set if vertex position set manipulation is enabled.

Version
1.17

◆ setUseCurrentState()

void Dragengine.Animators.ADRuleGroup.setUseCurrentState ( bool  useCurrentState)

Set if current animation state is used instead of empty state.


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