Navigation
API > API/Plugins > API/Plugins/ControlRigDynamics
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.
| Name | FRigUnit_HierarchyAddDynamicsParticleForce |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/ControlRigDynamics/Source/ControlRigDynamics/Public/RigDynamicsParticleExecution.h |
| Include Path | #include "RigDynamicsParticleExecution.h" |
Syntax
USTRUCT (
Meta=(DisplayName="Add Dynamics Particle Force", Keywords="Force,Impulse,Acceleration,Velocity", Varying))
struct FRigUnit_HierarchyAddDynamicsParticleForce : public FRigUnit_DynamicsBaseMutable
Inheritance Hierarchy
- FRigVMStruct → FRigUnit → FRigUnitMutable → FRigUnit_DynamicsBaseMutable → FRigUnit_HierarchyAddDynamicsParticleForce
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DynamicsParticleComponentKey | FRigComponentKey | The Dynamics Particle to apply the force to. | RigDynamicsParticleExecution.h |
|
| Force | FVector | Direction and magnitude of the force, in the frame given by Space. Units depend on Type. | RigDynamicsParticleExecution.h |
|
| Space | EPhysicsControlSpace | Frame the Force is expressed in. | RigDynamicsParticleExecution.h |
|
| Type | EPhysicsControlForceType | 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). | RigDynamicsParticleExecution.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
RIGVM_METHOD() |
RigDynamicsParticleExecution.h |