Drag[en]gine Script Module DragonScript  1.21
Dragengine.Animators.ADRuleBoneTransformator Class Reference

Definition of bone transformator animator rule. More...

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

Public Member Functions

AnimatorRule buildRule (Animator animator)
 
void debug (Console console)
 
Vector getAxis ()
 Rotation axis. More...
 
ARBoneTransformatorCFrame getCoordinateFrame ()
 Coordinate frame of rotation. More...
 
bool getEnableOrientation ()
 Transformation affects the orientation. More...
 
bool getEnablePosition ()
 Ttransformation affects the position. More...
 
bool getEnableSize ()
 Transformation affects the size. More...
 
float getMaximumAngle ()
 Maximum axis rotation angle. More...
 
Vector getMaximumRotation ()
 Maximum rotation. More...
 
Vector getMaximumScaling ()
 Maximum scaling. More...
 
Vector getMaximumTranslation ()
 Maximum translation. More...
 
float getMinimumAngle ()
 Minimum axis rotation angle. More...
 
Vector getMinimumRotation ()
 Minimum rotation. More...
 
Vector getMinimumScaling ()
 Minimum scaling. More...
 
Vector getMinimumTranslation ()
 Mminimum translation. More...
 
String getTargetBone ()
 Target bone name. More...
 
bool getUseAxis ()
 Use rotation axis instead of rotation directly. More...
 
ADRuleBoneTransformator new ()
 Create animation rule definition. More...
 
ADRuleBoneTransformator new (AnimatorDefinition fromDef, AnimatorDefinition toDef, ADRuleBoneTransformator rule)
 Create copy of animation rule definition. More...
 
void setAxis (Vector axis)
 Set rotation axis. More...
 
void setCoordinateFrame (ARBoneTransformatorCFrame coordFrame)
 Set if coordinate frame of rotation. More...
 
void setEnableOrientation (bool enable)
 Set if transformation affects the orientation. More...
 
void setEnablePosition (bool enable)
 Set if transformation affects the position. More...
 
void setEnableSize (bool enable)
 Set if transformation affects the size. More...
 
void setMaximumAngle (float angle)
 Set maximum axis rotation angle. More...
 
void setMaximumRotation (Vector rotation)
 Set maximum rotation. More...
 
void setMaximumScaling (Vector scaling)
 Set maximum scaling. More...
 
void setMaximumTranslation (Vector translation)
 Set maximum translation. More...
 
void setMinimumAngle (float angle)
 Set minimum axis rotation angle. More...
 
void setMinimumRotation (Vector rotation)
 Set minimum rotation. More...
 
void setMinimumScaling (Vector scaling)
 Set minimum scaling. More...
 
void setMinimumTranslation (Vector translation)
 Set minimum translation. More...
 
void setTargetBone (String name)
 Set target bone name. More...
 
void setUseAxis (bool useAxis)
 Set to use rotation axis instead of rotation directly. 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 bone transformator animator rule.

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

Member Function Documentation

◆ buildRule()

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

Build engine animator rule using the stored definition.

Reimplemented from Dragengine.Animators.ADRule.

◆ debug()

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

◆ getAxis()

Vector Dragengine.Animators.ADRuleBoneTransformator.getAxis ( )

Rotation axis.

Version
1.6

◆ getCoordinateFrame()

ARBoneTransformatorCFrame Dragengine.Animators.ADRuleBoneTransformator.getCoordinateFrame ( )

Coordinate frame of rotation.

◆ getEnableOrientation()

bool Dragengine.Animators.ADRuleBoneTransformator.getEnableOrientation ( )

Transformation affects the orientation.

◆ getEnablePosition()

bool Dragengine.Animators.ADRuleBoneTransformator.getEnablePosition ( )

Ttransformation affects the position.

◆ getEnableSize()

bool Dragengine.Animators.ADRuleBoneTransformator.getEnableSize ( )

Transformation affects the size.

◆ getMaximumAngle()

float Dragengine.Animators.ADRuleBoneTransformator.getMaximumAngle ( )

Maximum axis rotation angle.

Version
1.6

◆ getMaximumRotation()

Vector Dragengine.Animators.ADRuleBoneTransformator.getMaximumRotation ( )

Maximum rotation.

◆ getMaximumScaling()

Vector Dragengine.Animators.ADRuleBoneTransformator.getMaximumScaling ( )

Maximum scaling.

◆ getMaximumTranslation()

Vector Dragengine.Animators.ADRuleBoneTransformator.getMaximumTranslation ( )

Maximum translation.

◆ getMinimumAngle()

float Dragengine.Animators.ADRuleBoneTransformator.getMinimumAngle ( )

Minimum axis rotation angle.

Version
1.6

◆ getMinimumRotation()

Vector Dragengine.Animators.ADRuleBoneTransformator.getMinimumRotation ( )

Minimum rotation.

◆ getMinimumScaling()

Vector Dragengine.Animators.ADRuleBoneTransformator.getMinimumScaling ( )

Minimum scaling.

◆ getMinimumTranslation()

Vector Dragengine.Animators.ADRuleBoneTransformator.getMinimumTranslation ( )

Mminimum translation.

◆ getTargetBone()

String Dragengine.Animators.ADRuleBoneTransformator.getTargetBone ( )

Target bone name.

◆ getUseAxis()

bool Dragengine.Animators.ADRuleBoneTransformator.getUseAxis ( )

Use rotation axis instead of rotation directly.

Version
1.6

◆ new() [1/2]

ADRuleBoneTransformator Dragengine.Animators.ADRuleBoneTransformator.new ( )

Create animation rule definition.

Reimplemented from Dragengine.Animators.ADRule.

◆ new() [2/2]

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

Create copy of animation rule definition.

Version
1.13

◆ setAxis()

void Dragengine.Animators.ADRuleBoneTransformator.setAxis ( Vector  axis)

Set rotation axis.

Version
1.6

◆ setCoordinateFrame()

void Dragengine.Animators.ADRuleBoneTransformator.setCoordinateFrame ( ARBoneTransformatorCFrame  coordFrame)

Set if coordinate frame of rotation.

◆ setEnableOrientation()

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

Set if transformation affects the orientation.

◆ setEnablePosition()

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

Set if transformation affects the position.

◆ setEnableSize()

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

Set if transformation affects the size.

◆ setMaximumAngle()

void Dragengine.Animators.ADRuleBoneTransformator.setMaximumAngle ( float  angle)

Set maximum axis rotation angle.

Version
1.6

◆ setMaximumRotation()

void Dragengine.Animators.ADRuleBoneTransformator.setMaximumRotation ( Vector  rotation)

Set maximum rotation.

◆ setMaximumScaling()

void Dragengine.Animators.ADRuleBoneTransformator.setMaximumScaling ( Vector  scaling)

Set maximum scaling.

◆ setMaximumTranslation()

void Dragengine.Animators.ADRuleBoneTransformator.setMaximumTranslation ( Vector  translation)

Set maximum translation.

◆ setMinimumAngle()

void Dragengine.Animators.ADRuleBoneTransformator.setMinimumAngle ( float  angle)

Set minimum axis rotation angle.

Version
1.6

◆ setMinimumRotation()

void Dragengine.Animators.ADRuleBoneTransformator.setMinimumRotation ( Vector  rotation)

Set minimum rotation.

◆ setMinimumScaling()

void Dragengine.Animators.ADRuleBoneTransformator.setMinimumScaling ( Vector  scaling)

Set minimum scaling.

◆ setMinimumTranslation()

void Dragengine.Animators.ADRuleBoneTransformator.setMinimumTranslation ( Vector  translation)

Set minimum translation.

◆ setTargetBone()

void Dragengine.Animators.ADRuleBoneTransformator.setTargetBone ( String  name)

Set target bone name.

◆ setUseAxis()

void Dragengine.Animators.ADRuleBoneTransformator.setUseAxis ( bool  useAxis)

Set to use rotation axis instead of rotation directly.

Version
1.6

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