unreal.RigControl

class unreal.RigControl(name: Name = 'None', index: int = 0, control_type: RigControlType = Ellipsis, display_name: Name = 'None', parent_name: Name = 'None', parent_index: int = 0, space_name: Name = 'None', space_index: int = 0, offset_transform: Transform = Ellipsis, initial_value: RigControlValue = [], value: RigControlValue = [], primary_axis: RigControlAxis = Ellipsis, animatable: bool = False, limit_translation: bool = False, limit_rotation: bool = False, limit_scale: bool = False, draw_limits: bool = False, minimum_value: RigControlValue = [], maximum_value: RigControlValue = [], gizmo_enabled: bool = False, gizmo_visible: bool = False, gizmo_name: Name = 'None', gizmo_transform: Transform = Ellipsis, gizmo_color: LinearColor = Ellipsis, is_transient_control: bool = False, control_enum: Enum = Ellipsis)

Bases: RigElement

Rig Control

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: RigControlHierarchy.h

Editor Properties: (see get_editor_property/set_editor_property)

  • animatable (bool): [Read-Write] Animatable: If the control is animatable in sequencer

  • control_enum (Enum): [Read-Write] Control Enum: If the control is transient and only visible in the control rig editor

  • control_type (RigControlType): [Read-Write] Control Type

  • display_name (Name): [Read-Write] Display Name

  • draw_limits (bool): [Read-Write] Draw Limits: True if the limits should be drawn in debug.

  • gizmo_color (LinearColor): [Read-Write] Gizmo Color

  • gizmo_enabled (bool): [Read-Write] Gizmo Enabled: Set to true if the gizmo is enabled in 3d

  • gizmo_name (Name): [Read-Write] Gizmo Name: This is optional UI setting - this doesn’t mean this is always used, but it is optional for manipulation layer to use this

  • gizmo_transform (Transform): [Read-Write] Gizmo Transform

  • gizmo_visible (bool): [Read-Write] Gizmo Visible: Set to true if the gizmo is currently visible in 3d

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

  • initial_value (RigControlValue): [Read-Only] Initial Value: The value that a control is reset to during begin play or when the control rig is instantiated.

  • is_transient_control (bool): [Read-Write] Is Transient Control: If the control is transient and only visible in the control rig editor

  • limit_rotation (bool): [Read-Write] Limit Rotation: True if the control has to obey rotation limits.

  • limit_scale (bool): [Read-Write] Limit Scale: True if the control has to obey scale limits.

  • limit_translation (bool): [Read-Write] Limit Translation: True if the control has to obey translation limits.

  • maximum_value (RigControlValue): [Read-Write] Maximum Value: The maximum limit of the control’s value

  • minimum_value (RigControlValue): [Read-Write] Minimum Value: The minimum limit of the control’s value

  • name (Name): [Read-Write] Name

  • offset_transform (Transform): [Read-Write] Offset Transform: Used to offset a control in global space. This can be useful to offset a float control by rotating it or translating it.

  • parent_index (int32): [Read-Write] Parent Index

  • parent_name (Name): [Read-Only] Parent Name

  • primary_axis (RigControlAxis): [Read-Write] Primary Axis: the primary axis to use for float controls

  • space_index (int32): [Read-Write] Space Index

  • space_name (Name): [Read-Only] Space Name

  • value (RigControlValue): [Read-Only] Value: The current value of the control.

property animatable: bool

[Read-Write] Animatable: If the control is animatable in sequencer

Type:

(bool)

property control_enum: Enum

[Read-Only] Control Enum: If the control is transient and only visible in the control rig editor

Type:

(Enum)

property control_type: RigControlType

[Read-Write] Control Type

Type:

(RigControlType)

property display_name: Name

[Read-Write] Display Name

Type:

(Name)

property draw_limits: bool

[Read-Write] Draw Limits: True if the limits should be drawn in debug.

Type:

(bool)

property gizmo_color: LinearColor

[Read-Write] Gizmo Color

Type:

(LinearColor)

property gizmo_enabled: bool

[Read-Write] Gizmo Enabled: Set to true if the gizmo is enabled in 3d

Type:

(bool)

property gizmo_name: Name

[Read-Write] Gizmo Name: This is optional UI setting - this doesn’t mean this is always used, but it is optional for manipulation layer to use this

Type:

(Name)

property gizmo_transform: Transform

[Read-Write] Gizmo Transform

Type:

(Transform)

property gizmo_visible: bool

[Read-Write] Gizmo Visible: Set to true if the gizmo is currently visible in 3d

Type:

(bool)

property initial_value: RigControlValue

[Read-Only] Initial Value: The value that a control is reset to during begin play or when the control rig is instantiated.

Type:

(RigControlValue)

property is_transient_control: bool

[Read-Write] Is Transient Control: If the control is transient and only visible in the control rig editor

Type:

(bool)

property limit_rotation: bool

[Read-Write] Limit Rotation: True if the control has to obey rotation limits.

Type:

(bool)

property limit_scale: bool

[Read-Write] Limit Scale: True if the control has to obey scale limits.

Type:

(bool)

property limit_translation: bool

[Read-Write] Limit Translation: True if the control has to obey translation limits.

Type:

(bool)

property maximum_value: RigControlValue

[Read-Write] Maximum Value: The maximum limit of the control’s value

Type:

(RigControlValue)

property minimum_value: RigControlValue

[Read-Write] Minimum Value: The minimum limit of the control’s value

Type:

(RigControlValue)

property offset_transform: Transform

[Read-Write] Offset Transform: Used to offset a control in global space. This can be useful to offset a float control by rotating it or translating it.

Type:

(Transform)

property parent_index: int

[Read-Only] Parent Index

Type:

(int32)

property parent_name: Name

[Read-Only] Parent Name

Type:

(Name)

property primary_axis: RigControlAxis

[Read-Write] Primary Axis: the primary axis to use for float controls

Type:

(RigControlAxis)

property space_index: int

[Read-Only] Space Index

Type:

(int32)

property space_name: Name

[Read-Only] Space Name

Type:

(Name)

property value: RigControlValue

[Read-Only] Value: The current value of the control.

Type:

(RigControlValue)