`unreal.RigUnit_SpawnDynamicsConfiner`¶

class unreal.RigUnit_SpawnDynamicsConfiner(execute_pin: RigVMExecutePin = [], owner: RigElementKey = Ellipsis, dynamics_solver_component_key: RigComponentKey = Ellipsis, confiner_component_name: Name = 'None', shapes: RigDynamicsShapeCollection = Ellipsis, strength: float = 0.0, confined_particles: None = [], dynamics_confiner_component_key: RigComponentKey = Ellipsis)¶

Bases: RigUnit_DynamicsBaseMutable

Spawns a new dynamics confiner as a component on the owner element. Confiners keep opted-in particles inside each of their shapes (intersection semantics). The confiner tracks the input pose, but does not track the simulated pose. Note: This node only runs as part of the construction event.

C++ Source:

Plugin: ControlRigDynamics
Module: ControlRigDynamics
File: RigDynamicsConfinerExecution.h

Editor Properties: (see get_editor_property/set_editor_property)

confined_particles (Array[RigComponentKey]): [Read-Write] Particles that should be confined by this confiner. Each listed particle has the new confiner key appended to its Confiners opt-in list, so no separate Enable call is needed. Missing/invalid keys warn and are skipped. Leave empty to wire particles up later.
confiner_component_name (Name): [Read-Write] The name to give the confiner component. Only used as a starting point - if another component with this name already exists on the owner element, the hierarchy will append a unique suffix. Read DynamicsConfinerComponentKey to find the name that was actually assigned.
dynamics_confiner_component_key (RigComponentKey): [Read-Write] The Dynamics Confiner component key that was created
dynamics_solver_component_key (RigComponentKey): [Read-Write] Optional solver - if set (and valid), it will be added to this solver component
execute_pin (RigVMExecutePin): [Read-Write] This property is used to chain multiple mutable units together
owner (RigElementKey): [Read-Write] The owner of the newly created component (must be set/valid)
shapes (RigDynamicsShapeCollection): [Read-Write] The confiner shapes
strength (float): [Read-Write] Soft strength (oscillation frequency in Hz) with which particles are pushed back inside

property confined_particles: None¶

[Read-Write] Particles that should be confined by this confiner. Each listed particle has the new confiner key appended to its Confiners opt-in list, so no separate Enable call is needed. Missing/invalid keys warn and are skipped. Leave empty to wire particles up later.

Type:: (Array[RigComponentKey])

property confiner_component_name: Name¶

[Read-Write] The name to give the confiner component. Only used as a starting point - if another component with this name already exists on the owner element, the hierarchy will append a unique suffix. Read DynamicsConfinerComponentKey to find the name that was actually assigned.