unreal.RigDynamicsVisualizationSettings

class unreal.RigDynamicsVisualizationSettings(line_thickness: float = 0.0, shape_detail: int = 0, show_particles: bool = False, show_colliders: bool = False, show_confiners: bool = False, show_skeletal_constraints: bool = False, show_hard_constraints: bool = False, show_soft_constraints: bool = False, show_angle_limits: bool = False, show_cone_limits: bool = False, particle_value_display: RigDynamicsParticleValueDisplay = Ellipsis)

Bases: StructBase

Visualization toggles for the rig’s dynamics simulation. Enabling any bShow* flag activates debug drawing - which has significant runtime cost - so disable everything before profiling. Visualization can also be globally suppressed at runtime via the CVar ControlRig.Dynamics.AllowVisualization.

C++ Source:

• Plugin: ControlRigDynamics

• Module: ControlRigDynamics

• File: RigDynamicsData.h

Editor Properties: (see get_editor_property/set_editor_property)

• line_thickness (float): [Read-Write]

• particle_value_display (RigDynamicsParticleValueDisplay): [Read-Write] When not None, the selected particle property is drawn as text next to each particle.

• shape_detail (int32): [Read-Write]

• show_angle_limits (bool): [Read-Write] Show the per-particle angle-limit cones (with green tint). Cone apex is at the parent particle, axis along the target direction, length = current bone length. Pale green when the simulated direction is within the limit, red-with-green-mixed-in when it has swung outside.

• show_colliders (bool): [Read-Write]

• show_cone_limits (bool): [Read-Write] Show the per-cone-limit cones (with blue tint). Cone apex is at the parent particle, axis along the incoming bone direction (grandparent->parent), length = current parent->child distance. Pale blue when the child direction is within the limit, red-with-blue-mixed-in when it has swung outside.

• show_confiners (bool): [Read-Write]

• show_hard_constraints (bool): [Read-Write] Show user-defined hard distance constraints.

• show_particles (bool): [Read-Write]

• show_skeletal_constraints (bool): [Read-Write] Show the auto-generated skeletal distance constraints between each particle and its parent.

• show_soft_constraints (bool): [Read-Write] Show user-defined soft distance constraints.

property line_thickness: float

[Read-Only]

Type:

(float)

property particle_value_display: RigDynamicsParticleValueDisplay

[Read-Only] When not None, the selected particle property is drawn as text next to each particle.

Type:

(RigDynamicsParticleValueDisplay)

property shape_detail: int

[Read-Only]

Type:

(int32)

property show_angle_limits: bool

[Read-Only] Show the per-particle angle-limit cones (with green tint). Cone apex is at the parent particle, axis along the target direction, length = current bone length. Pale green when the simulated direction is within the limit, red-with-green-mixed-in when it has swung outside.

Type:

(bool)

property show_colliders: bool

[Read-Only]

Type:

(bool)

property show_cone_limits: bool

[Read-Only] Show the per-cone-limit cones (with blue tint). Cone apex is at the parent particle, axis along the incoming bone direction (grandparent->parent), length = current parent->child distance. Pale blue when the child direction is within the limit, red-with-blue-mixed-in when it has swung outside.

Type:

(bool)

property show_confiners: bool

[Read-Only]

Type:

(bool)

property show_hard_constraints: bool

[Read-Only] Show user-defined hard distance constraints.

Type:

(bool)

property show_particles: bool

[Read-Only]

Type:

(bool)

property show_skeletal_constraints: bool

[Read-Only] Show the auto-generated skeletal distance constraints between each particle and its parent.

Type:

(bool)

property show_soft_constraints: bool

[Read-Only] Show user-defined soft distance constraints.

Type:

(bool)