Drag[en]gine Script Module DragonScript
1.23
|
Definition of a inverse kinematic animator rule. More...
Public Member Functions | |
AnimatorRule | buildRule (Animator animator) |
Build engine animator rule using the stored definition. More... | |
void | debug (Console console) |
bool | getAdjustOrientation () |
Bone orientation is adjusted. More... | |
bool | getAdjustPosition () |
Bone position is adjusted. More... | |
Vector | getGoalOrientation () |
Goal orientation. More... | |
Vector | getGoalPosition () |
Goal position. More... | |
Vector | getLocalOrientation () |
Local orientation. More... | |
Vector | getLocalPosition () |
Local position. More... | |
String | getReachBone () |
Bone to use as reach origin or an empty string to use a constant position. More... | |
Vector | getReachCenter () |
float | getReachRange () |
Limit reach in meters. More... | |
String | getSolverBone () |
Solver bone name. More... | |
bool | getUseSolverBone () |
Solver bone is used. More... | |
ADRuleInverseKinematic | new () |
Create animation rule definition. More... | |
ADRuleInverseKinematic | new (AnimatorDefinition fromDef, AnimatorDefinition toDef, ADRuleInverseKinematic rule) |
Create copy of animation rule definition. More... | |
void | setAdjustOrientation (bool adjust) |
Set if bone orientation is adjusted. More... | |
void | setAdjustPosition (bool adjust) |
Set if bone position is adjusted. More... | |
void | setGoalOrientation (Vector orientation) |
Set goal orientation. More... | |
void | setGoalPosition (Vector position) |
Set goal position. More... | |
void | setLocalOrientation (Vector orientation) |
Set local orientation. More... | |
void | setLocalPosition (Vector position) |
Set local position. More... | |
void | setReachBone (String bone) |
Set bone to use as reach origin or an empty string to use a constant position. More... | |
void | setReachCenter (Vector center) |
void | setReachRange (float range) |
Set limit reach in meters. More... | |
void | setSolverBone (String bone) |
Set solver bone name. More... | |
void | setUseSolverBone (bool useSolverBone) |
Set if solver bone is used. 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... | |
Definition of a inverse kinematic animator rule.
Once defined a rule can be added to an animator using the stored definition.
AnimatorRule Dragengine.Animators.ADRuleInverseKinematic.buildRule | ( | Animator | animator | ) |
Build engine animator rule using the stored definition.
Reimplemented from Dragengine.Animators.ADRule.
void Dragengine.Animators.ADRuleInverseKinematic.debug | ( | Console | console | ) |
bool Dragengine.Animators.ADRuleInverseKinematic.getAdjustOrientation | ( | ) |
Bone orientation is adjusted.
bool Dragengine.Animators.ADRuleInverseKinematic.getAdjustPosition | ( | ) |
Bone position is adjusted.
Vector Dragengine.Animators.ADRuleInverseKinematic.getGoalOrientation | ( | ) |
Goal orientation.
Vector Dragengine.Animators.ADRuleInverseKinematic.getGoalPosition | ( | ) |
Goal position.
Vector Dragengine.Animators.ADRuleInverseKinematic.getLocalOrientation | ( | ) |
Local orientation.
Vector Dragengine.Animators.ADRuleInverseKinematic.getLocalPosition | ( | ) |
Local position.
String Dragengine.Animators.ADRuleInverseKinematic.getReachBone | ( | ) |
Bone to use as reach origin or an empty string to use a constant position.
Vector Dragengine.Animators.ADRuleInverseKinematic.getReachCenter | ( | ) |
Reach center if no bone is used.
float Dragengine.Animators.ADRuleInverseKinematic.getReachRange | ( | ) |
Limit reach in meters.
0 disables reach limit.
String Dragengine.Animators.ADRuleInverseKinematic.getSolverBone | ( | ) |
Solver bone name.
bool Dragengine.Animators.ADRuleInverseKinematic.getUseSolverBone | ( | ) |
Solver bone is used.
ADRuleInverseKinematic Dragengine.Animators.ADRuleInverseKinematic.new | ( | ) |
Create animation rule definition.
Reimplemented from Dragengine.Animators.ADRule.
ADRuleInverseKinematic Dragengine.Animators.ADRuleInverseKinematic.new | ( | AnimatorDefinition | fromDef, |
AnimatorDefinition | toDef, | ||
ADRuleInverseKinematic | rule | ||
) |
Create copy of animation rule definition.
void Dragengine.Animators.ADRuleInverseKinematic.setAdjustOrientation | ( | bool | adjust | ) |
Set if bone orientation is adjusted.
void Dragengine.Animators.ADRuleInverseKinematic.setAdjustPosition | ( | bool | adjust | ) |
Set if bone position is adjusted.
void Dragengine.Animators.ADRuleInverseKinematic.setGoalOrientation | ( | Vector | orientation | ) |
Set goal orientation.
void Dragengine.Animators.ADRuleInverseKinematic.setGoalPosition | ( | Vector | position | ) |
Set goal position.
void Dragengine.Animators.ADRuleInverseKinematic.setLocalOrientation | ( | Vector | orientation | ) |
Set local orientation.
void Dragengine.Animators.ADRuleInverseKinematic.setLocalPosition | ( | Vector | position | ) |
Set local position.
void Dragengine.Animators.ADRuleInverseKinematic.setReachBone | ( | String | bone | ) |
Set bone to use as reach origin or an empty string to use a constant position.
void Dragengine.Animators.ADRuleInverseKinematic.setReachCenter | ( | Vector | center | ) |
Set reach center if no bone is used.
void Dragengine.Animators.ADRuleInverseKinematic.setReachRange | ( | float | range | ) |
Set limit reach in meters.
0 disables reach limit.
void Dragengine.Animators.ADRuleInverseKinematic.setSolverBone | ( | String | bone | ) |
Set solver bone name.
void Dragengine.Animators.ADRuleInverseKinematic.setUseSolverBone | ( | bool | useSolverBone | ) |
Set if solver bone is used.