AimModifier3D — C# API

class AimModifier3DReckfellSharpInherits BoneConstraint3D

The AimModifier3D rotates a bone to look at a reference bone.

This is a simple version of LookAtModifier3D that only allows bone to the reference without advanced options such as angle limitation or time-based interpolation. The feature is simplified, but instead it is implemented with smooth tracking without euler, see AimModifier3D.SetUseEuler.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

AimModifier3DConstructor

# AimModifier3D

C#
public AimModifier3D();

Properties1

SettingCountProperty

# SettingCount

C#
public int SettingCount { get; set; }

The number of settings in the modifier.

Methods10

GetForwardAxisSkeletonModifier3D.BoneAxis

# GetForwardAxis

C#
public SkeletonModifier3D.BoneAxis GetForwardAxis(int index);

Returns the forward axis of the bone.

Parameters
Name	Type	Default
`index`	`int`	—

Returns SkeletonModifier3D.BoneAxis

GetPrimaryRotationAxisVector3.Axis

# GetPrimaryRotationAxis

C#
public Vector3.Axis GetPrimaryRotationAxis(int index);

Returns the axis of the first rotation. It is enabled only if AimModifier3D.IsUsingEuler is true.

Parameters
Name	Type	Default
`index`	`int`	—

Returns Vector3.Axis

IsRelativebool

# IsRelative

C#
public bool IsRelative(int index);

Returns true if the relative option is enabled in the setting at index.

Parameters
Name	Type	Default
`index`	`int`	—

Returns bool

IsUsingEulerbool

# IsUsingEuler

C#
public bool IsUsingEuler(int index);

Returns true if it provides rotation with using euler.

Parameters
Name	Type	Default
`index`	`int`	—

Returns bool

IsUsingSecondaryRotationbool

# IsUsingSecondaryRotation

C#
public bool IsUsingSecondaryRotation(int index);

Returns true if it provides rotation by two axes. It is enabled only if AimModifier3D.IsUsingEuler is true.

Parameters
Name	Type	Default
`index`	`int`	—

Returns bool

SetForwardAxisvoid

# SetForwardAxis

C#
public void SetForwardAxis(int index, SkeletonModifier3D.BoneAxis axis);

Sets the forward axis of the bone.

Parameters
Name	Type	Default
`index`	`int`	—
`axis`	`SkeletonModifier3D.BoneAxis`	—

SetPrimaryRotationAxisvoid

# SetPrimaryRotationAxis

C#
public void SetPrimaryRotationAxis(int index, Vector3.Axis axis);

Sets the axis of the first rotation. It is enabled only if AimModifier3D.IsUsingEuler is true.

Parameters
Name	Type	Default
`index`	`int`	—
`axis`	`Vector3.Axis`	—

SetRelativevoid

# SetRelative

C#
public void SetRelative(int index, bool enabled);

Sets relative option in the setting at index to enabled. If sets enabled to true, the rotation is applied relative to the pose. If sets enabled to false, the rotation is applied relative to the rest. It means to replace the current pose with the AimModifier3D's result.

Parameters
Name	Type	Default
`index`	`int`	—
`enabled`	`bool`	—

SetUseEulervoid

# SetUseEuler

C#
public void SetUseEuler(int index, bool enabled);

If sets enabled to true, it provides rotation with using euler. If sets enabled to false, it provides rotation with using rotation by arc generated from the forward axis vector and the vector toward the reference.

Parameters
Name	Type	Default
`index`	`int`	—
`enabled`	`bool`	—

SetUseSecondaryRotationvoid

# SetUseSecondaryRotation

C#
public void SetUseSecondaryRotation(int index, bool enabled);

If sets enabled to true, it provides rotation by two axes. It is enabled only if AimModifier3D.IsUsingEuler is true.

Parameters
Name	Type	Default
`index`	`int`	—
`enabled`	`bool`	—