unreal.IKRetargetCopyBasePoseController

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

Bases: IKRetargetOpControllerBase

The blueprint/python API for editing a Copy Base Pose Op

C++ Source:

• Plugin: IKRig

• Module: IKRig

• File: CopyBasePoseOp.h

add_bone_to_exclude(bone_name) → None

Add a bone to the “BonesToExclude” array

Parameters:

bone_name (Name)

get_bones_to_exclude() → Array[Name]

Get an array of all the excluded bones.

Return type:

Array[Name]

get_copy_from_start() → Name

Get the name of the bone to use as the “Copy From Start” in the op

Return type:

Name

get_settings() → IKRetargetCopyBasePoseOpSettings

Get the current op settings as a struct.

Returns:

FIKRetargetCopyBasePoseOpSettings struct with the current settings used by the op.

Return type:

IKRetargetCopyBasePoseOpSettings

reset_bones_to_exclude() → None

Reset the array of Bones to Exclude

set_copy_from_start(bone_name) → None

Set the name of the bone to use as the “Copy From Start” in the op

Parameters:

bone_name (Name)

set_settings(settings) → None

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

Parameters:

settings (IKRetargetCopyBasePoseOpSettings) – a FIKRetargetCopyBasePoseOpSettings struct containing all the settings to apply to this op