`unreal.RigControlSettings`¶

class unreal.RigControlSettings(animation_type: RigControlAnimationType = Ellipsis, control_type: RigControlType = Ellipsis, display_name: Name = 'None', primary_axis: RigControlAxis = Ellipsis, limit_enabled: Array[RigControlLimitEnabled] = [], draw_limits: bool = False, minimum_value: RigControlValue = [], maximum_value: RigControlValue = [], shape_visible: bool = False, shape_visibility: RigControlVisibility = Ellipsis, shape_name: Name = 'None', shape_color: LinearColor = Ellipsis, is_transient_control: bool = False, control_enum: Enum = Ellipsis, customization: RigControlElementCustomization = Ellipsis, driven_controls: Array[RigElementKey] = [], group_with_parent_control: bool = False)¶

Bases: 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: Deprecated properties. deprecated: Use animation_type instead.
animation_type (RigControlAnimationType): [Read-Write] Animation Type
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.
driven_controls (Array[RigElementKey]): [Read-Write] Driven Controls: The list of driven controls for this proxy control.
group_with_parent_control (bool): [Read-Write] Group with Parent Control: If set to true the animation channel will be grouped with the parent control in sequencer
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 deprecated: Use animation_type or shape_visible instead.
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_visibility (RigControlVisibility): [Read-Write] Shape Visibility: Defines how the shape visibility should be changed
shape_visible (bool): [Read-Write] Shape Visible: Set to true if the shape is currently visible in 3d

property animatable: bool¶

[Read-Write] Animatable: Deprecated properties. deprecated: Use animation_type instead.

Type:: (bool)

property animation_type: RigControlAnimationType¶

[Read-Write] Animation Type

Type:: (RigControlAnimationType)

property b_gizmo_enabled: bool¶

‘b_gizmo_enabled’ was renamed to ‘shape_enabled’.

Type:: deprecated

property b_gizmo_visible: bool¶

‘b_gizmo_visible’ was renamed to ‘shape_visible’.

Type:: deprecated

property control_enum: Enum¶

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

Type:: (Enum)

property control_type: RigControlType¶

[Read-Write] Control Type

Type:: (RigControlType)

property customization: RigControlElementCustomization¶

[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: Name¶

[Read-Write] Display Name

Type:: (Name)

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