IKModifier3D

A node for inverse kinematics which may modify more than one bone.

1.0.0

class IKModifier3DReckfellSharpInherits SkeletonModifier3D

A node for inverse kinematics which may modify more than one bone.

Base class of SkeletonModifier3Ds that has some joint lists and applies inverse kinematics. This class has some structs, enums, and helper methods which are useful to solve inverse kinematics.

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

Properties1

MutableBoneAxesProperty

# MutableBoneAxes

C#
public bool MutableBoneAxes { get; set; }

If true, the solver retrieves the bone axis from the bone pose every frame. If false, the solver retrieves the bone axis from the bone rest and caches it, which increases performance slightly, but position changes in the bone pose made before processing this IKModifier3D are ignored. Note: The rendered gizmo's forward vector (a line between parent and child joints) will only respect the bone pose when this modifier is active.

Methods6

AreBoneAxesMutablebool

# AreBoneAxesMutable

C#
public bool AreBoneAxesMutable();

Returns bool

ClearSettingsvoid

# ClearSettings

C#
public void ClearSettings();

Clears all settings.

GetSettingCountint

# GetSettingCount

C#
public int GetSettingCount();

Returns the number of settings.

Returns int

Resetvoid

# Reset

C#
public void Reset();

Resets a state with respect to the current bone pose.

SetMutableBoneAxesvoid

# SetMutableBoneAxes

C#
public void SetMutableBoneAxes(bool enabled);

Parameters
Name	Type	Default
`enabled`	`bool`	—

SetSettingCountvoid

# SetSettingCount

C#
public void SetSettingCount(int count);

Sets the number of settings.

Parameters
Name	Type	Default
`count`	`int`	—

Reckfell Engine documentationBack to top ↑