Drag[en]gine Script Module DragonScript Script API  1.0
ADRuleForeignState Class Reference
Inheritance diagram for ADRuleForeignState:
ADRule

Public Member Functions

AnimatorRule buildRule (Animator animator)
 
void debug (Console console)
 
int getDestinationCoordinateFrame ()
 
bool getEnableOrientation ()
 
bool getEnablePosition ()
 
bool getEnableSize ()
 
String getForeignBone ()
 
float getScaleOrientation ()
 
float getScalePosition ()
 
float getScaleSize ()
 
int getSourceCoordinateFrame ()
 
ADRuleForeignState new ()
 
void setDestinationCoordinateFrame (int coordFrame)
 
void setEnableOrientation (bool enable)
 
void setEnablePosition (bool enable)
 
void setEnableSize (bool enable)
 
void setForeignBone (String bone)
 
void setScaleOrientation (float scaleFactor)
 
void setScalePosition (float scaleFactor)
 
void setScaleSize (float scaleFactor)
 
void setSourceCoordinateFrame (int coordFrame)
 
- Public Member Functions inherited from ADRule
void addBone (String bone)
 
void addTargetLink (ADRuleTargetLink targetLink)
 
AnimatorRule buildRule (Animator animator)
 
void debug (Console console)
 
void forEachTarget (Block ablock)
 Visit targets with a block. More...
 
float getBlendFactor ()
 
int getBlendMode ()
 
String getBoneAt (int index)
 
bool getEnabled ()
 
String getName ()
 
ADRuleTargetLink getTargetLinkAt (int index)
 
int getTargetLinkCount ()
 
ADRule new ()
 
void setBlendFactor (float factor)
 
void setBlendMode (int mode)
 
void setEnabled (bool enabled)
 
void setName (String name)
 

Additional Inherited Members

- Protected Member Functions inherited from ADRule
String debugCommon (String type)
 

Detailed Description

Definition of a foreign state animator rule. Once defined a rule can be added to an animator using the stored definition.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ buildRule()

AnimatorRule buildRule ( Animator  animator)

Build engine animator rule using the stored definition.

§ debug()

void debug ( Console  console)

§ getDestinationCoordinateFrame()

int getDestinationCoordinateFrame ( )

Retrieves the destination coordinate frame.

§ getEnableOrientation()

bool getEnableOrientation ( )

Determines if the orientation manipulation is enabled.

§ getEnablePosition()

bool getEnablePosition ( )

Determines if the position manipulation is enabled.

§ getEnableSize()

bool getEnableSize ( )

Determines if the size manipulation is enabled.

§ getForeignBone()

String getForeignBone ( )

Retrieves the foreign bone name.

§ getScaleOrientation()

float getScaleOrientation ( )

Retrieves the orientation scale factor.

§ getScalePosition()

float getScalePosition ( )

Retrieves the position scale factor.

§ getScaleSize()

float getScaleSize ( )

Retrieves the size scale factor.

§ getSourceCoordinateFrame()

int getSourceCoordinateFrame ( )

Retrieves the source coordinate frame.

§ new()

Creates a new animation rule definition.

§ setDestinationCoordinateFrame()

void setDestinationCoordinateFrame ( int  coordFrame)

Sets if the destination coordinate frame.

§ setEnableOrientation()

void setEnableOrientation ( bool  enable)

Sets if the orientation manipulation is enabled.

§ setEnablePosition()

void setEnablePosition ( bool  enable)

Sets if the position manipulation is enabled.

§ setEnableSize()

void setEnableSize ( bool  enable)

Sets if the size manipulation is enabled.

§ setForeignBone()

void setForeignBone ( String  bone)

Sets the foreign bone name.

§ setScaleOrientation()

void setScaleOrientation ( float  scaleFactor)

Sets the orientation scale factor.

§ setScalePosition()

void setScalePosition ( float  scaleFactor)

Sets the position scale factor.

§ setScaleSize()

void setScaleSize ( float  scaleFactor)

Sets the size scale factor.

§ setSourceCoordinateFrame()

void setSourceCoordinateFrame ( int  coordFrame)

Sets if the source coordinate frame.


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