Navigation
API > API/Plugins > API/Plugins/ControlRigDynamics
Specifies forces on Dynamics particles to be applied in the next simulation step, based on the particle's location relative to the field. 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.
The force (which can be specified as a force, acceleration, impulse or velocity change) is made up of a radial, linear and rotational contribution.
| Name | FRigUnit_HierarchyAddDynamicsParticleForceField |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/ControlRigDynamics/Source/ControlRigDynamics/Public/RigDynamicsExecutionHelpers.h |
| Include Path | #include "RigDynamicsExecutionHelpers.h" |
Syntax
USTRUCT (
Meta=(DisplayName="Add Dynamics Particle Force Field", Keywords="Force,Impulse,Acceleration,Velocity", Varying))
struct FRigUnit_HierarchyAddDynamicsParticleForceField : public FRigUnit_DynamicsBaseMutable
Inheritance Hierarchy
- FRigVMStruct → FRigUnit → FRigUnitMutable → FRigUnit_DynamicsBaseMutable → FRigUnit_HierarchyAddDynamicsParticleForceField
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit_HierarchyAddDynamicsParticleForceField() |
RigDynamicsExecutionHelpers.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDrawDebug | bool | If true, the field draws its ellipsoid shape and an arrow per in-field particle showing this field's force contribution. | RigDynamicsExecutionHelpers.h |
|
| DebugForceScale | float | Multiplier on the debug arrow length. | RigDynamicsExecutionHelpers.h |
|
| DynamicsSolverComponentKey | FRigComponentKey | The Solver to use. | RigDynamicsExecutionHelpers.h |
|
| FieldCurves | FRigDynamicsForceFieldCurves | Per-radius-fraction multiplier curves applied to each of the three contributions. | RigDynamicsExecutionHelpers.h |
|
| FieldTransform | FTransform | The position, orientation and extents of the field shape. | RigDynamicsExecutionHelpers.h |
|
| LinearForce | float | The magnitude of the linear contribution. | RigDynamicsExecutionHelpers.h |
|
| LinearForceDirection | FVector | The direction of the linear contribution. | RigDynamicsExecutionHelpers.h |
|
| RadialForce | float | The magnitude of the radial contribution. | RigDynamicsExecutionHelpers.h |
|
| RotationalForce | float | The magnitude of the rotational contribution. | RigDynamicsExecutionHelpers.h |
|
| RotationalForceAxis | FVector | The axis around which the rotational contribution is applied. | RigDynamicsExecutionHelpers.h |
|
| Space | ERigDynamicsSimulationSpace | The space in which the field is specified. | RigDynamicsExecutionHelpers.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). | RigDynamicsExecutionHelpers.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
RIGVM_METHOD() |
RigDynamicsExecutionHelpers.h |