Dragengine.Animators.ADRule Class Reference

Definition of animator rule. More...

Inheritance diagram for Dragengine.Animators.ADRule:

Public Member Functions
void	addBone (String bone)
	Add bone.
void	addTargetLink (ADRuleTargetLink targetLink)
	Add target link.
void	addVertexPositionSet (String vertexPositionSet)
	Add vertex position set.
AnimatorRule	buildRule (Animator animator)
	Build engine animator rule using the stored definition.
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.
ADRule	new ()
	Create animation rule definition.
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.

Protected Member Functions
String	debugCommon (String type)
ADRule	new (AnimatorDefinition fromDef, AnimatorDefinition toDef, ADRule rule)
	Create copy of animation rule definition.

Detailed Description

Definition of animator rule.

Once defined a rule can be added to an animator using the stored definition. This is the base rule class with the properties shared amongst all rule types.

Member Function Documentation

addBone()

void Dragengine.Animators.ADRule.addBone

(

String

bone

)

Add bone.

addTargetLink()

void Dragengine.Animators.ADRule.addTargetLink

(

ADRuleTargetLink

targetLink

)

Add target link.

addVertexPositionSet()

void Dragengine.Animators.ADRule.addVertexPositionSet

(

String

vertexPositionSet

)

Add vertex position set.

Version

1.17

buildRule()

AnimatorRule Dragengine.Animators.ADRule.buildRule

(

Animator

animator

)

Build engine animator rule using the stored definition.

Reimplemented in Dragengine.Animators.ADRuleAnimation, Dragengine.Animators.ADRuleAnimationDifference, Dragengine.Animators.ADRuleAnimationSelect, Dragengine.Animators.ADRuleBoneTransformator, Dragengine.Animators.ADRuleForeignState, Dragengine.Animators.ADRuleGroup, Dragengine.Animators.ADRuleInverseKinematic, Dragengine.Animators.ADRuleLimit, Dragengine.Animators.ADRuleMirror, Dragengine.Animators.ADRuleStateManipulator, Dragengine.Animators.ADRuleStateSnapshot, Dragengine.Animators.ADRuleSubAnimator, and Dragengine.Animators.ADRuleTrackTo.

debugCommon()

String Dragengine.Animators.ADRule.debugCommon ( String  type )

protected

forEachTarget()

void Dragengine.Animators.ADRule.forEachTarget

(

Block

ablock

)

Visit target links with a block.

getBlendFactor()

float Dragengine.Animators.ADRule.getBlendFactor

(

)

Blend factor.

getBlendMode()

AnimatorRuleBlendMode Dragengine.Animators.ADRule.getBlendMode

(

)

Blend mode.

getBoneAt()

String Dragengine.Animators.ADRule.getBoneAt

(

int

index

)

Bone at index.

getBoneCount()

int Dragengine.Animators.ADRule.getBoneCount

(

)

Count of bones.

getEnabled()

bool Dragengine.Animators.ADRule.getEnabled

(

)

Rule is enabled.

getInvertBlendFactor()

bool Dragengine.Animators.ADRule.getInvertBlendFactor

(

)

Invert blend factor (1 - blendFactor).

Version

1.13

getTargetLinkAt()

ADRuleTargetLink Dragengine.Animators.ADRule.getTargetLinkAt

(

int

index

)

Target link at index.

getTargetLinkCount()

int Dragengine.Animators.ADRule.getTargetLinkCount

(

)

Count of target links.

getVertexPositionSetAt()

String Dragengine.Animators.ADRule.getVertexPositionSetAt

(

int

index

)

Vertex position set at index.

Version

1.17

getVertexPositionSetCount()

int Dragengine.Animators.ADRule.getVertexPositionSetCount

(

)

Count of vertex position sets.

Version

1.17

new() [1/2]

ADRule Dragengine.Animators.ADRule.new

(

)

Create animation rule definition.

Reimplemented in Dragengine.Animators.ADRuleAnimation, Dragengine.Animators.ADRuleAnimationDifference, Dragengine.Animators.ADRuleAnimationSelect, Dragengine.Animators.ADRuleBoneTransformator, Dragengine.Animators.ADRuleForeignState, Dragengine.Animators.ADRuleGroup, Dragengine.Animators.ADRuleInverseKinematic, Dragengine.Animators.ADRuleLimit, Dragengine.Animators.ADRuleMirror, Dragengine.Animators.ADRuleStateManipulator, Dragengine.Animators.ADRuleStateSnapshot, Dragengine.Animators.ADRuleSubAnimator, and Dragengine.Animators.ADRuleTrackTo.

new() [2/2]

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

protected

Create copy of animation rule definition.

Version

1.13

removeAllTargetLinks()

void Dragengine.Animators.ADRule.removeAllTargetLinks

(

)

Remove all target links.

Version

1.13

setBlendFactor()

void Dragengine.Animators.ADRule.setBlendFactor

(

float

factor

)

Set blend factor.

setBlendMode()

void Dragengine.Animators.ADRule.setBlendMode

(

AnimatorRuleBlendMode

mode

)

Set blend mode.

setEnabled()

void Dragengine.Animators.ADRule.setEnabled

(

bool

enabled

)

Set if rule is enabled.

setInvertBlendFactor()

void Dragengine.Animators.ADRule.setInvertBlendFactor

(

bool

invertBlendFactor

)

Set invert blend factor (1 - blendFactor).

Version

1.13

setName()

void Dragengine.Animators.ADRule.setName

(

String

name

)

Set name of rule.

---

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

• ADRule.ds