1. Epic GamesDeveloper
  3. ISimulationModuleBase

ISimulationModuleBase

Interface base class for all simulation module building blocks

API > API/Runtime > API/Runtime/ChaosVehiclesCore > API/Runtime/ChaosVehiclesCore/SimModule

Inheritance Hierarchy

References

   
Module ChaosVehiclesCore
Header /Engine/Source/Runtime/Experimental/ChaosVehicles/ChaosVehiclesCore/Public/SimModule/SimulationModuleBase.h
Include #include "SimModule/SimulationModuleBase.h"

Syntax

class ISimulationModuleBase :  
    public Chaos::FSimulationModuleTypeContainer ,  
    public Chaos::TSimulationModuleTypeableBase< ISimulationModuleBase >

Remarks

Interface base class for all simulation module building blocks

Variables

  Type Name Description
Protected variable FVector AnimationOffset  
Protected variable FVector AnimationRotation  
Protected variable int AnimationSetupIndex  
Protected variable FVector AppliedForce For headless chaos testing
Protected variable bool bAnimationEnabled  
Protected variable bool bClustered  
Protected variable FName BoneName  
Protected variable FPBDRigidClusteredParticleHandle * CachedParticle  
Protected variable FTransform ClusteredCOMRelativeTransform  
Protected variable FTransform ComponentTransform  
Protected variable int Guid  
Protected variable FTransform InitialParticleTransform  
Protected variable FTransform IntactCOMRelativeTransform  
Public variable bool IsInitialized  
Protected variable FVector LocalAngularVelocity  
Protected variable FVector LocalLinearVelocity  
Protected variable FUniqueIdx ParticleIdx  
Protected variable FTransform RelativeOffsetTransform  
Protected variable FSimModuleTree * SimModuleTree  
Protected variable int SimTreeIndex  
Protected variable eSimModuleState StateFlags  
Protected variable int TransformIndex  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Static FName  
Public function void

AddForceAtCOMPosition ( const FVector& Force,
const FVector& OffsetFromCOM,
bool bAllowSubstepping,
bool bLevelSlope,
const FColor& DebugColorIn
)

  
Public function void

AddLocalForce ( const FVector& Force,
bool bAllowSubstepping,
bool bIsLocalForce,
bool bLevelSlope,
const FColor& DebugColorIn
)

 Force application function, handles deferred force application and applying the force at the collect location based on whether the GC cluster is intact or fractured Note: forces are applied in local coordinates of the module
Public function void

AddLocalForceAtPosition ( const FVector& Force,
const FVector& Position,
bool bAllowSubstepping,
bool bIsLocalForce,
bool bLevelSlope,
const FColor& DebugColorIn
)

 Force application function, handles deferred force application and applying the force at the collect location based on whether the GC cluster is intact or fractured Note: forces are applied in local coordinates of the module
Public function void

AddLocalTorque ( const FVector& Torque,
bool bAllowSubstepping,
bool bAccelChangeIn,
const FColor& DebugColorIn
)

 Torque application function Note: forces are applied in local coordinates of the module
Public function Virtual void Animate/modify the childToParent transforms, to say rotate a wheel, or rudder, etc
Public function Virtual void Option to draw debug for this module requires CVar p.Chaos.DebugDraw.Enabled 1
Public function Const TSharedPtr< FModuleNetData >

GenerateNetData ( const int32 NodeArrayIndex
)

 This is the replication datas
Public function Virtual Const FSimOutputData *  
Public function Const const FVector &  
Public function int  
Public function const FVector & For headless chaos testing
Public function Const const FName &  
Public function Const const FTransform &  
Public function Chaos::FPBDRigidClusteredParticleHandle * Void SetClusterParticle(FPBDRigidClusteredParticleHandle* ParticleIn) { ClusterParticle = ParticleIn; }
Public function Const const FTransform &  
Public function Const const FString Get the friendly name for this module, primarily for logging & debugging module tree
Public function Virtual Const bool

GetDebugString ( FString& StringOut
)

 Option to return debug text for drawing on the HUD in the Game Thread
Public function ISimulationModuleBase *  
Public function const int

GetGuid ()

  
Public function Const const FTransform &  
Public function Const const FTransform &  
Public function Const const FVector &  
Public function Const const FVector &  
Public function ISimulationModuleBase *  
Public function Const const FTransform & The modules transform relative to the simulating body will depend on whether the GC is intact (get the transform relative to intact cluster) or fractured (transform relative to fractured part)
Public function Chaos::FPBDRigidParticleHandle *  
Public function Const const FUniqueIdx  
Public function FVehicleBlackboard *  
Public function Const const int  
Public function Const int  
Public function bool  
Public function Const bool Is Module of a specific behavioral data type
Public function Const bool  
Public function Virtual Const bool Is Module active and simulating
Public function Virtual void Any post construction initialisation - called from Game Thread
Public function Virtual void  
Public function Virtual void Any cleaning up required - called from game thread
Public function void

SetAnimationData ( const FName& BoneNameIn,
const FVector& AnimationOffsetIn,
int AnimationSetupIndexIn
)

  
Public function void

SetAnimationEnabled ( bool bInEnabled
)

  
Public function void

SetClustered ( bool IsClusteredIn
)

 Let the module know if it is still clustered or not
Public function void

SetClusteredTransform ( const FTransform& TransformIn
)

 Set the COM relative transform of module when it is clustered, so relative to parent COM
Public function void

SetComponentTransform ( const FTransform& TransformIn
)

  
Public function void

SetGuid ( int GuidIn
)

  
Public function void

SetInitialParticleTransform ( const FTransform& TransformIn
)

  
Public function void

SetIntactTransform ( const FTransform& TransformIn
)

 Set the COM relative transform of module when it is broken off, so relative to itself
Public function void

SetLocalAngularVelocity ( const FVector& VelocityIn
)

  
Public function void

SetLocalLinearVelocity ( const FVector& VelocityIn
)

 Update the module with its current velocity
Public function void

SetParticleIndex ( FUniqueIdx ParticleIndexIn
)

 The Particle unique index, should be valid on game and physics threads
Public function void

SetSimModuleTree ( FSimModuleTree* SimModuleTreeIn
)

 Very useful to store the simulation tree pointer in which we are stored, then we can access other modules that we reference through an index
Public function void

SetStateFlags ( eSimModuleState StateFlagsIn
)

 Set Module state, if simulating or not
Public function void

SetTransformIndex ( int TransformIndexIn
)

 The transform index references the transform collection, mapping the simulation module to the geometry collection data
Public function void

SetTreeIndex ( int TreeIndexIn
)

 The modules own index in the simulation tree array
Public function Virtual void

Simulate ( float DeltaTime,
const FAllInputs& Inputs,
FSimModuleTree& VehicleModuleSystem
)

 The main Simulation function that is called from the physics async callback thread
Public function Virtual void

Simulate ( Chaos::FClusterUnionPhysicsProxy* Proxy,
float DeltaTime,
const FAllInputs& Inputs,
FSimModuleTree& VehicleModuleSystem
)

 The main Simulation function that is called from the physics async callback thread

Constants

Name Description
INVALID_IDX  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page