Dragengine.Animators.ADRuleStateSnapshot Class Reference

Definition of state snapshot animator rule. More...

Inheritance diagram for Dragengine.Animators.ADRuleStateSnapshot:

Public Member Functions
AnimatorRule	buildRule (Animator animator)
	Build engine animator rule using the stored definition.
void	debug (Console console)
bool	getEnableOrientation ()
	Orientation manipulation is enabled.
bool	getEnablePosition ()
	Pposition manipulation is enabled.
bool	getEnableSize ()
	Size manipulation is enabled.
bool	getEnableVertexPositionSet ()
	Vertex position set manipulation is enabled.
int	getID ()
	Identifier to snapshot state using animator instance.
bool	getUseLastState ()
	Last state is used.
ADRuleStateSnapshot	new ()
	Create animation rule definition.
ADRuleStateSnapshot	new (AnimatorDefinition fromDef, AnimatorDefinition toDef, ADRuleStateSnapshot rule)
	Create copy of animation rule definition.
void	setEnableOrientation (bool enable)
	Set if orientation manipulation is enabled.
void	setEnablePosition (bool enable)
	Set if position manipulation is enabled.
void	setEnableSize (bool enable)
	Set if size manipulation is enabled.
void	setEnableVertexPositionSet (bool enable)
	Set if vertex position set manipulation is enabled.
void	setID (int identifier)
	Set identifier to snapshot state using animator instance.
void	setUseLastState (bool useLastState)
	Set if last state 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 state snapshot animator rule.

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

Member Function Documentation

buildRule()

AnimatorRule Dragengine.Animators.ADRuleStateSnapshot.buildRule

(

Animator

animator

)

Build engine animator rule using the stored definition.

Reimplemented from Dragengine.Animators.ADRule.

debug()

void Dragengine.Animators.ADRuleStateSnapshot.debug

(

Console

console

)

getEnableOrientation()

bool Dragengine.Animators.ADRuleStateSnapshot.getEnableOrientation

(

)

Orientation manipulation is enabled.

getEnablePosition()

bool Dragengine.Animators.ADRuleStateSnapshot.getEnablePosition

(

)

Pposition manipulation is enabled.

getEnableSize()

bool Dragengine.Animators.ADRuleStateSnapshot.getEnableSize

(

)

Size manipulation is enabled.

getEnableVertexPositionSet()

bool Dragengine.Animators.ADRuleStateSnapshot.getEnableVertexPositionSet

(

)

Vertex position set manipulation is enabled.

Version

1.17

getID()

int Dragengine.Animators.ADRuleStateSnapshot.getID

(

)

Identifier to snapshot state using animator instance.

getUseLastState()

bool Dragengine.Animators.ADRuleStateSnapshot.getUseLastState

(

)

Last state is used.

new() [1/2]

ADRuleStateSnapshot Dragengine.Animators.ADRuleStateSnapshot.new

(

)

Create animation rule definition.

Reimplemented from Dragengine.Animators.ADRule.

new() [2/2]

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

Create copy of animation rule definition.

Version

1.13

setEnableOrientation()

void Dragengine.Animators.ADRuleStateSnapshot.setEnableOrientation

(

bool

enable

)

Set if orientation manipulation is enabled.

setEnablePosition()

void Dragengine.Animators.ADRuleStateSnapshot.setEnablePosition

(

bool

enable

)

Set if position manipulation is enabled.

setEnableSize()

void Dragengine.Animators.ADRuleStateSnapshot.setEnableSize

(

bool

enable

)

Set if size manipulation is enabled.

setEnableVertexPositionSet()

void Dragengine.Animators.ADRuleStateSnapshot.setEnableVertexPositionSet

(

bool

enable

)

Set if vertex position set manipulation is enabled.

Version

1.17

setID()

void Dragengine.Animators.ADRuleStateSnapshot.setID

(

int

identifier

)

Set identifier to snapshot state using animator instance.

setUseLastState()

void Dragengine.Animators.ADRuleStateSnapshot.setUseLastState

(

bool

useLastState

)

Set if last state is used.

---

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

• ADRuleStateSnapshot.ds