FRigDynamicsSimulationSpaceState

This represents the simulation space, specified in world space.

API > API/Plugins > API/Plugins/ControlRigDynamics

This represents the simulation space, specified in world space. It will be associated with functions that allow conversion between the spaces.

   
Name FRigDynamicsSimulationSpaceState
Type struct
Header File /Engine/Plugins/Experimental/ControlRigDynamics/Source/ControlRigDynamics/Public/RigDynamicsSimulationSpace.h
Include Path #include "RigDynamicsSimulationSpace.h"

Syntax

struct FRigDynamicsSimulationSpaceState

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AngularAcceleration FVector World-space angular acceleration of the simulation space. RigDynamicsSimulationSpace.h  
AngularVelocity FVector World-space angular velocity of the simulation space. RigDynamicsSimulationSpace.h  
bTeleportDetectedInLastUpdate bool Set by Update() when teleport thresholds are tripped; updated only when DeltaTime > 0. RigDynamicsSimulationSpace.h  
ComponentTM FTransform The world-space component (owner of the simulation) transform. RigDynamicsSimulationSpace.h  
ComponentToSimSpaceTM FTransform Precomputed composite transforms so that each coordinate conversion is a single transform operation instead of two. RigDynamicsSimulationSpace.h  
DeltaTime float The time between SimulationSpaceTM and PrevSimulationSpaceTM. RigDynamicsSimulationSpace.h  
LinearAcceleration FVector World-space linear acceleration of the simulation space. RigDynamicsSimulationSpace.h  
LinearVelocity FVector World-space linear velocity of the simulation space. RigDynamicsSimulationSpace.h  
PrevDeltaTime float The time between PrevSimulationSpaceTM and PrevPrevSimulationSpaceTM. RigDynamicsSimulationSpace.h  
PrevPrevSimulationSpaceTM FTransform   RigDynamicsSimulationSpace.h  
PrevSimulationSpaceTM FTransform   RigDynamicsSimulationSpace.h  
SimToComponentSpaceTM FTransform   RigDynamicsSimulationSpace.h  
SimulationSpaceTM FTransform The world-space simulation space TM. RigDynamicsSimulationSpace.h  
UpdatesSinceReset int64 When we are reset, then the position (and orientation) is correct On the next update (with a non-zero delta time), the velocity is correct (acceleration will be zero) On the next update, the acceleration will be correct RigDynamicsSimulationSpace.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

RigParticleSimulation::FSimulationSpaceMotion CalculateMotion ( const FRigDynamicsSimulationSpaceMotion& SpaceMotion,
double AbsoluteTime
) const

 Calculates the simulation space motion data from the current state and SpaceMotion (which holds the conditioning, the inertial-force amount, and the nested air/ether drag settings), ready to be passed to RigParticleSimulation::Simulate. RigDynamicsSimulationSpace.h  

RigParticleSimulation::FSimVector ConvertComponentSpacePositionToSimSpace ( const FVector& ComponentSpacePosition
) const

 Inline implementations. RigDynamicsSimulationSpace.h  

RigParticleSimulation::FSimTransform ConvertComponentSpaceTransformToSimSpace ( const FTransform& ComponentSpaceTransform
) const

 Convert a transform from component space into simulation space (rotation + translation, no scale). RigDynamicsSimulationSpace.h  

RigParticleSimulation::FSimVector ConvertComponentSpaceVectorToSimSpace ( const FVector& ComponentSpaceVector
) const

 Convert a direction/velocity vector from component space into simulation space. RigDynamicsSimulationSpace.h  

FVector ConvertSimSpacePositionToComponentSpace ( const RigParticleSimulation::FSimVector& SimSpacePosition
) const

 Convert a position from simulation space back to component space. RigDynamicsSimulationSpace.h  

FTransform ConvertSimSpaceTransformToComponentSpace ( const RigParticleSimulation::FSimTransform& SimSpaceTransform
) const

 Convert a transform from simulation space back to component space. RigDynamicsSimulationSpace.h  

RigParticleSimulation::FSimTransform ConvertWorldSpaceTransformToSimSpace ( const FTransform& WorldSpaceTransform
) const

 Convert a transform from world space into simulation space (rotation + translation, no scale). RigDynamicsSimulationSpace.h  

RigParticleSimulation::FSimVector ConvertWorldVectorToSimSpace ( const FVector& WorldVector
) const

 Convert a direction/velocity vector from world space into simulation space. RigDynamicsSimulationSpace.h  

const FVector & GetAngularAcceleration()

 World-space angular acceleration (rad/s/s) of the simulation space as computed by the most recent Update(). RigDynamicsSimulationSpace.h  

const FVector & GetAngularVelocity()

 World-space angular velocity (rad/s) of the simulation space as computed by the most recent Update(). RigDynamicsSimulationSpace.h  

const FTransform & GetComponentTM ()

 World-space transform of the rig's component (component-to-world). RigDynamicsSimulationSpace.h  

const FVector & GetLinearAcceleration()

 World-space linear acceleration of the simulation space as computed by the most recent Update(). RigDynamicsSimulationSpace.h  

const FVector & GetLinearVelocity ()

 World-space linear velocity of the simulation space as computed by the most recent Update(). RigDynamicsSimulationSpace.h  

void Reset ( const FTransform& InComponentTM,
const FTransform& InSimulationSpaceTM
)

 This sets the position/orientation, and resets everything else. RigDynamicsSimulationSpace.h  

void Update ( const FRigDynamicsTeleportDetectionSettings& TeleportDetection,
const FTransform& InComponentTM,
const FTransform& InSimulationSpaceTM,
float DeltaTime
)

 If DeltaTime > 0 then this does a full update, calculating new velocities etc. RigDynamicsSimulationSpace.h  
True if the most recent Update() call (with DeltaTime > 0) detected a teleport via the thresholds on FRigDynamicsTeleportDetectionSettings. RigDynamicsSimulationSpace.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page