unreal.IKRetargetRootMotionController

class unreal.IKRetargetRootMotionController(outer: Object | None = None, name: Name | str = 'None')

Bases: IKRetargetOpControllerBase

The blueprint/python API for editing a Root Motion Op

C++ Source:

• Plugin: IKRig

• Module: IKRig

• File: RootMotionGeneratorOp.h

get_settings() → IKRetargetRootMotionOpSettings

Get the current op settings as a struct.

Returns:

FIKRetargetRootMotionOpSettings struct with the current settings used by the op.

Return type:

IKRetargetRootMotionOpSettings

get_source_root_bone() → Name

Get the root bone for the source.

Returns:

the name of the root bone on the source skeleton.

Return type:

Name

get_target_pelvis_bone() → Name

Get the pelvis bone for the target.

Returns:

the name of the pelvis bone on the target skeleton.

Return type:

Name

get_target_root_bone() → Name

Get the root bone for the target.

Returns:

the name of the root bone on the target skeleton.

Return type:

Name

set_settings(settings) → None

Set the op settings. Input is a custom struct type for this op.

Parameters:

settings (IKRetargetRootMotionOpSettings) – a FIKRetargetRootMotionOpSettings struct containing all the settings to apply to this op

set_source_root_bone(source_root_bone) → None

Set the root bone for the source.

Parameters:

source_root_bone (Name) – the name of the root bone on the source skeleton.

set_target_pelvis_bone(target_pelvis_bone) → None

Set the pelvis bone for the target.

Parameters:

target_pelvis_bone (Name) – the name of the pelvis bone on the target skeleton.

set_target_root_bone(target_root_bone) → None

Set the root bone for the target.

Parameters:

target_root_bone (Name) – the name of the root bone on the target skeleton.