Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > ChaosNiagara > UNiagaraDataInterfaceChaosDestruction

Light Theme

Dark Theme

UNiagaraDataInterfaceChaosDestruction

Data Interface allowing sampling of Chaos Destruction data.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraDataInterfaceBase

UNiagaraDataInterface

UNiagaraDataInterfaceChaosDestruction

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, Category="Chaos Niagara", Meta=(DisplayName="Chaos Destruction Data"))
class UNiagaraDataInterfaceChaosDestruction : public UNiagaraDataInterface

Remarks

Data Interface allowing sampling of Chaos Destruction data.

Variables

	Name	Description
bool	bApplyMaterialsFilter	Materials Filter
bool	bGetExternalBreakingData	TODO: Explanatory comment
bool	bGetExternalCollisionData	TODO: Explanatory comment
bool	bGetExternalTrailingData	TODO: Explanatory comment
TArray< Chaos::...	BreakingEvents
TSet< UPhysical...	ChaosBreakingMaterialSet	TODO: Explanatory comment
TSet< AChaosSol...	ChaosSolverActorSet	Chaos Solver
TArray< Chaos::...	CollisionEvents
TArray< FVector...	ColorArray	Colors for debugging particles.
int32	DataProcessFrequency	Number of times the RBD collision data gets processed every second
EDataSortTypeEn...	DataSortingType	Sorting method to sort the collision data
EDataSourceType...	DataSourceType
EDebugTypeEnum	DebugType	Debug visualization method
bool	DoSpatialHash
bool	DoSpawn	Turn on/off particle spawning
FVector2D	ExtentMaxToSpawnMinMax	Min/Max ExtentMax to spawn particles
FVector2D	ExtentMinToSpawnMinMax	Min/Max ExtentMin to spawn particles
FVector2D	FinalVelocityMagnitudeMinMax	Clamp particles velocity
FVector2D	ImpulseToSpawnMinMax	Min/Max collision accumulated impulse to spawn particles
float	InheritedVelocityMultiplier	How much of the collision velocity gets inherited
int32	LastSpawnedPointID
float	LastSpawnTime
ELocationFilter...	LocationFilteringMode	Location Filtering Mode
ELocationXToSpa...	LocationXToSpawn	How to use LocationX to filter
FVector2D	LocationXToSpawnMinMax	Min/Max LocationX to spawn particles
ELocationYToSpa...	LocationYToSpawn	How to use LocationY to filter
FVector2D	LocationYToSpawnMinMax	Min/Max LocationY to spawn particles
ELocationZToSpa...	LocationZToSpawn	How to use LocationZ to filter
FVector2D	LocationZToSpawnMinMax	Min/Max LocationX to spawn particles
FVector2D	MassToSpawnMinMax	Min/Max mass to spawn particles
int32	MaxDataPerCell
float	MaxLatency
int32	MaxNumberOfDataEntriesToSpawn	Maximum number of collision/breaking/trailing entry used for spawning particles every time data from the physics solver gets processed
FVector2D	RandomPositionMagnitudeMinMax	Random displacement value for the particle spawn position
ERandomVelocity...	RandomVelocityGenerationType	The method used to create the random velocities for the newly spawned particles
FVector2D	RandomVelocityMagnitudeMinMax	Every particles will be spawned with random velocity with magnitude in the range of [RandomVelocityMagnitudeMin, RandomVelocityMagnitudeMax]
bool	ShouldSpawn
TArray< FSolver...	Solvers
float	SolverTime
FVector2D	SolverTimeToSpawnMinMax	Min/Max solver time mass to spawn particles
FVector	SpatialHashVolumeCellSize	SpatialHash volume resolution
FVector	SpatialHashVolumeMax	SpatialHash volume max
FVector	SpatialHashVolumeMin	SpatialHash volume min
float	SpawnChance	For every collision random number of particles will be spawned in the range of [SpawnMultiplierMin, SpawnMultiplierMax]
FVector2D	SpawnMultiplierMinMax	For every collision random number of particles will be spawned in the range of [SpawnMultiplierMin, SpawnMultiplierMax]
FVector2D	SpeedToSpawnMinMax	Min/Max speed to spawn particles
float	SpreadAngleMax
int32	SurfaceTypeToSpawn	SurfaceType to spawn particles
float	TimeStampOfLastProcessedData
TArray< Chaos::...	TrailingEvents
FVector	VelocityOffsetMax	Max Offset value added to spawned particles velocity
FVector	VelocityOffsetMin	Min Offset value added to spawned particles velocity
FVector2D	VolumeToSpawnMinMax	Min/Max volume to spawn particles

Constructors

	Name	Description
	UNiagaraDataInterfaceChaosDestruction ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
bool	BreakingCallback ( FNDIChaosDestruction_InstanceData&... )
bool	BreakingDataRandomShuffleSortPredicate ( const Chaos::TBreakingDataExt< floa..., const Chaos::TBreakingDataExt< floa... )
bool	BreakingDataSortByMassPredicateMaxToMin ( const Chaos::TBreakingDataExt< floa..., const Chaos::TBreakingDataExt< floa... )
bool	BreakingDataSortByMassPredicateMinToMax ( const Chaos::TBreakingDataExt< floa..., const Chaos::TBreakingDataExt< floa... )
bool	CollisionCallback ( FNDIChaosDestruction_InstanceData&... )
bool	CollisionDataRandomShuffleSortPredicate ( const Chaos::TCollisionDataExt< flo..., const Chaos::TCollisionDataExt< flo... )
bool	CollisionDataSortByMassPredicateMaxToMin ( const Chaos::TCollisionDataExt< flo..., const Chaos::TCollisionDataExt< flo... )	Sort predicates to sort data.
bool	CollisionDataSortByMassPredicateMinToMax ( const Chaos::TCollisionDataExt< flo..., const Chaos::TCollisionDataExt< flo... )
void	FilterAllBreakings ( TArray< Chaos::TBreakingDataExt< fl... )
void	FilterAllCollisions ( TArray< Chaos::TCollisionDataExt< f... )
void	FilterAllTrailings ( TArray< Chaos::TTrailingDataExt< fl... )
void	GetAngularVelocity ( FVectorVMContext& Context )
void	GetBreakingData ( FVectorVMContext& Context )
void	GetBreakingsToSpawnFromBreakings ( TArray< Chaos::TBreakingDataExt< fl..., TArray< Chaos::TBreakingDataExt< fl... )
void	GetCollisionData ( FVectorVMContext& Context )
void	GetCollisionsToSpawnFromCollisions ( TArray< Chaos::TCollisionDataExt< f..., TArray< Chaos::TCollisionDataExt< f... )
void	GetColor ( FVectorVMContext& Context )
void	GetDensity ( FVectorVMContext& Context )
void	GetExtentMax ( FVectorVMContext& Context )
void	GetExtentMin ( FVectorVMContext& Context )
void	GetFriction ( FVectorVMContext& Context )
int32	GetLastSpawnedPointID()
void	GetNormal ( FVectorVMContext& Context )
void	GetParticleIdsToSpawnAtTime ( FVectorVMContext& Context )
void	GetPointType ( FVectorVMContext& Context )
void	GetPosition ( FVectorVMContext& Context )	EXPOSED FUNCTIONS.
void	GetRestitution ( FVectorVMContext& Context )
void	GetSize ( FVectorVMContext& Context )
float	GetSolverTime()
void	GetSolverTime ( FVectorVMContext& Context )
void	GetSurfaceType ( FVectorVMContext& Context )
void	GetTrailingData ( FVectorVMContext& Context )
void	GetTrailingsToSpawnFromTrailings ( TArray< Chaos::TTrailingDataExt< fl..., TArray< Chaos::TTrailingDataExt< fl... )
void	GetTransform ( FVectorVMContext& Context )
void	GetVelocity ( FVectorVMContext& Context )
void	GetVolume ( FVectorVMContext& Context )
void	HandleBreakingEvents ( const Chaos::FBreakingEventData& E... )
void	HandleCollisionEvents ( const Chaos::FCollisionEventData& ... )
void	HandleTrailingEvents ( const Chaos::FTrailingEventData& E... )
void	PushToRenderThread()
void	ResetInstData ( FNDIChaosDestruction_InstanceData&... )
void	SortBreakings ( TArray< Chaos::TBreakingDataExt< fl... )
void	SortCollisions ( TArray< Chaos::TCollisionDataExt< f... )
void	SortTrailings ( TArray< Chaos::TTrailingDataExt< fl... )
int32	SpawnParticlesFromBreaking ( FSolverData SolverData, Chaos::TBreakingDataExt< float, 3 >..., FNDIChaosDestruction_InstanceData&..., float TimeData_MapsCreated, int32 IdxSolver )
int32	SpawnParticlesFromCollision ( FSolverData SolverData, Chaos::TCollisionDataExt< float, 3 ..., FNDIChaosDestruction_InstanceData&..., float TimeData_MapsCreated, int32 IdxSolver )
int32	SpawnParticlesFromTrailing ( FSolverData SolverData, Chaos::TTrailingDataExt< float, 3 >..., FNDIChaosDestruction_InstanceData&..., float TimeData_MapsCreated, int32 IdxSolver )
bool	TrailingCallback ( FNDIChaosDestruction_InstanceData&... )
bool	TrailingDataRandomShuffleSortPredicate ( const Chaos::TTrailingDataExt< floa..., const Chaos::TTrailingDataExt< floa... )
bool	TrailingDataSortByMassPredicateMaxToMin ( const Chaos::TTrailingDataExt< floa..., const Chaos::TTrailingDataExt< floa... )
bool	TrailingDataSortByMassPredicateMinToMax ( const Chaos::TTrailingDataExt< floa..., const Chaos::TTrailingDataExt< floa... )

Overridden from UNiagaraDataInterface

	Name	Description
bool	CanExecuteOnTarget ( ENiagaraSimTarget Target )
bool	CopyToInternal ( UNiagaraDataInterface* Destina... )
void	DestroyPerInstanceData ( void* PerInstanceData, FNiagaraSystemInstance* System... )	Destroys the per instance data for this interface.
bool	Equals ( const UNiagaraDataInterface* O... )	Determines if this DataInterface is the same as another.
bool	GetFunctionHLSL ( const FNiagaraDataInterfaceGPUParam..., const FNiagaraDataInterfaceGenerate..., int FunctionInstanceIndex, FString& OutHLSL )
void	GetFunctions ( TArray< FNiagaraFunctionSignature >... )	Gets all the available functions for this data interface.
void	GetParameterDefinitionHLSL ( const FNiagaraDataInterfaceGPUParam..., FString& OutHLSL )	GPU sim functionality.
void	GetVMExternalFunction ( const FVMExternalFunctionBindingInf..., void* InstanceData, FVMExternalFunction& OutFunc )	Returns the delegate for the passed function signature.
bool	InitPerInstanceData ( void* PerInstanceData, FNiagaraSystemInstance* System... )	Initializes the per instance data for this interface.
int32	PerInstanceDataSize()	Returns the size of the per instance data for this interface.
bool	PerInstanceTick ( void* PerInstanceData, FNiagaraSystemInstance* System..., float DeltaSeconds )	Ticks the per instance data for this interface, if it has any.
void	ProvidePerInstanceDataForRenderThread ( void* DataForRenderThread, void* PerInstanceData, const FNiagaraSystemInstanceID& Sy... )	Subclasses that wish to work with GPU systems/emitters must implement this.

Overridden from UNiagaraDataInterfaceBase

	Name	Description
void	BindParameters ( FNiagaraDataInterfaceParametersCS&..., const FNiagaraDataInterfaceGPUParam..., const FShaderParameterMap& Paramet... )	Methods that operate on an instance of type FNiagaraDataInterfaceParametersCS*, created by the above CreateComputeParameters() method
FNiagaraData...	CreateComputeParameters()	Constructs the correct CS parameter type for this DI (if any).
const FTypeL...	GetComputeParametersTypeDesc()
void	SetParameters ( const FNiagaraDataInterfaceParamete..., FRHICommandList& RHICmdList, const FNiagaraDataInterfaceSetArgs ... )
void	UnsetParameters ( const FNiagaraDataInterfaceParamete..., FRHICommandList& RHICmdList, const FNiagaraDataInterfaceSetArgs ... )

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	TGeometryParticleHandle* ParticleToProcess;.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss