unreal.RigControlSettings

class unreal.RigControlSettings(control_type=RigControlType.EULER_TRANSFORM, display_name='None', primary_axis=RigControlAxis.X, animatable=True, limit_enabled=[], draw_limits=True, minimum_value=[], maximum_value=[], shape_enabled=True, shape_visible=True, shape_name='Default', shape_color=[1.0, 0.0, 0.0, 1.0], is_transient_control=False, control_enum=None, customization=[[], []])

Bases: unreal.StructBase

Rig Control Settings

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: RigHierarchyElements.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 4transient and only visible in the control rig editor

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

  • customization (RigControlElementCustomization): [Read-Write] Customization: The User interface customization used for a control This will be used as the default content for the space picker and other widgets

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

  • draw_limits (bool): [Read-Write] Draw Limits: True if the limits should be drawn in debug. For this to be enabled you need to have at least one min and max limit turned on.

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

  • limit_enabled (Array(RigControlLimitEnabled)): [Read-Write] Limit Enabled: True if the control has 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

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

  • shape_color (LinearColor): [Read-Write] Shape Color

  • shape_enabled (bool): [Read-Write] Shape Enabled: Set to true if the shape is enabled in 3d

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

  • shape_visible (bool): [Read-Write] Shape Visible: Set to true if the shape is currently visible in 3d

property animatable

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

Type

(bool)

property b_gizmo_enabled

‘b_gizmo_enabled’ was renamed to ‘shape_enabled’.

Type

deprecated

property b_gizmo_visible

‘b_gizmo_visible’ was renamed to ‘shape_visible’.

Type

deprecated

property control_enum

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

Type

(Enum)

property control_type

[Read-Write] Control Type

Type

(RigControlType)

property customization

[Read-Only] Customization: The User interface customization used for a control This will be used as the default content for the space picker and other widgets

Type

(RigControlElementCustomization)

property display_name

[Read-Write] Display Name

Type

(Name)

property draw_limits

[Read-Write] Draw Limits: True if the limits should be drawn in debug. For this to be enabled you need to have at least one min and max limit turned on.

Type

(bool)

property gizmo_color

‘gizmo_color’ was renamed to ‘shape_color’.

Type

deprecated

property gizmo_name

‘gizmo_name’ was renamed to ‘shape_name’.

Type

deprecated

property is_transient_control

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

Type

(bool)

property limit_enabled

[Read-Write] Limit Enabled: True if the control has limits.

Type

(Array(RigControlLimitEnabled))

property maximum_value

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

Type

(RigControlValue)

property minimum_value

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

Type

(RigControlValue)

property primary_axis

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

Type

(RigControlAxis)

property shape_color

[Read-Write] Shape Color

Type

(LinearColor)

property shape_enabled

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

Type

(bool)

property shape_name

[Read-Write] Shape 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 shape_visible

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

Type

(bool)