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

Public Member Functions

AnimatorRule buildRule (Animator animator)
 
void debug (Console console)
 
bool getAdjustOrientation ()
 
Vector getGoalOrientation ()
 
Vector getGoalPosition ()
 
Vector getLocalOrientation ()
 
Vector getLocalPosition ()
 
String getReachBone ()
 
Vector getReachCenter ()
 
float getReachRange ()
 
String getSolverBone ()
 
bool getUseSolverBone ()
 
ADRuleInverseKinematic new ()
 
void setAdjustOrientation (bool adjust)
 
void setGoalOrientation (Vector orientation)
 
void setGoalPosition (Vector position)
 
void setLocalOrientation (Vector orientation)
 
void setLocalPosition (Vector position)
 
void setReachBone (String bone)
 
void setReachCenter (Vector center)
 
void setReachRange (float range)
 
void setSolverBone (String bone)
 
void setUseSolverBone (bool useSolverBone)
 
- 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 inverse kinematic 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)

§ getAdjustOrientation()

bool getAdjustOrientation ( )

Determines if the bone orientation is adjusted.

§ getGoalOrientation()

Vector getGoalOrientation ( )

Retrieves the goal orientation.

§ getGoalPosition()

Vector getGoalPosition ( )

Retrieves the goal position.

§ getLocalOrientation()

Vector getLocalOrientation ( )

Retrieves the local orientation.

§ getLocalPosition()

Vector getLocalPosition ( )

Retrieves the local position.

§ getReachBone()

String getReachBone ( )

Bone to use as reach origin or an empty string to use a constant position.

§ getReachCenter()

Vector getReachCenter ( )

Reach center if no bone is used.

§ getReachRange()

float getReachRange ( )

Limit reach in meters. 0 disables reach limit.

§ getSolverBone()

String getSolverBone ( )

Retrieves the solver bone name.

§ getUseSolverBone()

bool getUseSolverBone ( )

Determines if the solver bone is used.

§ new()

Creates a new animation rule definition.

§ setAdjustOrientation()

void setAdjustOrientation ( bool  adjust)

Sets if the bone orientation is adjusted.

§ setGoalOrientation()

void setGoalOrientation ( Vector  orientation)

Sets the goal orientation.

§ setGoalPosition()

void setGoalPosition ( Vector  position)

Sets the goal position.

§ setLocalOrientation()

void setLocalOrientation ( Vector  orientation)

Sets the local orientation.

§ setLocalPosition()

void setLocalPosition ( Vector  position)

Sets the local position.

§ setReachBone()

void setReachBone ( String  bone)

Set bone to use as reach origin or an empty string to use a constant position.

§ setReachCenter()

void setReachCenter ( Vector  center)

Set reach center if no bone is used.

§ setReachRange()

void setReachRange ( float  range)

Set limit reach in meters. 0 disables reach limit.

§ setSolverBone()

void setSolverBone ( String  bone)

Sets the solver bone name.

§ setUseSolverBone()

void setUseSolverBone ( bool  useSolverBone)

Sets if the solver bone is used.


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