unreal.IKRetargetFilterBoneController

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

Bases: IKRetargetOpControllerBase

The blueprint/python API for editing a Filter Bone Op

C++ Source:

• Plugin: IKRig

• Module: IKRig

• File: FilterBoneOp.h

add_bone_to_filter(target_bone) → None

Add a target bone to filter.

Parameters:

target_bone (Name)

clear_bones_to_filter() → None

Clear all the bones

get_all_bones_to_filter() → Array[Name]

Get all the bones currently stored in the op.

Returns:

an array of target bone names

Return type:

Array[Name]

get_settings() → IKRetargetFilterBoneOpSettings

Get the current op settings as a struct.

Returns:

FIKRetargetPinBoneOpSettings struct with the current settings used by the op.

Return type:

IKRetargetFilterBoneOpSettings

set_settings(settings) → None

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

Parameters:

settings (IKRetargetFilterBoneOpSettings) – a FIKRetargetPinBoneOpSettings struct containing all the settings to apply to this op