unreal.IKRetargetRootMotionOpSettings

class unreal.IKRetargetRootMotionOpSettings(lod_threshold: int = 0, root_motion_source: RootMotionSource = Ellipsis, rotate_with_pelvis: bool = False, root_height_source: RootMotionHeightSource = Ellipsis, global_offset: Transform = Ellipsis, maintain_offset_from_pelvis: bool = False, propagate_to_non_retargeted_children: bool = False)

Bases: IKRetargetOpSettingsBase

IKRetarget Root Motion Op Settings

C++ Source:

  • Plugin: IKRig

  • Module: IKRig

  • File: RootMotionGeneratorOp.h

Editor Properties: (see get_editor_property/set_editor_property)

  • global_offset (Transform): [Read-Write] A manual offset to apply in global space to the root bone.

  • lod_threshold (int32): [Read-Write] The maximum LOD that this Op is allowed to run at. For example if you have LODThreshold of 2, the Op will run until LOD 2 (based on 0 index). When the component LOD becomes 3, it will stop running. A value of -1 forces the Op to execute at all LOD levels. Default is -1.

  • maintain_offset_from_pelvis (bool): [Read-Write] Applies only when generating root motion from the Pelvis. Maintains the offset between the root and pelvis as recorded in the target retarget pose. If false, the root bone is placed directly under the Pelvis bone.

  • propagate_to_non_retargeted_children (bool): [Read-Write] Will transform all children of the target root that are not themselves part of a retarget chain.

  • root_height_source (RootMotionHeightSource): [Read-Write] How to set the height of the root bone. Copy Height From Source: copies the height of the root bone on the source skeleton’s root bone. Snap To Ground: sets the root bone height to the ground plane (Z=0).

  • root_motion_source (RootMotionSource): [Read-Write] Where to copy the root motion from. Copy From Source Root: copies the motion from the source root bone, but scales it according to relative height difference. Generate From Target Pelvis: uses the retargeted Pelvis motion to generate root motion. NOTE: Generating root motion from the Pelvis

  • rotate_with_pelvis (bool): [Read-Write] Applies only when generating root motion from the Pelvis. When true, the applied offset will be rotated by the Pelvis. (NOTE: This may cause unwanted rotations, for example if Pelvis Yaw is animated.)

  • source_root (BoneReference): [Read-Write] The root of the source skeleton.

  • source_root_bone (Name): [Read-Write] Changed to FBoneReference to support bone selector UI deprecated: Property ‘SourceRootBone’ is deprecated.

  • target_pelvis (BoneReference): [Read-Write] The pelvis of the target skeleton. Only used when “Root Motion Source” is set to target pelvis.

  • target_pelvis_bone (Name): [Read-Write] deprecated: Property ‘TargetPelvisBone’ is deprecated.

  • target_root (BoneReference): [Read-Write] The root of the target skeleton.

  • target_root_bone (Name): [Read-Write] deprecated: Property ‘TargetRootBone’ is deprecated.

property global_offset: Transform

[Read-Write] A manual offset to apply in global space to the root bone.

Type:

(Transform)

property maintain_offset_from_pelvis: bool

[Read-Write] Applies only when generating root motion from the Pelvis. Maintains the offset between the root and pelvis as recorded in the target retarget pose. If false, the root bone is placed directly under the Pelvis bone.

Type:

(bool)

property propagate_to_non_retargeted_children: bool

[Read-Write] Will transform all children of the target root that are not themselves part of a retarget chain.

Type:

(bool)

property root_height_source: RootMotionHeightSource

[Read-Write] How to set the height of the root bone. Copy Height From Source: copies the height of the root bone on the source skeleton’s root bone. Snap To Ground: sets the root bone height to the ground plane (Z=0).

Type:

(RootMotionHeightSource)

property root_motion_source: RootMotionSource

[Read-Write] Where to copy the root motion from. Copy From Source Root: copies the motion from the source root bone, but scales it according to relative height difference. Generate From Target Pelvis: uses the retargeted Pelvis motion to generate root motion. NOTE: Generating root motion from the Pelvis

Type:

(RootMotionSource)

property rotate_with_pelvis: bool

[Read-Write] Applies only when generating root motion from the Pelvis. When true, the applied offset will be rotated by the Pelvis. (NOTE: This may cause unwanted rotations, for example if Pelvis Yaw is animated.)

Type:

(bool)

property source_root_bone: Name

[Read-Write] Changed to FBoneReference to support bone selector UI deprecated: Property ‘SourceRootBone’ is deprecated.

Type:

(Name)

property target_pelvis_bone: Name

[Read-Write] deprecated: Property ‘TargetPelvisBone’ is deprecated.

Type:

(Name)

property target_root_bone: Name

[Read-Write] deprecated: Property ‘TargetRootBone’ is deprecated.

Type:

(Name)