unreal.RigControlElement

class unreal.RigControlElement(key: RigElementKey = Ellipsis, index: int = 0, sub_index: int = 0, selected: bool = False, created_at_instruction_index: int = 0, pose: RigCurrentAndInitialTransform = Ellipsis, settings: RigControlSettings = Ellipsis, offset: RigCurrentAndInitialTransform = Ellipsis, shape: RigCurrentAndInitialTransform = Ellipsis, preferred_euler_angles: RigPreferredEulerAngles = Ellipsis)

Bases: RigMultiParentElement

Rig Control Element

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: RigHierarchyElements.h

Editor Properties: (see get_editor_property/set_editor_property)

  • created_at_instruction_index (int32): [Read-Write] Created at Instruction Index

  • index (int32): [Read-Only] Index

  • key (RigElementKey): [Read-Only] Key

  • offset (RigCurrentAndInitialTransform): [Read-Write] Offset

  • pose (RigCurrentAndInitialTransform): [Read-Write] Pose

  • preferred_euler_angles (RigPreferredEulerAngles): [Read-Write] Preferred Euler Angles

  • selected (bool): [Read-Write] Selected

  • settings (RigControlSettings): [Read-Write] Settings

  • shape (RigCurrentAndInitialTransform): [Read-Write] Shape

  • sub_index (int32): [Read-Only] Sub Index

property gizmo: RigCurrentAndInitialTransform

‘gizmo’ was renamed to ‘shape’.

Type:

deprecated

property offset: RigCurrentAndInitialTransform

[Read-Only] Offset

Type:

(RigCurrentAndInitialTransform)

property preferred_euler_angles: RigPreferredEulerAngles

[Read-Only] Preferred Euler Angles

Type:

(RigPreferredEulerAngles)

property settings: RigControlSettings

[Read-Only] Settings

Type:

(RigControlSettings)

property shape: RigCurrentAndInitialTransform

[Read-Only] Shape

Type:

(RigCurrentAndInitialTransform)