Definition of a inverse kinematic animator rule. More...

Inheritance diagram for Dragengine.Animators.ADRuleInverseKinematic:

Public Member Functions
AnimatorRule	buildRule (Animator animator)
	Build engine animator rule using the stored definition.

void	debug (Console console)

bool	getAdjustOrientation ()
	Bone orientation is adjusted.

bool	getAdjustPosition ()
	Bone position is adjusted.

Vector	getGoalOrientation ()
	Goal orientation.

Vector	getGoalPosition ()
	Goal position.

Vector	getLocalOrientation ()
	Local orientation.

Vector	getLocalPosition ()
	Local position.

String	getReachBone ()
	Bone to use as reach origin or an empty string to use a constant position.

Vector	getReachCenter ()

float	getReachRange ()
	Limit reach in meters.

String	getSolverBone ()
	Solver bone name.

bool	getUseSolverBone ()
	Solver bone is used.

ADRuleInverseKinematic	new ()
	Create animation rule definition.

ADRuleInverseKinematic	new (AnimatorDefinition fromDef, AnimatorDefinition toDef, ADRuleInverseKinematic rule)
	Create copy of animation rule definition.

void	setAdjustOrientation (bool adjust)
	Set if bone orientation is adjusted.

void	setAdjustPosition (bool adjust)
	Set if bone position is adjusted.

void	setGoalOrientation (Vector orientation)
	Set goal orientation.

void	setGoalPosition (Vector position)
	Set goal position.

void	setLocalOrientation (Vector orientation)
	Set local orientation.

void	setLocalPosition (Vector position)
	Set local position.

void	setReachBone (String bone)
	Set bone to use as reach origin or an empty string to use a constant position.

void	setReachCenter (Vector center)

void	setReachRange (float range)
	Set limit reach in meters.

void	setSolverBone (String bone)
	Set solver bone name.

void	setUseSolverBone (bool useSolverBone)
	Set if solver bone is used.

Public Member Functions inherited from Dragengine.Animators.ADRule
void	addBone (String bone)
	Add bone.

void	addTargetLink (ADRuleTargetLink targetLink)
	Add target link.

void	addVertexPositionSet (String vertexPositionSet)
	Add vertex position set.

void	forEachTarget (Block ablock)
	Visit target links with a block.

float	getBlendFactor ()
	Blend factor.

AnimatorRuleBlendMode	getBlendMode ()
	Blend mode.

String	getBoneAt (int index)
	Bone at index.

int	getBoneCount ()
	Count of bones.

bool	getEnabled ()
	Rule is enabled.

bool	getInvertBlendFactor ()
	Invert blend factor (1 - blendFactor).

ADRuleTargetLink	getTargetLinkAt (int index)
	Target link at index.

int	getTargetLinkCount ()
	Count of target links.

String	getVertexPositionSetAt (int index)
	Vertex position set at index.

int	getVertexPositionSetCount ()
	Count of vertex position sets.

void	removeAllTargetLinks ()
	Remove all target links.

void	setBlendFactor (float factor)
	Set blend factor.

void	setBlendMode (AnimatorRuleBlendMode mode)
	Set blend mode.

void	setEnabled (bool enabled)
	Set if rule is enabled.

void	setInvertBlendFactor (bool invertBlendFactor)
	Set invert blend factor (1 - blendFactor).

void	setName (String name)
	Set name of rule.

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.

Detailed Description

Definition of a inverse kinematic animator rule.

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

Member Function Documentation

◆ buildRule()

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

Build engine animator rule using the stored definition.

Reimplemented from Dragengine.Animators.ADRule.

◆ debug()

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

◆ getAdjustOrientation()

bool Dragengine.Animators.ADRuleInverseKinematic.getAdjustOrientation ( )

Bone orientation is adjusted.

◆ getAdjustPosition()

bool Dragengine.Animators.ADRuleInverseKinematic.getAdjustPosition ( )

Bone position is adjusted.

Version: 1.6

◆ getGoalOrientation()

Vector Dragengine.Animators.ADRuleInverseKinematic.getGoalOrientation ( )

Goal orientation.

◆ getGoalPosition()

Vector Dragengine.Animators.ADRuleInverseKinematic.getGoalPosition ( )

Goal position.

◆ getLocalOrientation()

Vector Dragengine.Animators.ADRuleInverseKinematic.getLocalOrientation ( )

Local orientation.

◆ getLocalPosition()

Vector Dragengine.Animators.ADRuleInverseKinematic.getLocalPosition ( )

Local position.

◆ getReachBone()

String Dragengine.Animators.ADRuleInverseKinematic.getReachBone ( )

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

◆ getReachCenter()

Vector Dragengine.Animators.ADRuleInverseKinematic.getReachCenter ( )

Reach center if no bone is used.

◆ getReachRange()

float Dragengine.Animators.ADRuleInverseKinematic.getReachRange ( )

Limit reach in meters.

0 disables reach limit.

◆ getSolverBone()

String Dragengine.Animators.ADRuleInverseKinematic.getSolverBone ( )

Solver bone name.

◆ getUseSolverBone()

bool Dragengine.Animators.ADRuleInverseKinematic.getUseSolverBone ( )

Solver bone is used.

◆ new() [1/2]

ADRuleInverseKinematic Dragengine.Animators.ADRuleInverseKinematic.new ( )

Create animation rule definition.

Reimplemented from Dragengine.Animators.ADRule.

◆ new() [2/2]

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

Create copy of animation rule definition.

Version: 1.13

◆ setAdjustOrientation()

void Dragengine.Animators.ADRuleInverseKinematic.setAdjustOrientation ( bool adjust )

Set if bone orientation is adjusted.

◆ setAdjustPosition()

void Dragengine.Animators.ADRuleInverseKinematic.setAdjustPosition ( bool adjust )

Set if bone position is adjusted.

Version: 1.6

◆ setGoalOrientation()

void Dragengine.Animators.ADRuleInverseKinematic.setGoalOrientation ( Vector orientation )

Set goal orientation.

◆ setGoalPosition()

void Dragengine.Animators.ADRuleInverseKinematic.setGoalPosition ( Vector position )

Set goal position.

◆ setLocalOrientation()

void Dragengine.Animators.ADRuleInverseKinematic.setLocalOrientation ( Vector orientation )

Set local orientation.

◆ setLocalPosition()

void Dragengine.Animators.ADRuleInverseKinematic.setLocalPosition ( Vector position )

Set local position.

◆ setReachBone()

void Dragengine.Animators.ADRuleInverseKinematic.setReachBone ( String bone )

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

◆ setReachCenter()

void Dragengine.Animators.ADRuleInverseKinematic.setReachCenter ( Vector center )

Set reach center if no bone is used.

◆ setReachRange()

void Dragengine.Animators.ADRuleInverseKinematic.setReachRange ( float range )

Set limit reach in meters.