Drag[en]gine Script Module DragonScript Script API  1.0
ARTrackTo Class Reference

Animator rule track to. More...

Inheritance diagram for ARTrackTo:
AnimatorRule

Public Member Functions

Constructors
ARTrackTo new ()
 Create animator rule. More...
 
Management
void setTrackBone (String bone)
 Set track bone name or empty string to use none. More...
 
void setTrackAxis (int axis)
 Set track axis. More...
 
void setUpAxis (int axis)
 Set up axis. More...
 
void setUpTarget (int target)
 Set up target. More...
 
void setLockedAxis (int axis)
 Set lockec axis. More...
 
void targetAddLink (int target, int link)
 Add link to target. More...
 
void targetRemoveAllLinks (int target)
 Remove all links from target. More...
 
- Public Member Functions inherited from AnimatorRule
void setEnabled (bool enabled)
 Set if rule is enabled. More...
 
void setBlendMode (int blendMode)
 Set blend mode. More...
 
void setBlendFactor (float blendFactor)
 Set blend factor clamped to the range from 0 to 1. More...
 
void addBone (String bone)
 Add bone. More...
 
void removeAllBones ()
 Remove all bones. More...
 
void copyBonesFrom (AnimatorRule rule)
 Copy all bones from another rule. More...
 

Static Public Attributes

Targets.
static final int TARGET_BLEND_FACTOR = 0
 Blend factor target. More...
 
static final int TARGET_POSITION = 1
 Position target. More...
 
static final int TARGET_UP = 2
 Up vector target. More...
 
Axis.
static final int AXIS_POS_X = 0
 Align to positive x axis. More...
 
static final int AXIS_POS_Y = 1
 Align to positive y axis. More...
 
static final int AXIS_POS_Z = 2
 Align to positive z axis. More...
 
static final int AXIS_NEG_X = 3
 Align to negative x axis. More...
 
static final int AXIS_NEG_Y = 4
 Align to negative y axis. More...
 
static final int AXIS_NEG_Z = 5
 Align to negative z axis. More...
 
Up axis.
static final int UP_WORLD_X = 0
 Use world x axis as up axis. More...
 
static final int UP_WORLD_Y = 1
 Use world y axis as up axis. More...
 
static final int UP_WORLD_Z = 2
 Use world z axis as up axis. More...
 
static final int UP_COMPOENT_X = 3
 Use component x axis as up axis. More...
 
static final int UP_COMPOENT_Y = 4
 Use component y axis as up axis. More...
 
static final int UP_COMPOENT_Z = 5
 Use component z axis as up axis. More...
 
static final int UP_TRACKBONE_X = 6
 Use track bone x axis as up axis. More...
 
static final int UP_TRACKBONE_Y = 7
 Use track bone y axis as up axis. More...
 
static final int UP_TRACKBONE_Z = 8
 Use track bone z axis as up axis. More...
 
static final int UP_CONTROLLER = 9
 Use controller vector as up axis. More...
 
Locked axis.
static final int LOCKED_AXIS_NONE = 0
 No axis is locked. More...
 
static final int LOCKED_AXIS_X = 1
 Lock x axis. More...
 
static final int LOCKED_AXIS_Y = 2
 Lock y axis. More...
 
static final int LOCKED_AXIS_Z = 3
 Lock z axis. More...
 
- Static Public Attributes inherited from AnimatorRule
static final int BLEND = 0
 Blend from the existing state over to the state produced by the rule. More...
 
static final int OVERLAY = 1
 Overlay the existing state with to the state produced by the rule. More...
 

Additional Inherited Members

- Protected Member Functions inherited from AnimatorRule
AnimatorRule new ()
 Create animator rule. More...
 

Detailed Description

Animator rule track to.

This is a native class. It can not be subclassed.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ new()

ARTrackTo new ( )

Create animator rule.

§ setLockedAxis()

void setLockedAxis ( int  axis)

Set lockec axis.

Exceptions
EInvalidParamaxis is not a valid value.

§ setTrackAxis()

void setTrackAxis ( int  axis)

Set track axis.

Exceptions
EInvalidParamaxis is not a valid value.

§ setTrackBone()

void setTrackBone ( String  bone)

Set track bone name or empty string to use none.

§ setUpAxis()

void setUpAxis ( int  axis)

Set up axis.

Exceptions
EInvalidParamaxis is not a valid value.

§ setUpTarget()

void setUpTarget ( int  target)

Set up target.

Exceptions
EInvalidParamtarget is not a valid value.

§ targetAddLink()

void targetAddLink ( int  target,
int  link 
)

Add link to target.

Exceptions
EInvalidParamtarget is not a valid value.

§ targetRemoveAllLinks()

void targetRemoveAllLinks ( int  target)

Remove all links from target.

Exceptions
EInvalidParamtarget is not a valid value.

Member Data Documentation

§ AXIS_NEG_X

final int AXIS_NEG_X = 3
static

Align to negative x axis.

§ AXIS_NEG_Y

final int AXIS_NEG_Y = 4
static

Align to negative y axis.

§ AXIS_NEG_Z

final int AXIS_NEG_Z = 5
static

Align to negative z axis.

§ AXIS_POS_X

final int AXIS_POS_X = 0
static

Align to positive x axis.

§ AXIS_POS_Y

final int AXIS_POS_Y = 1
static

Align to positive y axis.

§ AXIS_POS_Z

final int AXIS_POS_Z = 2
static

Align to positive z axis.

§ LOCKED_AXIS_NONE

final int LOCKED_AXIS_NONE = 0
static

No axis is locked.

§ LOCKED_AXIS_X

final int LOCKED_AXIS_X = 1
static

Lock x axis.

§ LOCKED_AXIS_Y

final int LOCKED_AXIS_Y = 2
static

Lock y axis.

§ LOCKED_AXIS_Z

final int LOCKED_AXIS_Z = 3
static

Lock z axis.

§ TARGET_BLEND_FACTOR

final int TARGET_BLEND_FACTOR = 0
static

Blend factor target.

§ TARGET_POSITION

final int TARGET_POSITION = 1
static

Position target.

§ TARGET_UP

final int TARGET_UP = 2
static

Up vector target.

§ UP_COMPOENT_X

final int UP_COMPOENT_X = 3
static

Use component x axis as up axis.

§ UP_COMPOENT_Y

final int UP_COMPOENT_Y = 4
static

Use component y axis as up axis.

§ UP_COMPOENT_Z

final int UP_COMPOENT_Z = 5
static

Use component z axis as up axis.

§ UP_CONTROLLER

final int UP_CONTROLLER = 9
static

Use controller vector as up axis.

§ UP_TRACKBONE_X

final int UP_TRACKBONE_X = 6
static

Use track bone x axis as up axis.

§ UP_TRACKBONE_Y

final int UP_TRACKBONE_Y = 7
static

Use track bone y axis as up axis.

§ UP_TRACKBONE_Z

final int UP_TRACKBONE_Z = 8
static

Use track bone z axis as up axis.

§ UP_WORLD_X

final int UP_WORLD_X = 0
static

Use world x axis as up axis.

§ UP_WORLD_Y

final int UP_WORLD_Y = 1
static

Use world y axis as up axis.

§ UP_WORLD_Z

final int UP_WORLD_Z = 2
static

Use world z axis as up axis.


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