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

Definition of foreign state animator rule. More...

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

Public Member Functions

AnimatorRule buildRule (Animator animator)
 Build engine animator rule using the stored definition. More...
 
void debug (Console console)
 
ARForeignStateCFrame getDestinationCoordinateFrame ()
 Destination coordinate frame. 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...
 
String getForeignBone ()
 Foreign bone name. More...
 
String getForeignVertexPositionSet ()
 Foreign vertex position set name. More...
 
bool getModifyX ()
 X component is modified. More...
 
bool getModifyY ()
 Y component is modified. More...
 
bool getModifyZ ()
 Z component is modified. More...
 
float getScaleOrientation ()
 Orientation scale factor. More...
 
float getScalePosition ()
 Pposition scale factor. More...
 
float getScaleSize ()
 Size scale factor. More...
 
float getScaleVertexPositionSet ()
 Vertex position set scale factor. More...
 
ARForeignStateCFrame getSourceCoordinateFrame ()
 Source coordinate frame. More...
 
ADRuleForeignState new ()
 Create animation rule definition. More...
 
ADRuleForeignState new (AnimatorDefinition fromDef, AnimatorDefinition toDef, ADRuleForeignState rule)
 Create copy of animation rule definition. More...
 
void setDestinationCoordinateFrame (ARForeignStateCFrame coordFrame)
 Set if destination coordinate frame. 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 setForeignBone (String bone)
 Set foreign bone name. More...
 
void setForeignVertexPositionSet (String vertexPositionSet)
 Set foreign vertex position set name. More...
 
void setModifyX (bool modify)
 Set if X component is modified. More...
 
void setModifyY (bool modify)
 Set if Y component is modified. More...
 
void setModifyZ (bool modify)
 Set if z component is modified. More...
 
void setScaleOrientation (float scaleFactor)
 Set orientation scale factor. More...
 
void setScalePosition (float scaleFactor)
 Set position scale factor. More...
 
void setScaleSize (float scaleFactor)
 Set size scale factor. More...
 
void setScaleVertexPositionSet (float scale)
 Set vertex position set scale factor. More...
 
void setSourceCoordinateFrame (ARForeignStateCFrame coordFrame)
 Set if source coordinate frame. 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 foreign state animator rule.

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

Member Function Documentation

◆ buildRule()

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

Build engine animator rule using the stored definition.

Reimplemented from Dragengine.Animators.ADRule.

◆ debug()

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

◆ getDestinationCoordinateFrame()

ARForeignStateCFrame Dragengine.Animators.ADRuleForeignState.getDestinationCoordinateFrame ( )

Destination coordinate frame.

◆ getEnableOrientation()

bool Dragengine.Animators.ADRuleForeignState.getEnableOrientation ( )

Orientation manipulation is enabled.

◆ getEnablePosition()

bool Dragengine.Animators.ADRuleForeignState.getEnablePosition ( )

Position manipulation is enabled.

◆ getEnableSize()

bool Dragengine.Animators.ADRuleForeignState.getEnableSize ( )

Size manipulation is enabled.

◆ getEnableVertexPositionSet()

bool Dragengine.Animators.ADRuleForeignState.getEnableVertexPositionSet ( )

Vertex position set manipulation is enabled.

Version
1.17

◆ getForeignBone()

String Dragengine.Animators.ADRuleForeignState.getForeignBone ( )

Foreign bone name.

◆ getForeignVertexPositionSet()

String Dragengine.Animators.ADRuleForeignState.getForeignVertexPositionSet ( )

Foreign vertex position set name.

Version
1.17

◆ getModifyX()

bool Dragengine.Animators.ADRuleForeignState.getModifyX ( )

X component is modified.

Version
1.6

◆ getModifyY()

bool Dragengine.Animators.ADRuleForeignState.getModifyY ( )

Y component is modified.

Version
1.6

◆ getModifyZ()

bool Dragengine.Animators.ADRuleForeignState.getModifyZ ( )

Z component is modified.

Version
1.6

◆ getScaleOrientation()

float Dragengine.Animators.ADRuleForeignState.getScaleOrientation ( )

Orientation scale factor.

◆ getScalePosition()

float Dragengine.Animators.ADRuleForeignState.getScalePosition ( )

Pposition scale factor.

◆ getScaleSize()

float Dragengine.Animators.ADRuleForeignState.getScaleSize ( )

Size scale factor.

◆ getScaleVertexPositionSet()

float Dragengine.Animators.ADRuleForeignState.getScaleVertexPositionSet ( )

Vertex position set scale factor.

Version
1.17

◆ getSourceCoordinateFrame()

ARForeignStateCFrame Dragengine.Animators.ADRuleForeignState.getSourceCoordinateFrame ( )

Source coordinate frame.

◆ new() [1/2]

ADRuleForeignState Dragengine.Animators.ADRuleForeignState.new ( )

Create animation rule definition.

Reimplemented from Dragengine.Animators.ADRule.

◆ new() [2/2]

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

Create copy of animation rule definition.

Version
1.13

◆ setDestinationCoordinateFrame()

void Dragengine.Animators.ADRuleForeignState.setDestinationCoordinateFrame ( ARForeignStateCFrame  coordFrame)

Set if destination coordinate frame.

◆ setEnableOrientation()

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

Set if orientation manipulation is enabled.

◆ setEnablePosition()

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

Set if position manipulation is enabled.

◆ setEnableSize()

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

Set if size manipulation is enabled.

◆ setEnableVertexPositionSet()

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

Set if vertex position set manipulation is enabled.

Version
1.17

◆ setForeignBone()

void Dragengine.Animators.ADRuleForeignState.setForeignBone ( String  bone)

Set foreign bone name.

◆ setForeignVertexPositionSet()

void Dragengine.Animators.ADRuleForeignState.setForeignVertexPositionSet ( String  vertexPositionSet)

Set foreign vertex position set name.

Version
1.17

◆ setModifyX()

void Dragengine.Animators.ADRuleForeignState.setModifyX ( bool  modify)

Set if X component is modified.

Version
1.6

◆ setModifyY()

void Dragengine.Animators.ADRuleForeignState.setModifyY ( bool  modify)

Set if Y component is modified.

Version
1.6

◆ setModifyZ()

void Dragengine.Animators.ADRuleForeignState.setModifyZ ( bool  modify)

Set if z component is modified.

Version
1.6

◆ setScaleOrientation()

void Dragengine.Animators.ADRuleForeignState.setScaleOrientation ( float  scaleFactor)

Set orientation scale factor.

◆ setScalePosition()

void Dragengine.Animators.ADRuleForeignState.setScalePosition ( float  scaleFactor)

Set position scale factor.

◆ setScaleSize()

void Dragengine.Animators.ADRuleForeignState.setScaleSize ( float  scaleFactor)

Set size scale factor.

◆ setScaleVertexPositionSet()

void Dragengine.Animators.ADRuleForeignState.setScaleVertexPositionSet ( float  scale)

Set vertex position set scale factor.

Version
1.17

◆ setSourceCoordinateFrame()

void Dragengine.Animators.ADRuleForeignState.setSourceCoordinateFrame ( ARForeignStateCFrame  coordFrame)

Set if source coordinate frame.


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