unreal.RigControl?

class unreal.RigControl(name='None', index=-1, control_type=RigControlType.TRANSFORM, parent_name='None', parent_index=-1, space_name='None', space_index=-1, initial_value=[], value=[], primary_axis=RigControlAxis.X, animatable=True, limit_translation=False, limit_rotation=False, limit_scale=False, draw_limits=True, minimum_value=[], maximum_value=[], gizmo_enabled=True, gizmo_name='Gizmo', gizmo_transform=[[0.0, 0.0, 0.0], [0.0, 0.0, 0.0], [1.0, 1.0, 1.0]], gizmo_color=[1.0, 0.0, 0.0, 1.0], is_transient_control=False)?

Bases: unreal.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] If the control is animatable in sequencer
  • control_type (RigControlType): [Read-Write] Control Type
  • draw_limits (bool): [Read-Write] True if the limits should be drawn in debug.
  • gizmo_color (LinearColor): [Read-Write] Gizmo Color
  • gizmo_enabled (bool): [Read-Write] Set to true if the gizmo is enabled in 3d
  • gizmo_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
  • gizmo_transform (Transform): [Read-Write] Gizmo Transform
  • index (int32): [Read-Only] Index
  • initial_value (RigControlValue): [Read-Only] Initial Value
  • is_transient_control (bool): [Read-Write] If the control is transient and only visible in the control rig editor
  • limit_rotation (bool): [Read-Write] True if the control has to obey rotation limits.
  • limit_scale (bool): [Read-Write] True if the control has to obey scale limits.
  • limit_translation (bool): [Read-Write] True if the control has to obey translation limits.
  • maximum_value (RigControlValue): [Read-Write] The storage for all maximum values
  • minimum_value (RigControlValue): [Read-Write] The storage for all minimum values
  • name (Name): [Read-Write] Name
  • parent_index (int32): [Read-Write] Parent Index
  • parent_name (Name): [Read-Only] Parent Name
  • primary_axis (RigControlAxis): [Read-Write] 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
animatable?

(bool) – [Read-Write] If the control is animatable in sequencer

control_type?

(RigControlType) – [Read-Write] Control Type

draw_limits?

(bool) – [Read-Write] True if the limits should be drawn in debug.

gizmo_color?

(LinearColor) – [Read-Write] Gizmo Color

gizmo_enabled?

(bool) – [Read-Write] Set to true if the gizmo is enabled in 3d

gizmo_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

gizmo_transform?

(Transform) – [Read-Write] Gizmo Transform

initial_value?

(RigControlValue) – [Read-Only] Initial Value

is_transient_control?

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

limit_rotation?

(bool) – [Read-Write] True if the control has to obey rotation limits.

limit_scale?

(bool) – [Read-Write] True if the control has to obey scale limits.

limit_translation?

(bool) – [Read-Write] True if the control has to obey translation limits.

maximum_value?

(RigControlValue) – [Read-Write] The storage for all maximum values

minimum_value?

(RigControlValue) – [Read-Write] The storage for all minimum values

parent_index?

(int32) – [Read-Only] Parent Index

parent_name?

(Name) – [Read-Only] Parent Name

primary_axis?

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

space_index?

(int32) – [Read-Only] Space Index

space_name?

(Name) – [Read-Only] Space Name

value?

(RigControlValue) – [Read-Only] Value