unreal.IKRetargetPinBoneOpSettings

class unreal.IKRetargetPinBoneOpSettings(lod_threshold: int = 0, bones_to_pin: None = [], skeleton_to_copy_from: RetargetSourceOrTarget = Ellipsis, copy_translation: bool = False, translation_mode: PinBoneTranslationMode = Ellipsis, copy_rotation: bool = False, rotation_mode: PinBoneRotationMode = Ellipsis, copy_scale: bool = False, global_offset: Transform = Ellipsis, local_offset: Transform = Ellipsis)

Bases: IKRetargetOpSettingsBase

IKRetarget Pin Bone Op Settings

C++ Source:

  • Plugin: IKRig

  • Module: IKRig

  • File: PinBoneOp.h

Editor Properties: (see get_editor_property/set_editor_property)

  • bones_to_pin (Array[PinBoneData]): [Read-Write] A list of bone-pairs to copy transforms between

  • copy_rotation (bool): [Read-Write] Copy the rotation of the bone.

  • copy_scale (bool): [Read-Write] Copy the scale of the bone.

  • copy_translation (bool): [Read-Write] Copy the translation of the bone.

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

  • local_offset (Transform): [Read-Write] A manual offset to apply in local space

  • 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.

  • propagate_to_children (bool): [Read-Write] Update children bone transforms (recursively).

  • rotation_mode (PinBoneRotationMode): [Read-Write] The method used to calculate the rotation of the bone.

  • skeleton_to_copy_from (RetargetSourceOrTarget): [Read-Write] Which skeleton to copy animation from.

  • translation_mode (PinBoneTranslationMode): [Read-Write] The method used to calculate the translation of the bone.

property bones_to_pin: None

[Read-Write] A list of bone-pairs to copy transforms between

Type:

(Array[PinBoneData])

property copy_rotation: bool

[Read-Write] Copy the rotation of the bone.

Type:

(bool)

property copy_scale: bool

[Read-Write] Copy the scale of the bone.

Type:

(bool)

property copy_translation: bool

[Read-Write] Copy the translation of the bone.

Type:

(bool)

property global_offset: Transform

[Read-Write] A manual offset to apply in global space

Type:

(Transform)

property local_offset: Transform

[Read-Write] A manual offset to apply in local space

Type:

(Transform)

property rotation_mode: PinBoneRotationMode

[Read-Write] The method used to calculate the rotation of the bone.

Type:

(PinBoneRotationMode)

property skeleton_to_copy_from: RetargetSourceOrTarget

[Read-Write] Which skeleton to copy animation from.

Type:

(RetargetSourceOrTarget)

property translation_mode: PinBoneTranslationMode

[Read-Write] The method used to calculate the translation of the bone.

Type:

(PinBoneTranslationMode)