ControlRigDynamics

API > API/Plugins

   
Name ControlRigDynamics
Type Plugin
Part of Plugins ControlRigDynamics
Location /Engine/Plugins/Experimental/ControlRigDynamics/Source/ControlRigDynamics/
Module Build Rules ControlRigDynamics.Build.cs

Classes

Name Remarks
FControlRigDynamicsModule  

Structs

Name Remarks
FBoxShape TODO investigate using the implicit shapes here (and for the others) - e.g. TBox/FImplicitBox3.
FCapsuleShape  
FConeLimit  
FConeLimitInfo  
FHardDistanceConstraint  
FHardDistanceConstraintInfo  
FParticle  
FParticleChainCurves Multiplier curves applied to particle properties along each chain.
FParticleCollider  
FParticleConfinement  
FParticleInfo Simulation data used in the central loops of the solve.
FParticleNoCollision  
FParticleTarget  
FParticleToParticleCollision  
FPlaneShape  
FRigDynamicsColliderComponent A component that can be added to a joint/element that defines how a collision shape can be attached to it.
FRigDynamicsConeLimitComponent A component that can be added to a joint/element that defines a cone (angular) limit between three particles.
FRigDynamicsConfinerComponent A component that can be added to a joint/element that defines how a confinement shape can be attached to it.
FRigDynamicsConstraintComponent A component that can be added to a joint/element that defines a constraint between two particles.
FRigDynamicsForceFieldCurves Multiplier curves applied to a force-field's three contributions.
FRigDynamicsInertialForceSettings Master gain on the pseudo-forces (Coriolis, centrifugal, Euler, linear) caused by movement of the simulation space itself (typically, movement of the actor/component).
FRigDynamicsParticleComponent A component that can be added to a joint/element that defines how a dynamics particle can be attached to it.
FRigDynamicsParticleForce A single per-frame force record queued by the AddDynamicsParticleForce node and consumed by the solver in UpdatePreDynamics.
FRigDynamicsParticleProperties  
FRigDynamicsShapeBox  
FRigDynamicsShapeCapsule  
FRigDynamicsShapeCollection  
FRigDynamicsShapeCollectionWithKey  
FRigDynamicsShapePlane  
FRigDynamicsSimulationDragSettings Air/ether drag settings applied to the whole simulation, due to the movement of the simulation space (typically as a result of the actor/component moving).
FRigDynamicsSimulationSpaceMotion How the simulation-space linear/angular velocity and acceleration are conditioned (vertical scale* clamps) before being passed to the inertial pseudo-forces and the air/ether drag effects.
FRigDynamicsSimulationSpaceSettings Legacy combined struct retained only for the deprecated FRigUnit_SpawnDynamicsSolver pin layout.
FRigDynamicsSimulationSpaceState This represents the simulation space, specified in world space.
FRigDynamicsSolverComponent A component that can be added to a joint/element that defines how a system of particles can be solved.
FRigDynamicsSolverCreationSettings Bundle of settings used when a spawn helper needs to create a new solver.
FRigDynamicsSolverSettings Configuration/settings for the dynamics solver.
FRigDynamicsTeleportDetectionSettings Teleport-detection thresholds based on the movement of the simulation space.
FRigDynamicsVisualizationSettings Visualization toggles for the rig's dynamics simulation.
FRigUnit_DynamicsBase Base struct for all non-mutable dynamics nodes.
FRigUnit_DynamicsBaseMutable Base struct for all mutable dynamics nodes.
FRigUnit_GetDynamicsColliderExists Indicates whether the component exists and is a Dynamics Collider.
FRigUnit_GetDynamicsConeLimitExists Indicates whether the component exists and is a Dynamics Cone Limit.
FRigUnit_GetDynamicsConfinerExists Indicates whether the component exists and is a Dynamics Confiner.
FRigUnit_GetDynamicsConstraintExists Indicates whether the component exists and is a Dynamics Constraint.
FRigUnit_GetDynamicsParticleExists Indicates whether the component exists and is a Dynamics Particle.
FRigUnit_GetDynamicsSolverData Retrieves the data that were generated during the simulation step, so the values returned will relate to the previous update if the solver has not yet been stepped.
FRigUnit_GetDynamicsSolverExists Indicates whether the component exists and is a Dynamics Solver.
FRigUnit_HierarchyAddDynamicsParticleForce Specifies a force on a Dynamics particle to be applied on the next simulation step.
FRigUnit_HierarchyAddDynamicsParticleForceField Specifies forces on Dynamics particles to be applied in the next simulation step, based on the particle's location relative to the field.
FRigUnit_HierarchyAllowDynamicsCollisionWithCollider Allows collision between a particle and a specific collider, by removing it from the particle's NoCollisionColliders list.
FRigUnit_HierarchyDisableDynamicsCollisionWithCollider Disables collision between a particle and a collider.
FRigUnit_HierarchyDisableDynamicsCollisionWithParticle Disables collision between a particle and another particle by removing each key from the other's CollisionParticles list.
FRigUnit_HierarchyDisableDynamicsConfinementWithConfiner Opts a particle out of being confined by a confiner.
FRigUnit_HierarchyEnableDynamicsCollisionWithParticle Enables collision between a particle and another particle.
FRigUnit_HierarchyEnableDynamicsConfinementWithConfiner Opts a particle in to being confined by a confiner.
FRigUnit_HierarchyGetDynamicsColliderBox Gets the properties of a named box shape on a Dynamics collider. The shape is looked up by Name.
FRigUnit_HierarchyGetDynamicsColliderBoxExtents Gets the extents of a named box shape on a Dynamics collider.
FRigUnit_HierarchyGetDynamicsColliderBoxTM Gets the transform of a named box shape on a Dynamics collider.
FRigUnit_HierarchyGetDynamicsColliderCapsule Gets the properties of a named capsule shape on a Dynamics collider. The shape is looked up by Name.
FRigUnit_HierarchyGetDynamicsColliderCapsuleLength Gets the length of a named capsule shape on a Dynamics collider.
FRigUnit_HierarchyGetDynamicsColliderCapsuleRadius Gets the radius of a named capsule shape on a Dynamics collider.
FRigUnit_HierarchyGetDynamicsColliderCapsuleTM Gets the transform of a named capsule shape on a Dynamics collider.
FRigUnit_HierarchyGetDynamicsColliderPlane Gets the properties of a named plane shape on a Dynamics collider. The shape is looked up by Name.
FRigUnit_HierarchyGetDynamicsColliderPlaneExtents Gets the extents of a named plane shape on a Dynamics collider.
FRigUnit_HierarchyGetDynamicsColliderPlaneTM Gets the transform of a named plane shape on a Dynamics collider.
FRigUnit_HierarchyGetDynamicsColliderShapes Reads the entire shape collection from a Dynamics collider.
FRigUnit_HierarchyGetDynamicsConeLimitAngle Gets the angle of a Dynamics cone limit.
FRigUnit_HierarchyGetDynamicsConeLimitDampingRatio Gets the damping ratio of a Dynamics cone limit.
FRigUnit_HierarchyGetDynamicsConeLimitStrength Gets the strength of a Dynamics cone limit.
FRigUnit_HierarchyGetDynamicsConfinerBox Gets the properties of a named box shape on a Dynamics confiner. The shape is looked up by Name.
FRigUnit_HierarchyGetDynamicsConfinerBoxExtents Gets the extents of a named box shape on a Dynamics confiner.
FRigUnit_HierarchyGetDynamicsConfinerBoxTM Gets the transform of a named box shape on a Dynamics confiner.
FRigUnit_HierarchyGetDynamicsConfinerCapsule Gets the properties of a named capsule shape on a Dynamics confiner. The shape is looked up by Name.
FRigUnit_HierarchyGetDynamicsConfinerCapsuleLength Gets the length of a named capsule shape on a Dynamics confiner.
FRigUnit_HierarchyGetDynamicsConfinerCapsuleRadius Gets the radius of a named capsule shape on a Dynamics confiner.
FRigUnit_HierarchyGetDynamicsConfinerCapsuleTM Gets the transform of a named capsule shape on a Dynamics confiner.
FRigUnit_HierarchyGetDynamicsConfinerPlane Gets the properties of a named plane shape on a Dynamics confiner. The shape is looked up by Name.
FRigUnit_HierarchyGetDynamicsConfinerPlaneExtents Gets the extents of a named plane shape on a Dynamics confiner (visualization only)
FRigUnit_HierarchyGetDynamicsConfinerPlaneTM Gets the transform of a named plane shape on a Dynamics confiner.
FRigUnit_HierarchyGetDynamicsConfinerShapes Reads the entire shape collection from a Dynamics confiner.
FRigUnit_HierarchyGetDynamicsConfinerStrength Gets the strength (oscillation frequency) of a Dynamics confiner.
FRigUnit_HierarchyGetDynamicsConstraintAccelerationMode Gets whether a Dynamics constraint is in acceleration mode.
FRigUnit_HierarchyGetDynamicsConstraintDampingRatio Gets the damping ratio of a Dynamics constraint.
FRigUnit_HierarchyGetDynamicsConstraintExtraDamping Gets the extra damping of a Dynamics constraint.
FRigUnit_HierarchyGetDynamicsConstraintExtraLength Gets the extra length of a Dynamics constraint.
FRigUnit_HierarchyGetDynamicsConstraintLengthMultiplier Gets the length multiplier of a Dynamics constraint.
FRigUnit_HierarchyGetDynamicsConstraintStrength Gets the strength of a Dynamics constraint.
FRigUnit_HierarchyGetDynamicsParticleAccelerationMode Gets the acceleration-mode flag of a Dynamics particle.
FRigUnit_HierarchyGetDynamicsParticleAngleLimit Gets the angle limit of a Dynamics particle.
FRigUnit_HierarchyGetDynamicsParticleAngleLimitStrength Gets the angle limit strength of a Dynamics particle.
FRigUnit_HierarchyGetDynamicsParticleCollideWithColliders Gets whether a Dynamics particle participates in collider contacts.
FRigUnit_HierarchyGetDynamicsParticleDamping Reads the particle's air/ether damping value, converting from Drag if the particle is in drag mode (Damping = Damping_stored / Mass) so the output always carries the damping-mode interpretation regardless of how the particle was authored.
FRigUnit_HierarchyGetDynamicsParticleDampingRatio Gets the damping ratio of a Dynamics particle.
FRigUnit_HierarchyGetDynamicsParticleDrag Reads the particle's air/ether drag value, converting from Damping if the particle is in mass-independent mode (Drag = Damping * Mass) so the output always carries the drag-mode interpretation regardless of how the particle was authored.
FRigUnit_HierarchyGetDynamicsParticleExtraDamping Gets the extra damping of a Dynamics particle.
FRigUnit_HierarchyGetDynamicsParticleGravityMultiplier Gets the gravity multiplier of a Dynamics particle.
FRigUnit_HierarchyGetDynamicsParticleMass Gets the mass of a Dynamics particle.
FRigUnit_HierarchyGetDynamicsParticleMovementType Gets the movement type of a Dynamics particle.
FRigUnit_HierarchyGetDynamicsParticleNoCollisionColliders Returns the current NoCollisionColliders list on a particle.
FRigUnit_HierarchyGetDynamicsParticleRadius Gets the radius of a Dynamics particle.
FRigUnit_HierarchyGetDynamicsParticleScaleDampingByInverseMass Gets the scale-damping-by-inverse-mass flag of a Dynamics particle.
FRigUnit_HierarchyGetDynamicsParticleStrength Gets the strength of a Dynamics particle.
FRigUnit_HierarchyGetDynamicsParticleTargetMode Gets the target mode of a Dynamics particle.
FRigUnit_HierarchyGetDynamicsParticleTargetVelocityInfluence Gets the target velocity influence of a Dynamics particle.
FRigUnit_HierarchyGetDynamicsSolverGravity Gets the gravity of a Dynamics solver.
FRigUnit_HierarchyGetDynamicsSolverMaxNumSteps Gets the max number of steps of a Dynamics solver.
FRigUnit_HierarchyGetDynamicsSolverMaxTimeStep Gets the max time step of a Dynamics solver.
FRigUnit_HierarchyGetDynamicsSolverNumConstraintSubIterations Gets the number of constraint sub-iterations of a Dynamics solver.
FRigUnit_HierarchyGetDynamicsSolverNumIterations Gets the number of iterations of a Dynamics solver.
FRigUnit_HierarchyGetDynamicsSolverSettings Gets the complete settings of a Dynamics solver.
FRigUnit_HierarchyGetDynamicsSolverSpaceMotion Gets the simulation-space motion settings of a Dynamics solver.
FRigUnit_HierarchyGetDynamicsSolverTeleportDetection Gets the teleport-detection thresholds of a Dynamics solver.
FRigUnit_HierarchyImportDynamicsCollidersFromPhysicsAsset Imports collision from a physics asset and assigns it as colliders in the dynamics system.
FRigUnit_HierarchyImportDynamicsCollidersFromPhysicsAsset1 Imports collision from a physics asset and assigns it as colliders in the dynamics system.
FRigUnit_HierarchySetDynamicsColliderBox Sets the properties of a named box shape on a Dynamics collider. Name is used to find the shape.
FRigUnit_HierarchySetDynamicsColliderBoxExtents Sets the extents of a named box shape on a Dynamics collider.
FRigUnit_HierarchySetDynamicsColliderBoxTM Sets the transform of a named box shape on a Dynamics collider.
FRigUnit_HierarchySetDynamicsColliderCapsule Sets the properties of a named capsule shape on a Dynamics collider. Name is used to find the shape.
FRigUnit_HierarchySetDynamicsColliderCapsuleLength Sets the length of a named capsule shape on a Dynamics collider.
FRigUnit_HierarchySetDynamicsColliderCapsuleRadius Sets the radius of a named capsule shape on a Dynamics collider.
FRigUnit_HierarchySetDynamicsColliderCapsuleTM Sets the transform of a named capsule shape on a Dynamics collider.
FRigUnit_HierarchySetDynamicsColliderPlane Sets the properties of a named plane shape on a Dynamics collider. Name is used to find the shape.
FRigUnit_HierarchySetDynamicsColliderPlaneExtents Sets the extents of a named plane shape on a Dynamics collider.
FRigUnit_HierarchySetDynamicsColliderPlaneTM Sets the transform of a named plane shape on a Dynamics collider.
FRigUnit_HierarchySetDynamicsColliderShapes Replaces the entire shape collection on a Dynamics collider.
FRigUnit_HierarchySetDynamicsConeLimitAngle Sets the angle of a Dynamics cone limit.
FRigUnit_HierarchySetDynamicsConeLimitDampingRatio Sets the damping ratio of a Dynamics cone limit.
FRigUnit_HierarchySetDynamicsConeLimitStrength Sets the strength of a Dynamics cone limit.
FRigUnit_HierarchySetDynamicsConfinerBox Sets the properties of a named box shape on a Dynamics confiner. Name is used to find the shape.
FRigUnit_HierarchySetDynamicsConfinerBoxExtents Sets the extents of a named box shape on a Dynamics confiner.
FRigUnit_HierarchySetDynamicsConfinerBoxTM Sets the transform of a named box shape on a Dynamics confiner.
FRigUnit_HierarchySetDynamicsConfinerCapsule Sets the properties of a named capsule shape on a Dynamics confiner. Name is used to find the shape.
FRigUnit_HierarchySetDynamicsConfinerCapsuleLength Sets the length of a named capsule shape on a Dynamics confiner.
FRigUnit_HierarchySetDynamicsConfinerCapsuleRadius Sets the radius of a named capsule shape on a Dynamics confiner.
FRigUnit_HierarchySetDynamicsConfinerCapsuleTM Sets the transform of a named capsule shape on a Dynamics confiner.
FRigUnit_HierarchySetDynamicsConfinerPlane Sets the properties of a named plane shape on a Dynamics confiner. Name is used to find the shape.
FRigUnit_HierarchySetDynamicsConfinerPlaneExtents Sets the extents of a named plane shape on a Dynamics confiner (visualization only)
FRigUnit_HierarchySetDynamicsConfinerPlaneTM Sets the transform of a named plane shape on a Dynamics confiner.
FRigUnit_HierarchySetDynamicsConfinerShapes Replaces the entire shape collection on a Dynamics confiner.
FRigUnit_HierarchySetDynamicsConfinerStrength Sets the strength (oscillation frequency) of a Dynamics confiner.
FRigUnit_HierarchySetDynamicsConstraintAccelerationMode Sets whether a Dynamics constraint is in acceleration mode (mass-independent natural frequency) or force mode (heavier particles oscillate slower).
FRigUnit_HierarchySetDynamicsConstraintDampingRatio Sets the damping ratio of a Dynamics constraint.
FRigUnit_HierarchySetDynamicsConstraintExtraDamping Sets the extra damping of a Dynamics constraint.
FRigUnit_HierarchySetDynamicsConstraintExtraLength Sets the extra length of a Dynamics constraint.
FRigUnit_HierarchySetDynamicsConstraintLengthMultiplier Sets the length multiplier of a Dynamics constraint.
FRigUnit_HierarchySetDynamicsConstraintStrength Sets the strength of a Dynamics constraint.
FRigUnit_HierarchySetDynamicsParticleAccelerationMode Sets whether the particle's target drive is interpreted in acceleration mode (mass-independent natural frequency) or force mode (heavier particles oscillate more slowly).
FRigUnit_HierarchySetDynamicsParticleAngleLimit Sets the angle limit of a Dynamics particle.
FRigUnit_HierarchySetDynamicsParticleAngleLimitStrength Sets the angle limit strength of a Dynamics particle.
FRigUnit_HierarchySetDynamicsParticleCollideWithColliders Sets whether a Dynamics particle participates in collider contacts.
FRigUnit_HierarchySetDynamicsParticleDamping Sets the particle into "damping" mode: writes the Damping value to ParticleProperties.Damping and forces bScaleDampingByInverseMass = false, so the effective coupling rate is Damping directly (mass-independent - every particle has the same relaxation timescale).
FRigUnit_HierarchySetDynamicsParticleDampingRatio Sets the damping ratio of a Dynamics particle.
FRigUnit_HierarchySetDynamicsParticleDrag Sets the particle into "drag" mode.
FRigUnit_HierarchySetDynamicsParticleExtraDamping Sets the extra damping of a Dynamics particle.
FRigUnit_HierarchySetDynamicsParticleGravityMultiplier Sets the gravity multiplier of a Dynamics particle.
FRigUnit_HierarchySetDynamicsParticleMass Sets the mass of a Dynamics particle.
FRigUnit_HierarchySetDynamicsParticleMovementType Sets the movement type of a Dynamics particle.
FRigUnit_HierarchySetDynamicsParticleNoCollisionColliders Replaces the entire NoCollisionColliders list on a particle.
FRigUnit_HierarchySetDynamicsParticleRadius Sets the radius of a Dynamics particle.
FRigUnit_HierarchySetDynamicsParticleScaleDampingByInverseMass Sets whether the particle's Damping is scaled by inverse mass (drag-like) or mass-independent.
FRigUnit_HierarchySetDynamicsParticleStrength Sets the strength of a Dynamics particle.
FRigUnit_HierarchySetDynamicsParticleTargetMode Sets the target mode of a Dynamics particle.
FRigUnit_HierarchySetDynamicsParticleTargetVelocityInfluence Sets the target velocity influence of a Dynamics particle.
FRigUnit_HierarchySetDynamicsSolverGravity Sets the gravity of a Dynamics solver.
FRigUnit_HierarchySetDynamicsSolverMaxNumSteps Sets the max number of steps of a Dynamics solver.
FRigUnit_HierarchySetDynamicsSolverMaxTimeStep Sets the max time step of a Dynamics solver.
FRigUnit_HierarchySetDynamicsSolverNumConstraintSubIterations Sets the number of constraint sub-iterations of a Dynamics solver.
FRigUnit_HierarchySetDynamicsSolverNumIterations Sets the number of iterations of a Dynamics solver.
FRigUnit_HierarchySetDynamicsSolverSettings Sets the complete settings of a Dynamics solver.
FRigUnit_HierarchySetDynamicsSolverSpaceMotion Sets the simulation-space motion settings (conditioning + nested inertial-force / drag) of a Dynamics solver.
FRigUnit_HierarchySetDynamicsSolverTeleportDetection Sets the teleport-detection thresholds of a Dynamics solver.
FRigUnit_InstantiateDynamics Instantiates all the objects in the dynamics world.
FRigUnit_SpawnDynamicsChains Spawns a new dynamics chain (or chains) Note: This node only runs as part of the construction event.
FRigUnit_SpawnDynamicsCollider Spawns a new dynamics collider as a component on the owner element.
FRigUnit_SpawnDynamicsConeLimit Spawns a new dynamics cone limit component.
FRigUnit_SpawnDynamicsConfiner  
FRigUnit_SpawnDynamicsConstraint Spawns a new dynamics constraint component.
FRigUnit_SpawnDynamicsParticle Spawns a new dynamics particle as a component on the owner element.
FRigUnit_SpawnDynamicsSolver Spawns a new dynamics solver as a component on the owner element.
FRigUnit_SpawnDynamicsSolver1 Spawns a new dynamics solver as a component on the owner element.
FRigUnit_StepDynamicsSolver Steps the dynamics solver.
FShapeCollection  
FSimulationSpaceMotion Describes the motion of the simulation's reference frame, so the simulation can apply inertial pseudo-forces and air/ether drag.
FSimulationState The structs above here define the individual components that could go into a particle simulation
FSoftDistanceConstraint  
FSoftDistanceConstraintInfo  
FSolverSettings  

Typedefs

Name Type Remarks Include Path
FSimScalar double   RigParticleSimulation.h
FSimTransform FTransform   RigParticleSimulation.h
FSimVector FVector   RigParticleSimulation.h
FSimVector2D FVector2D   RigParticleSimulation.h

Enums

Public

Name Remarks
ERigDynamicsParticleValueDisplay Selects which particle property to display numerically next to each particle in the debug draw.
ERigDynamicsSimulationSpace Specifies what space the simulation should run in.
ERigParticleSimulationConstraintType TODO support min, max and ranged length constraints.
ERigParticleSimulationMovementType This should be kept completely independent of control rig etc.

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Keywords   Spawns a new dynamics confiner as a component on the owner element. RigDynamicsConfinerExecution.h  
RigDynamicsDefaultParticleMass float   RigDynamicsData.h  
RigDynamicsDefaultParticleRadius float   RigDynamicsData.h  
RigDynamicsDefaultShapeSize float   RigDynamicsData.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Translates the legacy combined struct (from the deprecated FRigUnit_SpawnDynamicsSolver pin layout) into the new SpaceMotion / TeleportDetection structs. RigDynamicsData.h  

void RigParticleSimulation::UpdateCollider ( FSimulationState& State,
int32 Index,
const FSimTransform& TM
)

 Updates a single collider for the current frame. RigParticleSimulation.h  

void RigParticleSimulation::UpdateConeLimit ( FSimulationState& State,
int32 Index,
float InAngleDegrees,
float InStrength,
float InDampingRatio
)

 Updates a single cone limit for the current frame. RigParticleSimulation.h  

void RigParticleSimulation::UpdateConfiner ( FSimulationState& State,
int32 Index,
const FSimTransform& TM
)

 Updates a single confiner's transform for the current frame. RigParticleSimulation.h  

void RigParticleSimulation::UpdateHardDistanceConstraint ( FSimulationState& State,
int32 Index,
float InLengthMultiplier,
float InExtraLength
)

 Updates a single user-defined hard distance constraint for the current frame. RigParticleSimulation.h  

void RigParticleSimulation::UpdateParticle ( FSimulationState& State,
int32 Index,
float InMass,
float InGravityMultiplier,
float InRadius,
float InDamping,
bool bInScaleDampingByInverseMass,
bool bInCollideWithColliders
)

 Optionally updates a single particle's simulation properties for the current frame. RigParticleSimulation.h  
Trivial/inline implementations. RigParticleSimulation.h  

void RigParticleSimulation::UpdateSoftDistanceConstraint ( FSimulationState& State,
int32 Index,
float InLengthMultiplier,
float InExtraLength,
float InStrength,
float InDampingRatio,
float InExtraDamping,
bool bInAccelerationMode
)

 Updates a single user-defined soft distance constraint for the current frame. RigParticleSimulation.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page