unreal.RigControlSettings

class unreal.RigControlSettings(animation_type: RigControlAnimationType = Ellipsis, control_type: RigControlType = Ellipsis, display_name: Name = 'None', primary_axis: RigControlAxis = Ellipsis, limit_enabled: None = [], 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: None = [], group_with_parent_control: bool = False, restrict_space_switching: bool = False, filtered_channels: None = [], preferred_rotation_order: EulerRotationOrder = Ellipsis, use_preferred_rotation_order: 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] Deprecated properties. deprecated: Use animation_type instead.

  • animation_type (RigControlAnimationType): [Read-Write]

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

  • control_type (RigControlType): [Read-Write]

  • customization (RigControlElementCustomization): [Read-Write] 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]

  • draw_limits (bool): [Read-Write] 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] The list of driven controls for this proxy control.

  • filtered_channels (Array[RigControlTransformChannel]): [Read-Write] Filtered Visible Transform channels. If this is empty everything is visible

  • group_with_parent_control (bool): [Read-Write] If set to true the animation channel will be grouped with the parent control in sequencer

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

  • limit_enabled (Array[RigControlLimitEnabled]): [Read-Write] True if the control has limits.

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

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

  • preferred_rotation_order (EulerRotationOrder): [Read-Write] The euler rotation order this control prefers for animation, if we aren’t using default UE rotator

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

  • restrict_space_switching (bool): [Read-Write] Allow to space switch only to the available spaces

  • shape_color (LinearColor): [Read-Write]

  • shape_enabled (bool): [Read-Write] deprecated: Use animation_type or shape_visible instead.

  • shape_name (Name): [Read-Write] 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] Defines how the shape visibility should be changed

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

  • use_preferred_rotation_order (bool): [Read-Write] Whether to use a specfied rotation order or just use the default FRotator order and conversion functions

property animatable: bool

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

Type:

(bool)

property animation_type: RigControlAnimationType

[Read-Write]

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] If the control is 4transient and only visible in the control rig editor

Type:

(Enum)

property control_type: RigControlType

[Read-Write]

Type:

(RigControlType)

property customization: RigControlElementCustomization

[Read-Only] 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]

Type:

(Name)

property draw_limits: bool

[Read-Write] 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 driven_controls: None

[Read-Only] The list of driven controls for this proxy control.

Type:

(Array[RigElementKey])

property filtered_channels: None

[Read-Only] Filtered Visible Transform channels. If this is empty everything is visible

Type:

(Array[RigControlTransformChannel])

property gizmo_color: LinearColor

‘gizmo_color’ was renamed to ‘shape_color’.

Type:

deprecated

property gizmo_name: Name

‘gizmo_name’ was renamed to ‘shape_name’.

Type:

deprecated

property group_with_parent_control: bool

[Read-Only] If set to true the animation channel will be grouped with the parent control in sequencer

Type:

(bool)

property is_transient_control: bool

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

Type:

(bool)

property limit_enabled: None

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

Type:

(Array[RigControlLimitEnabled])

property maximum_value: RigControlValue

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

Type:

(RigControlValue)

property minimum_value: RigControlValue

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

Type:

(RigControlValue)

property preferred_rotation_order: EulerRotationOrder

[Read-Only] The euler rotation order this control prefers for animation, if we aren’t using default UE rotator

Type:

(EulerRotationOrder)

property primary_axis: RigControlAxis

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

Type:

(RigControlAxis)

property restrict_space_switching: bool

[Read-Only] Allow to space switch only to the available spaces

Type:

(bool)

property shape_color: LinearColor

[Read-Write]

Type:

(LinearColor)

property shape_enabled: bool

[Read-Write] deprecated: Use animation_type or shape_visible instead.

Type:

(bool)

property shape_name: Name

[Read-Write] 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_visibility: RigControlVisibility

[Read-Write] Defines how the shape visibility should be changed

Type:

(RigControlVisibility)

property shape_visible: bool

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

Type:

(bool)

property use_preferred_rotation_order: bool

[Read-Only] Whether to use a specfied rotation order or just use the default FRotator order and conversion functions

Type:

(bool)