Dragengine.Animators.ADRuleLimit Class Reference

Definition of limit animator rule. More...

Inheritance diagram for Dragengine.Animators.ADRuleLimit:

Public Member Functions
AnimatorRule	buildRule (Animator animator)
	Build engine animator rule using the stored definition.
void	debug (Console console)
ARLimitCFrame	getCoordinateFrame ()
	Coordinate frame of rotation.
bool	getEnablePosXMax ()
	X position is limited to the maximum.
bool	getEnablePosXMin ()
	X position is limited to the minimum.
bool	getEnablePosYMax ()
	Y position is limited to the mayimum.
bool	getEnablePosYMin ()
	Y position is limited to the minimum.
bool	getEnablePosZMax ()
	Z position is limited to the mazimum.
bool	getEnablePosZMin ()
	Z position is limited to the minimum.
bool	getEnableRotXMax ()
	X rotation is limited to the maximum.
bool	getEnableRotXMin ()
	X rotation is limited to the minimum.
bool	getEnableRotYMax ()
	Y rotation is limited to the mayimum.
bool	getEnableRotYMin ()
	Y rotation is limited to the minimum.
bool	getEnableRotZMax ()
	Z rotation is limited to the mazimum.
bool	getEnableRotZMin ()
	Z rotation is limited to the minimum.
bool	getEnableScaleXMax ()
	X scaling is limited to the maximum.
bool	getEnableScaleXMin ()
	X scaling is limited to the minimum.
bool	getEnableScaleYMax ()
	Y scaling is limited to the mayimum.
bool	getEnableScaleYMin ()
	Y scaling is limited to the minimum.
bool	getEnableScaleZMax ()
	Z scaling is limited to the mazimum.
bool	getEnableScaleZMin ()
	Z scaling is limited to the minimum.
bool	getEnableVertexPositionSetMax ()
	Maximum vertex position set manipulation is enabled.
bool	getEnableVertexPositionSetMin ()
	Minimum vertex position set manipulation is enabled.
Vector	getMaximumPosition ()
	Maximum position.
Vector	getMaximumRotation ()
	Maximum rotation.
Vector	getMaximumScaling ()
	Maximum scaling.
float	getMaximumVertexPositionSet ()
	Maximum vertex position set.
Vector	getMinimumPosition ()
	Minimum position.
Vector	getMinimumRotation ()
	Minimum rotation.
Vector	getMinimumScaling ()
	Minimum scaling.
float	getMinimumVertexPositionSet ()
	Minimum vertex position set weight.
String	getTargetBone ()
	Target bone name.
ADRuleLimit	new ()
	Create animation rule definition.
ADRuleLimit	new (AnimatorDefinition fromDef, AnimatorDefinition toDef, ADRuleLimit rule)
	Create animation rule definition.
void	setCoordinateFrame (ARLimitCFrame coordFrame)
	Set if coordinate frame of rotation.
void	setEnablePosXMax (bool enable)
	Set if x position is limited to the maximum.
void	setEnablePosXMin (bool enable)
	Set if x position is limited to the minimum.
void	setEnablePosYMax (bool enable)
	Set if y position is limited to the mayimum.
void	setEnablePosYMin (bool enable)
	Set if y position is limited to the minimum.
void	setEnablePosZMax (bool enable)
	Set if z position is limited to the mazimum.
void	setEnablePosZMin (bool enable)
	Set if z position is limited to the minimum.
void	setEnableRotXMax (bool enable)
	Set if x rotation is limited to the maximum.
void	setEnableRotXMin (bool enable)
	Set if x rotation is limited to the minimum.
void	setEnableRotYMax (bool enable)
	Set if y rotation is limited to the mayimum.
void	setEnableRotYMin (bool enable)
	Set if y rotation is limited to the minimum.
void	setEnableRotZMax (bool enable)
	Set if z rotation is limited to the mazimum.
void	setEnableRotZMin (bool enable)
	Set if z rotation is limited to the minimum.
void	setEnableScaleXMax (bool enable)
	Set if x scaling is limited to the maximum.
void	setEnableScaleXMin (bool enable)
	Set if x scaling is limited to the minimum.
void	setEnableScaleYMax (bool enable)
	Set if y scaling is limited to the mayimum.
void	setEnableScaleYMin (bool enable)
	Set if y scaling is limited to the minimum.
void	setEnableScaleZMax (bool enable)
	Set if z scaling is limited to the mazimum.
void	setEnableScaleZMin (bool enable)
	Set if z scaling is limited to the minimum.
void	setEnableVertexPositionSetMax (bool enable)
	Set if maximum vertex position set manipulation is enabled.
void	setEnableVertexPositionSetMin (bool enable)
	Set if minimum vertex position set manipulation is enabled.
void	setMaximumPosition (Vector position)
	Set maximum position.
void	setMaximumRotation (Vector rotation)
	Set maximum rotation.
void	setMaximumScaling (Vector scaling)
	Set maximum scaling.
void	setMaximumVertexPositionSet (float weight)
	Set maximum scaling.
void	setMinimumPosition (Vector position)
	Set minimum position.
void	setMinimumRotation (Vector rotation)
	Set minimum rotation.
void	setMinimumScaling (Vector scaling)
	Set minimum scaling.
void	setMinimumVertexPositionSet (float weight)
	Set minimum vertex position set.
void	setTargetBone (String name)
	Set target bone name.
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 limit animator rule.

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

Member Function Documentation

buildRule()

AnimatorRule Dragengine.Animators.ADRuleLimit.buildRule

(

Animator

animator

)

Build engine animator rule using the stored definition.

Reimplemented from Dragengine.Animators.ADRule.

debug()

void Dragengine.Animators.ADRuleLimit.debug

(

Console

console

)

getCoordinateFrame()

ARLimitCFrame Dragengine.Animators.ADRuleLimit.getCoordinateFrame

(

)

Coordinate frame of rotation.

getEnablePosXMax()

bool Dragengine.Animators.ADRuleLimit.getEnablePosXMax

(

)

X position is limited to the maximum.

getEnablePosXMin()

bool Dragengine.Animators.ADRuleLimit.getEnablePosXMin

(

)

X position is limited to the minimum.

getEnablePosYMax()

bool Dragengine.Animators.ADRuleLimit.getEnablePosYMax

(

)

Y position is limited to the mayimum.

getEnablePosYMin()

bool Dragengine.Animators.ADRuleLimit.getEnablePosYMin

(

)

Y position is limited to the minimum.

getEnablePosZMax()

bool Dragengine.Animators.ADRuleLimit.getEnablePosZMax

(

)

Z position is limited to the mazimum.

getEnablePosZMin()

bool Dragengine.Animators.ADRuleLimit.getEnablePosZMin

(

)

Z position is limited to the minimum.

getEnableRotXMax()

bool Dragengine.Animators.ADRuleLimit.getEnableRotXMax

(

)

X rotation is limited to the maximum.

getEnableRotXMin()

bool Dragengine.Animators.ADRuleLimit.getEnableRotXMin

(

)

X rotation is limited to the minimum.

getEnableRotYMax()

bool Dragengine.Animators.ADRuleLimit.getEnableRotYMax

(

)

Y rotation is limited to the mayimum.

getEnableRotYMin()

bool Dragengine.Animators.ADRuleLimit.getEnableRotYMin

(

)

Y rotation is limited to the minimum.

getEnableRotZMax()

bool Dragengine.Animators.ADRuleLimit.getEnableRotZMax

(

)

Z rotation is limited to the mazimum.

getEnableRotZMin()

bool Dragengine.Animators.ADRuleLimit.getEnableRotZMin

(

)

Z rotation is limited to the minimum.

getEnableScaleXMax()

bool Dragengine.Animators.ADRuleLimit.getEnableScaleXMax

(

)

X scaling is limited to the maximum.

getEnableScaleXMin()

bool Dragengine.Animators.ADRuleLimit.getEnableScaleXMin

(

)

X scaling is limited to the minimum.

getEnableScaleYMax()

bool Dragengine.Animators.ADRuleLimit.getEnableScaleYMax

(

)

Y scaling is limited to the mayimum.

getEnableScaleYMin()

bool Dragengine.Animators.ADRuleLimit.getEnableScaleYMin

(

)

Y scaling is limited to the minimum.

getEnableScaleZMax()

bool Dragengine.Animators.ADRuleLimit.getEnableScaleZMax

(

)

Z scaling is limited to the mazimum.

getEnableScaleZMin()

bool Dragengine.Animators.ADRuleLimit.getEnableScaleZMin

(

)

Z scaling is limited to the minimum.

getEnableVertexPositionSetMax()

bool Dragengine.Animators.ADRuleLimit.getEnableVertexPositionSetMax

(

)

Maximum vertex position set manipulation is enabled.

Version

1.17

getEnableVertexPositionSetMin()

bool Dragengine.Animators.ADRuleLimit.getEnableVertexPositionSetMin

(

)

Minimum vertex position set manipulation is enabled.

Version

1.17

getMaximumPosition()

Vector Dragengine.Animators.ADRuleLimit.getMaximumPosition

(

)

Maximum position.

getMaximumRotation()

Vector Dragengine.Animators.ADRuleLimit.getMaximumRotation

(

)

Maximum rotation.

getMaximumScaling()

Vector Dragengine.Animators.ADRuleLimit.getMaximumScaling

(

)

Maximum scaling.

getMaximumVertexPositionSet()

float Dragengine.Animators.ADRuleLimit.getMaximumVertexPositionSet

(

)

Maximum vertex position set.

Version

1.17

getMinimumPosition()

Vector Dragengine.Animators.ADRuleLimit.getMinimumPosition

(

)

Minimum position.

getMinimumRotation()

Vector Dragengine.Animators.ADRuleLimit.getMinimumRotation

(

)

Minimum rotation.

getMinimumScaling()

Vector Dragengine.Animators.ADRuleLimit.getMinimumScaling

(

)

Minimum scaling.

getMinimumVertexPositionSet()

float Dragengine.Animators.ADRuleLimit.getMinimumVertexPositionSet

(

)

Minimum vertex position set weight.

Version

1.17

getTargetBone()

String Dragengine.Animators.ADRuleLimit.getTargetBone

(

)

Target bone name.

new() [1/2]

ADRuleLimit Dragengine.Animators.ADRuleLimit.new

(

)

Create animation rule definition.

Reimplemented from Dragengine.Animators.ADRule.

new() [2/2]

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

Create animation rule definition.

setCoordinateFrame()

void Dragengine.Animators.ADRuleLimit.setCoordinateFrame

(

ARLimitCFrame

coordFrame

)

Set if coordinate frame of rotation.

setEnablePosXMax()

void Dragengine.Animators.ADRuleLimit.setEnablePosXMax

(

bool

enable

)

Set if x position is limited to the maximum.

setEnablePosXMin()

void Dragengine.Animators.ADRuleLimit.setEnablePosXMin

(

bool

enable

)

Set if x position is limited to the minimum.

setEnablePosYMax()

void Dragengine.Animators.ADRuleLimit.setEnablePosYMax

(

bool

enable

)

Set if y position is limited to the mayimum.

setEnablePosYMin()

void Dragengine.Animators.ADRuleLimit.setEnablePosYMin

(

bool

enable

)

Set if y position is limited to the minimum.

setEnablePosZMax()

void Dragengine.Animators.ADRuleLimit.setEnablePosZMax

(

bool

enable

)

Set if z position is limited to the mazimum.

setEnablePosZMin()

void Dragengine.Animators.ADRuleLimit.setEnablePosZMin

(

bool

enable

)

Set if z position is limited to the minimum.

setEnableRotXMax()

void Dragengine.Animators.ADRuleLimit.setEnableRotXMax

(

bool

enable

)

Set if x rotation is limited to the maximum.

setEnableRotXMin()

void Dragengine.Animators.ADRuleLimit.setEnableRotXMin

(

bool

enable

)

Set if x rotation is limited to the minimum.

setEnableRotYMax()

void Dragengine.Animators.ADRuleLimit.setEnableRotYMax

(

bool

enable

)

Set if y rotation is limited to the mayimum.

setEnableRotYMin()

void Dragengine.Animators.ADRuleLimit.setEnableRotYMin

(

bool

enable

)

Set if y rotation is limited to the minimum.

setEnableRotZMax()

void Dragengine.Animators.ADRuleLimit.setEnableRotZMax

(

bool

enable

)

Set if z rotation is limited to the mazimum.

setEnableRotZMin()

void Dragengine.Animators.ADRuleLimit.setEnableRotZMin

(

bool

enable

)

Set if z rotation is limited to the minimum.

setEnableScaleXMax()

void Dragengine.Animators.ADRuleLimit.setEnableScaleXMax

(

bool

enable

)

Set if x scaling is limited to the maximum.

setEnableScaleXMin()

void Dragengine.Animators.ADRuleLimit.setEnableScaleXMin

(

bool

enable

)

Set if x scaling is limited to the minimum.

setEnableScaleYMax()

void Dragengine.Animators.ADRuleLimit.setEnableScaleYMax

(

bool

enable

)

Set if y scaling is limited to the mayimum.

setEnableScaleYMin()

void Dragengine.Animators.ADRuleLimit.setEnableScaleYMin

(

bool

enable

)

Set if y scaling is limited to the minimum.

setEnableScaleZMax()

void Dragengine.Animators.ADRuleLimit.setEnableScaleZMax

(

bool

enable

)

Set if z scaling is limited to the mazimum.

setEnableScaleZMin()

void Dragengine.Animators.ADRuleLimit.setEnableScaleZMin

(

bool

enable

)

Set if z scaling is limited to the minimum.

setEnableVertexPositionSetMax()

void Dragengine.Animators.ADRuleLimit.setEnableVertexPositionSetMax

(

bool

enable

)

Set if maximum vertex position set manipulation is enabled.

Version

1.17

setEnableVertexPositionSetMin()

void Dragengine.Animators.ADRuleLimit.setEnableVertexPositionSetMin

(

bool

enable

)

Set if minimum vertex position set manipulation is enabled.

Version

1.17

setMaximumPosition()

void Dragengine.Animators.ADRuleLimit.setMaximumPosition

(

Vector

position

)

Set maximum position.

setMaximumRotation()

void Dragengine.Animators.ADRuleLimit.setMaximumRotation

(

Vector

rotation

)

Set maximum rotation.

setMaximumScaling()

void Dragengine.Animators.ADRuleLimit.setMaximumScaling

(

Vector

scaling

)

Set maximum scaling.

setMaximumVertexPositionSet()

void Dragengine.Animators.ADRuleLimit.setMaximumVertexPositionSet

(

float

weight

)

Set maximum scaling.

Version

1.17

setMinimumPosition()

void Dragengine.Animators.ADRuleLimit.setMinimumPosition

(

Vector

position

)

Set minimum position.

setMinimumRotation()

void Dragengine.Animators.ADRuleLimit.setMinimumRotation

(

Vector

rotation

)

Set minimum rotation.

setMinimumScaling()

void Dragengine.Animators.ADRuleLimit.setMinimumScaling

(

Vector

scaling

)

Set minimum scaling.

setMinimumVertexPositionSet()

void Dragengine.Animators.ADRuleLimit.setMinimumVertexPositionSet

(

float

weight

)

Set minimum vertex position set.

Version

1.17

setTargetBone()

void Dragengine.Animators.ADRuleLimit.setTargetBone

(

String

name

)

Set target bone name.

---

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

• ADRuleLimit.ds