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 sequencercontrol_enum
(Enum): [Read-Write] Control Enum: If the control is 4transient and only visible in the control rig editorcontrol_type
(RigControlType): [Read-Write] Control Typecustomization
(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 widgetsdisplay_name
(Name): [Read-Write] Display Namedraw_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 editorlimit_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 valueminimum_value
(RigControlValue): [Read-Write] Minimum Value: The minimum limit of the control’s valueprimary_axis
(RigControlAxis): [Read-Write] Primary Axis: the primary axis to use for float controlsshape_color
(LinearColor): [Read-Write] Shape Colorshape_enabled
(bool): [Read-Write] Shape Enabled: Set to true if the shape is enabled in 3dshape_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 thisshape_visible
(bool): [Read-Write] Shape Visible: Set to true if the shape is currently visible in 3d
- 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
- 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
- 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
- property maximum_value¶
[Read-Write] Maximum Value: The maximum limit of the control’s value
- Type
- property minimum_value¶
[Read-Write] Minimum Value: The minimum limit of the control’s value
- Type
- property primary_axis¶
[Read-Write] Primary Axis: the primary axis to use for float controls
- Type
- property shape_color¶
[Read-Write] Shape Color
- Type
- property shape_enabled¶
[Read-Write] Shape Enabled: Set to true if the shape is enabled in 3d
- Type
(bool)