unreal.RigUnit_HierarchySetDynamicsParticleDrag

class unreal.RigUnit_HierarchySetDynamicsParticleDrag(execute_pin: RigVMExecutePin = [], dynamics_particle_component_key: RigComponentKey = Ellipsis, drag: float = 0.0)

Bases: RigUnit_DynamicsBaseMutable

Sets the particle into “drag” mode. Writes the Drag value to ParticleProperties.Damping and forces bScaleDampingByInverseMass = true, so the effective damping rate is Drag * InvMass (heavier particles damp slower, resulting in the drag-like behaviour). Use Set Damping instead for a mass-independent rate.

C++ Source:

  • Plugin: ControlRigDynamics

  • Module: ControlRigDynamics

  • File: RigDynamicsParticleExecution.h

Editor Properties: (see get_editor_property/set_editor_property)

  • drag (float): [Read-Write] Air/ether drag coefficient (1/time). Effective coupling rate = Drag * InvMass.

  • dynamics_particle_component_key (RigComponentKey): [Read-Write] The Dynamics Particle to be updated

  • execute_pin (RigVMExecutePin): [Read-Write] This property is used to chain multiple mutable units together

property drag: float

[Read-Write] Air/ether drag coefficient (1/time). Effective coupling rate = Drag * InvMass.

Type:

(float)

property dynamics_particle_component_key: RigComponentKey

[Read-Write] The Dynamics Particle to be updated

Type:

(RigComponentKey)