unreal.PelvisSettings

class unreal.PelvisSettings(pelvis_bone: RigElementKey = Ellipsis, position_damping_half_life: float = 0.0, rotation_stiffness: float = 0.0, rotation_damping: float = 0.0, lead_amount: float = 0.0, lead_damping_half_life: float = 0.0, bob_offset: float = 0.0, bob_stiffness: float = 0.0, bob_damping: float = 0.0, orient_to_ground_pitch: float = 0.0, orient_to_ground_roll: float = 0.0)

Bases: StructBase

Pelvis Settings

C++ Source:

  • Plugin: Locomotor

  • Module: Locomotor

  • File: RigUnit_Locomotor.h

Editor Properties: (see get_editor_property/set_editor_property)

  • bob_damping (float): [Read-Write] Default is 0.9. Typical range is 0-2. Higher values cause pelvis bob to dampen quickly.

  • bob_offset (float): [Read-Write] Default is 10.f. Range is 0-inf. The amount to lower the pelvis at the minimum height in the cycle.

  • bob_stiffness (float): [Read-Write] Default is 40.0. Typical range is 1-100. Higher values cause pelvis to bob more rapidly towards target height.

  • lead_amount (float): [Read-Write] Default is 2.0. Typical range is 1-3. Higher values cause pelvis to move further ahead of the feet.

  • lead_damping_half_life (float): [Read-Write] Default is 0.1. Typical range is 0.1-1. The time (in seconds) it takes for the Pelvis to reach half way to it’s lead goal.

  • orient_to_ground_pitch (float): [Read-Write] Default is -0.3. Typical range is -1 to 1. Pitch the pelvis up/down with ground. 0 is no effect, 1/-1 matches ground orientation. Use negative values for bipeds, positive for quadrupeds.

  • orient_to_ground_roll (float): [Read-Write] Default is -0.3. Typical range is -1 to 1. Roll the pelvis side-to-side with ground. 0 is no effect, 1/-1 matches ground orientation. Use negative values for bipeds, positive for quadrupeds.

  • pelvis_bone (RigElementKey): [Read-Write] Usually the Pelvis or Hip bone. The bone that translates the whole body (not necessarily the root of the entire hierarchy).

  • position_damping_half_life (float): [Read-Write] Default is 0.1. Typical range is 0.1-1. The time (in seconds) it takes for the Pelvis to reach half way to it’s goal.

  • rotation_damping (float): [Read-Write] Default is 2.0. Typical range is 0-2. Higher values cause pelvis rotation to dampen quickly.

  • rotation_stiffness (float): [Read-Write] Default is 40.0. Typical range is 1-100. Higher values cause pelvis to rotate more rapidly towards goal orientation.

property bob_damping: float

[Read-Write] Default is 0.9. Typical range is 0-2. Higher values cause pelvis bob to dampen quickly.

Type:

(float)

property bob_offset: float

[Read-Write] Default is 10.f. Range is 0-inf. The amount to lower the pelvis at the minimum height in the cycle.

Type:

(float)

property bob_stiffness: float

[Read-Write] Default is 40.0. Typical range is 1-100. Higher values cause pelvis to bob more rapidly towards target height.

Type:

(float)

property lead_amount: float

[Read-Write] Default is 2.0. Typical range is 1-3. Higher values cause pelvis to move further ahead of the feet.

Type:

(float)

property lead_damping_half_life: float

[Read-Write] Default is 0.1. Typical range is 0.1-1. The time (in seconds) it takes for the Pelvis to reach half way to it’s lead goal.

Type:

(float)

property orient_to_ground_pitch: float

[Read-Write] Default is -0.3. Typical range is -1 to 1. Pitch the pelvis up/down with ground. 0 is no effect, 1/-1 matches ground orientation. Use negative values for bipeds, positive for quadrupeds.

Type:

(float)

property orient_to_ground_roll: float

[Read-Write] Default is -0.3. Typical range is -1 to 1. Roll the pelvis side-to-side with ground. 0 is no effect, 1/-1 matches ground orientation. Use negative values for bipeds, positive for quadrupeds.

Type:

(float)

property pelvis_bone: RigElementKey

[Read-Write] Usually the Pelvis or Hip bone. The bone that translates the whole body (not necessarily the root of the entire hierarchy).

Type:

(RigElementKey)

property position_damping_half_life: float

[Read-Write] Default is 0.1. Typical range is 0.1-1. The time (in seconds) it takes for the Pelvis to reach half way to it’s goal.

Type:

(float)

property rotation_damping: float

[Read-Write] Default is 2.0. Typical range is 0-2. Higher values cause pelvis rotation to dampen quickly.

Type:

(float)

property rotation_stiffness: float

[Read-Write] Default is 40.0. Typical range is 1-100. Higher values cause pelvis to rotate more rapidly towards goal orientation.

Type:

(float)