Joint aim

joint

string

yes

The joint name.

axis

int

yes

The joint axis aiming to the target. 0: X 1:Y 2:Z 3:-X 4:-Y 5:-Z 6:Custom Axis 7: Direction between 2 joints

customAxis

vector3

yes

Custom axis used when axis == 6

hierarchyPropagation

int

yes

When greater than 0, it will propagate the rotation up in the parent chain.

target

vector3

yes

The target position.

upAxis

int

yes

The joint up axis index.

useUpVectorMetadata

bool

yes

Use the up vector metadata instead of the up vector attribute of this module.

upVector

vector3

yes

The up vector.

weight

double

yes

Weight.

additiveMode

bool

yes

If true, the original joint animation will be applied after the joint is rotated.

additiveWeight

double

yes

The original joint animation weight.

projectAxis

bool

yes

If true, the axis are projected onto the ground, so the rotation happen along the world up vector

projectForward

bool

yes

If the target is behind the agent, then it is projected in front of the current agent using its direction.

startJoint

string

yes

The start joint used to compute the direction used as axis

endJoint

string

yes

The end joint used to compute the direction used as axis

useOperator

bool

yes

If true, the transformation will be applied by an operator instead of the module itself at the endFrame stage.

This option should be enabled when a joint aim module is used on an agent group using other modules

actively modifying the pose with an operator and not at the endFrame stage(i.e.Sync)