unreal.RigUnit_HierarchyAddDynamicsParticleForce

class unreal.RigUnit_HierarchyAddDynamicsParticleForce(execute_pin: RigVMExecutePin = [], dynamics_particle_component_key: RigComponentKey = Ellipsis, force: Vector = Ellipsis, space: PhysicsControlSpace = Ellipsis, type: PhysicsControlForceType = Ellipsis)

Bases: RigUnit_DynamicsBaseMutable

Specifies a force on a Dynamics particle to be applied on the next simulation step. Multiple calls within the same frame accumulate. Forces queued during a pass-through frame (the next StepDynamicsSolver has Alpha <= 0) are discarded. Particles have no orientation, so there is no torque or location-offset variant.

C++ Source:

  • Plugin: ControlRigDynamics

  • Module: ControlRigDynamics

  • File: RigDynamicsParticleExecution.h

Editor Properties: (see get_editor_property/set_editor_property)

  • dynamics_particle_component_key (RigComponentKey): [Read-Write] The Dynamics Particle to apply the force to.

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

  • force (Vector): [Read-Write] Direction and magnitude of the force, in the frame given by Space. Units depend on Type.

  • space (PhysicsControlSpace): [Read-Write] Frame the Force is expressed in. Body means the space of the particle’s owning bone in the input pose.

  • type (PhysicsControlForceType): [Read-Write] How Force is interpreted: Force (kg cm/s^2), Acceleration (cm/s^2, mass-independent), Impulse (kg cm/s, one-shot momentum change), VelocityChange (cm/s, one-shot, mass-independent).

property dynamics_particle_component_key: RigComponentKey

[Read-Write] The Dynamics Particle to apply the force to.

Type:

(RigComponentKey)

property force: Vector

[Read-Write] Direction and magnitude of the force, in the frame given by Space. Units depend on Type.

Type:

(Vector)

property space: PhysicsControlSpace

[Read-Write] Frame the Force is expressed in. Body means the space of the particle’s owning bone in the input pose.

Type:

(PhysicsControlSpace)

property type: PhysicsControlForceType

Force (kg cm/s^2), Acceleration (cm/s^2, mass-independent), Impulse (kg cm/s, one-shot momentum change), VelocityChange (cm/s, one-shot, mass-independent).

Type:

(PhysicsControlForceType)

Type:

[Read-Write] How Force is interpreted