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

Definition of a mirror animator rule. More...

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

Classes

class  MatchBoneName
 Match bone name. More...
 

Public Member Functions

void addMatchName (String first, String second, ARMirrorMatchNameType type)
 Add match bone name. More...
 
AnimatorRule buildRule (Animator animator)
 Build engine animator rule using the stored definition. More...
 
bool getEnableOrientation ()
 Orientation manipulation is enabled. More...
 
bool getEnablePosition ()
 Position manipulation is enabled. More...
 
bool getEnableSize ()
 Size manipulation is enabled. More...
 
bool getEnableVertexPositionSet ()
 Vertex position set manipulation is enabled. More...
 
MatchBoneName getMatchNameAt (int index)
 Match bone name at index. More...
 
int getMatchNameCount ()
 Count of match bone names. More...
 
ARMirrorMirrorAxis getMirrorAxis ()
 Mirror axis. More...
 
String getMirrorBone ()
 Name of mirror bone or empty string to use component. More...
 
ADRuleMirror new ()
 Create animation rule definition. More...
 
ADRuleMirror new (AnimatorDefinition fromDef, AnimatorDefinition toDef, ADRuleMirror rule)
 Create copy of animation rule definition. More...
 
void setEnableOrientation (bool enable)
 Set orientation manipulation is enabled. More...
 
void setEnablePosition (bool enable)
 Set if position manipulation is enabled. More...
 
void setEnableSize (bool enable)
 Setsif size manipulation is enabled. More...
 
void setEnableVertexPositionSet (bool enable)
 Set if vertex position set manipulation is enabled. More...
 
void setMirrorAxis (ARMirrorMirrorAxis axis)
 Set mirror axis. More...
 
void setMirrorBone (String bone)
 Set name of mirror bone or empty string to use component. 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 a mirror animator rule.

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

Member Function Documentation

◆ addMatchName()

void Dragengine.Animators.ADRuleMirror.addMatchName ( String  first,
String  second,
ARMirrorMatchNameType  type 
)

Add match bone name.

◆ buildRule()

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

Build engine animator rule using the stored definition.

Reimplemented from Dragengine.Animators.ADRule.

◆ getEnableOrientation()

bool Dragengine.Animators.ADRuleMirror.getEnableOrientation ( )

Orientation manipulation is enabled.

◆ getEnablePosition()

bool Dragengine.Animators.ADRuleMirror.getEnablePosition ( )

Position manipulation is enabled.

◆ getEnableSize()

bool Dragengine.Animators.ADRuleMirror.getEnableSize ( )

Size manipulation is enabled.

◆ getEnableVertexPositionSet()

bool Dragengine.Animators.ADRuleMirror.getEnableVertexPositionSet ( )

Vertex position set manipulation is enabled.

Version
1.17

◆ getMatchNameAt()

MatchBoneName Dragengine.Animators.ADRuleMirror.getMatchNameAt ( int  index)

Match bone name at index.

◆ getMatchNameCount()

int Dragengine.Animators.ADRuleMirror.getMatchNameCount ( )

Count of match bone names.

◆ getMirrorAxis()

ARMirrorMirrorAxis Dragengine.Animators.ADRuleMirror.getMirrorAxis ( )

Mirror axis.

◆ getMirrorBone()

String Dragengine.Animators.ADRuleMirror.getMirrorBone ( )

Name of mirror bone or empty string to use component.

◆ new() [1/2]

ADRuleMirror Dragengine.Animators.ADRuleMirror.new ( )

Create animation rule definition.

Reimplemented from Dragengine.Animators.ADRule.

◆ new() [2/2]

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

Create copy of animation rule definition.

Version
1.13

◆ setEnableOrientation()

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

Set orientation manipulation is enabled.

◆ setEnablePosition()

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

Set if position manipulation is enabled.

◆ setEnableSize()

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

Setsif size manipulation is enabled.

◆ setEnableVertexPositionSet()

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

Set if vertex position set manipulation is enabled.

Version
1.17

◆ setMirrorAxis()

void Dragengine.Animators.ADRuleMirror.setMirrorAxis ( ARMirrorMirrorAxis  axis)

Set mirror axis.

◆ setMirrorBone()

void Dragengine.Animators.ADRuleMirror.setMirrorBone ( String  bone)

Set name of mirror bone or empty string to use component.


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