1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceChaosDestruction

UNiagaraDataInterfaceChaosDestruction

Data Interface allowing sampling of Chaos Destruction data.

API > API/Plugins > API/Plugins/ChaosNiagara

Inheritance Hierarchy

References

   
Module ChaosNiagara
Header /Engine/Plugins/Experimental/ChaosNiagara/Source/ChaosNiagara/Classes/NiagaraDataInterfaceChaosDestruction.h
Include #include "NiagaraDataInterfaceChaosDestruction.h"

Syntax

UCLASS (EditInlineNew, Category="Chaos Niagara", Meta=(DisplayName="Chaos Destruction Data"))  
class UNiagaraDataInterfaceChaosDestruction : public UNiagaraDataInterface

Remarks

Data Interface allowing sampling of Chaos Destruction data.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta bool bApplyMaterialsFilter Materials Filter
Public variable UProperty Category, EditAnywhere, Meta bool bGetExternalBreakingData TODO: Explanatory comment
Public variable UProperty Category, Meta visibleanywhere bool bGetExternalCollisionData TODO: Explanatory comment
Public variable UProperty Category, Meta visibleanywhere bool bGetExternalTrailingData TODO: Explanatory comment
Protected variable TArray< Chaos::FBreakingDataExt > BreakingEvents  
Public variable UProperty Category, EditAnywhere, Meta TSet< TObjectPtr< UPhysicalMaterial > > ChaosBreakingMaterialSet TODO: Explanatory comment
Public variable UProperty Category, EditAnywhere, Meta TSet< TObjectPtr< AChaosSolverActor > > ChaosSolverActorSet Chaos Solver
Protected variable TArray< Chaos::FCollidingDataExt > CollisionEvents  
Protected variable TArray< FVector > ColorArray Colors for debugging particles.
Public variable UProperty Category, EditAnywhere, Meta int32 DataProcessFrequency Number of times the RBD collision data gets processed every second
Public variable UProperty Category, EditAnywhere, Meta EDataSortTypeEnum DataSortingType Sorting method to sort the collision data
Public variable UProperty Category, EditAnywhere, Meta EDataSourceTypeEnum DataSourceType  
Public variable UProperty Category, EditAnywhere, Meta EDebugTypeEnum DebugType Debug visualization method
Public variable UProperty Category, EditAnywhere, Meta bool DoSpatialHash  
Public variable UProperty Category, EditAnywhere, Meta bool DoSpawn Turn on/off particle spawning
Public variable UProperty Category, EditAnywhere, Meta FVector2D ExtentMaxToSpawnMinMax Min/Max ExtentMax to spawn particles
Public variable UProperty Category, EditAnywhere, Meta FVector2D ExtentMinToSpawnMinMax Min/Max ExtentMin to spawn particles
Public variable UProperty Category, EditAnywhere, Meta FVector2D FinalVelocityMagnitudeMinMax Clamp particles velocity
Public variable UProperty Category, EditAnywhere, Meta FVector2D ImpulseToSpawnMinMax Min/Max collision accumulated impulse to spawn particles
Public variable UProperty Category, EditAnywhere, Meta float InheritedVelocityMultiplier How much of the collision velocity gets inherited
Protected variable UProperty int32 LastSpawnedPointID  
Protected variable UProperty float LastSpawnTime  
Public variable UProperty Category, EditAnywhere, Meta ELocationFilteringModeEnum LocationFilteringMode Location Filtering Mode
Public variable UProperty Category, EditAnywhere, Meta ELocationXToSpawnEnum LocationXToSpawn How to use LocationX to filter
Public variable UProperty Category, EditAnywhere, Meta FVector2D LocationXToSpawnMinMax Min/Max LocationX to spawn particles
Public variable UProperty Category, EditAnywhere, Meta ELocationYToSpawnEnum LocationYToSpawn How to use LocationY to filter
Public variable UProperty Category, EditAnywhere, Meta FVector2D LocationYToSpawnMinMax Min/Max LocationY to spawn particles
Public variable UProperty Category, EditAnywhere, Meta ELocationZToSpawnEnum LocationZToSpawn How to use LocationZ to filter
Public variable UProperty Category, EditAnywhere, Meta FVector2D LocationZToSpawnMinMax Min/Max LocationX to spawn particles
Public variable UProperty Category, EditAnywhere, Meta FVector2D MassToSpawnMinMax Min/Max mass to spawn particles
Public variable UProperty Category, EditAnywhere, Meta int32 MaxDataPerCell  
Public variable UProperty Category, EditAnywhere, Meta float MaxLatency  
Public variable UProperty Category, EditAnywhere, Meta int32 MaxNumberOfDataEntriesToSpawn Maximum number of collision/breaking/trailing entry used for spawning particles every time data from the physics solver gets processed
Public variable UProperty Category, EditAnywhere, Meta FVector2D RandomPositionMagnitudeMinMax Random displacement value for the particle spawn position
Public variable UProperty Category, EditAnywhere, Meta ERandomVelocityGenerationTypeEnum RandomVelocityGenerationType The method used to create the random velocities for the newly spawned particles
Public variable UProperty Category, EditAnywhere, Meta FVector2D RandomVelocityMagnitudeMinMax Every particles will be spawned with random velocity with magnitude in the range of [RandomVelocityMagnitudeMin, RandomVelocityMagnitudeMax]
Protected variable bool ShouldSpawn  
Protected variable TArray< FSolverData > Solvers  
Protected variable UProperty float SolverTime  
Public variable UProperty Category, EditAnywhere, Meta FVector2D SolverTimeToSpawnMinMax Min/Max solver time mass to spawn particles
Public variable UProperty Category, EditAnywhere, Meta FVector SpatialHashVolumeCellSize SpatialHash volume resolution
Public variable UProperty Category, EditAnywhere, Meta FVector SpatialHashVolumeMax SpatialHash volume max
Public variable UProperty Category, EditAnywhere, Meta FVector SpatialHashVolumeMin SpatialHash volume min
Public variable UProperty Category, EditAnywhere, Meta float SpawnChance For every collision random number of particles will be spawned in the range of [SpawnMultiplierMin, SpawnMultiplierMax]
Public variable UProperty Category, EditAnywhere, Meta FVector2D SpawnMultiplierMinMax For every collision random number of particles will be spawned in the range of [SpawnMultiplierMin, SpawnMultiplierMax]
Public variable UProperty Category, EditAnywhere, Meta FVector2D SpeedToSpawnMinMax Min/Max speed to spawn particles
Public variable UProperty Category, EditAnywhere, Meta float SpreadAngleMax  
Public variable UProperty Category, EditAnywhere, Meta int32 SurfaceTypeToSpawn SurfaceType to spawn particles
Protected variable UProperty float TimeStampOfLastProcessedData  
Protected variable TArray< Chaos::FTrailingDataExt > TrailingEvents  
Protected variable TSet< TWeakObjectPtr< UGeometryCollectionComponent > > TrailingGeometryCollectionComponents Geometry collection to track for trailing
Public variable UProperty Category, EditAnywhere, Meta float TrailMinSpeedToSpawn Min Linear Speed to generate trailing particles
Public variable UProperty Category, EditAnywhere, Meta FVector VelocityOffsetMax Max Offset value added to spawned particles velocity
Public variable UProperty Category, EditAnywhere, Meta FVector VelocityOffsetMin Min Offset value added to spawned particles velocity
Public variable UProperty Category, EditAnywhere, Meta FVector2D VolumeToSpawnMinMax Min/Max volume to spawn particles

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function bool  
Public function Static bool  
Public function Static bool  
Public function Static bool  
Protected function bool  
Public function Static bool  
Public function Static bool Sort predicates to sort data.
Public function Static bool  
Protected function void  
Protected function void  
Protected function void  
Public function void

GetAngularVelocity ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetBreakingData ( FVectorVMExternalFunctionContext& Context
)

  
Protected function void  
Public function void

GetCollisionData ( FVectorVMExternalFunctionContext& Context
)

  
Protected function void  
Public function void

GetColor ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetDensity ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetExtentMax ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetExtentMin ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetFriction ( FVectorVMExternalFunctionContext& Context
)

  
Public function int32  
Public function void

GetNormal ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetParticleIdsToSpawnAtTime ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetPointType ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetPosition ( FVectorVMExternalFunctionContext& Context
)

 EXPOSED FUNCTIONS.
Public function void

GetRestitution ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetSize ( FVectorVMExternalFunctionContext& Context
)

  
Public function float  
Public function void

GetSolverTime ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetSurfaceType ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetTrailingData ( FVectorVMExternalFunctionContext& Context
)

  
Protected function void  
Public function void

GetTransform ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetVelocity ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetVolume ( FVectorVMExternalFunctionContext& Context
)

  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function int32

SpawnParticlesFromBreaking ( FSolverData SolverData,
Chaos::FBreakingDataExt& Breaking,
FNDIChaosDestruction_InstanceData* InstData,
float TimeData_MapsCreated,
int32 IdxSolver
)

  
Protected function int32

SpawnParticlesFromCollision ( FSolverData SolverData,
Chaos::FCollidingDataExt& Collision,
FNDIChaosDestruction_InstanceData* InstData,
float TimeData_MapsCreated,
int32 IdxSolver
)

  
Protected function int32

SpawnParticlesFromTrailing ( FSolverData SolverData,
Chaos::FTrailingDataExt& Trailing,
FNDIChaosDestruction_InstanceData* InstData,
float TimeData_MapsCreated,
int32 IdxSolver
)

  
Protected function bool  
Public function Static bool  
Public function Static bool  
Public function Static bool  

Overridden from UNiagaraDataInterface

  Type Name Description
Public function Virtual Const bool GPU sim functionality.
Public function Virtual Const bool  
Protected function Virtual Const bool  
Public function Virtual void

DestroyPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Destroys the per instance data for this interface.
Public function Virtual Const bool

Equals ( const UNiagaraDataInterface* Other
)

 Determines if this DataInterface is the same as another.
Public function Virtual bool

GetFunctionHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
const FNiagaraDataInterfaceGeneratedFunction& FunctionInfo,
int FunctionInstanceIndex,
FString& OutHLSL
)

  
Protected function Virtual Const void  
Public function Virtual void  
Public function Virtual void

GetVMExternalFunction ( const FVMExternalFunctionBindingInfo& BindingInfo,
void* InstanceData,
FVMExternalFunction& OutFunc
)

 Returns the delegate for the passed function signature.
Public function Virtual Const bool  
Public function Virtual bool

InitPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Initializes the per instance data for this interface.
Public function Virtual Const int32 Returns the size of the per instance data for this interface.
Public function Virtual bool

PerInstanceTick ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance,
float DeltaSeconds
)

 Ticks the per instance data for this interface, if it has any.
Public function Virtual void

ProvidePerInstanceDataForRenderThread ( void* DataForRenderThread,
void* PerInstanceData,
const FNiagaraSystemInstanceID& SystemInstance
)

 Subclasses that wish to work with GPU systems/emitters must implement this.
Protected function Virtual void  
Public function Virtual Const void Set the shader parameters will only be called if the data interface provided shader parameters.

Overridden from UNiagaraDataInterfaceBase

  Type Name Description
Public function Virtual Const void Override this method to provide parameters to the GPU (SRV / UAV / Constants / etc) The most common usage will be to provide a single structure which is nested with other parameters.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void ParticleIndex to process collisionData for
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page