Navigation
API > API/Plugins > API/Plugins/ChaosNiagara
Data Interface allowing sampling of Chaos Destruction data.
| Name | UNiagaraDataInterfaceChaosDestruction |
| Type | class |
| Header File | /Engine/Plugins/Experimental/ChaosNiagara/Source/ChaosNiagara/Classes/NiagaraDataInterfaceChaosDestruction.h |
| Include Path | #include "NiagaraDataInterfaceChaosDestruction.h" |
Syntax
UCLASS (MinimalAPI, EditInlineNew, Category="Chaos Niagara",
Meta=(DisplayName="Chaos Destruction Data"))
class UNiagaraDataInterfaceChaosDestruction : public UNiagaraDataInterface
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UNiagaraNotifyOnChanged → UNiagaraDataInterfaceBase → UNiagaraDataInterface → UNiagaraDataInterfaceChaosDestruction
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UNiagaraDataInterfaceChaosDestruction
(
const FObjectInitializer& ObjectInitializer |
NiagaraDataInterfaceChaosDestruction.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bApplyMaterialsFilter | bool | Materials Filter | NiagaraDataInterfaceChaosDestruction.h |
|
| bGetExternalBreakingData | bool | TODO: Explanatory comment | NiagaraDataInterfaceChaosDestruction.h |
|
| bGetExternalCollisionData | bool | TODO: Explanatory comment | NiagaraDataInterfaceChaosDestruction.h |
|
| bGetExternalTrailingData | bool | TODO: Explanatory comment | NiagaraDataInterfaceChaosDestruction.h |
|
| ChaosBreakingMaterialSet | TSet< TObjectPtr< UPhysicalMaterial > > | TODO: Explanatory comment | NiagaraDataInterfaceChaosDestruction.h |
|
| ChaosSolverActorSet | TSet< TObjectPtr< AChaosSolverActor > > | Chaos Solver | NiagaraDataInterfaceChaosDestruction.h |
|
| DataProcessFrequency | int32 | Number of times the RBD collision data gets processed every second | NiagaraDataInterfaceChaosDestruction.h |
|
| DataSortingType | EDataSortTypeEnum | Sorting method to sort the collision data | NiagaraDataInterfaceChaosDestruction.h |
|
| DataSourceType | EDataSourceTypeEnum | NiagaraDataInterfaceChaosDestruction.h |
|
|
| DebugType | EDebugTypeEnum | Debug visualization method | NiagaraDataInterfaceChaosDestruction.h |
|
| DoSpatialHash | bool | NiagaraDataInterfaceChaosDestruction.h |
|
|
| DoSpawn | bool | Turn on/off particle spawning | NiagaraDataInterfaceChaosDestruction.h |
|
| ExtentMaxToSpawnMinMax | FVector2D | Min/Max ExtentMax to spawn particles | NiagaraDataInterfaceChaosDestruction.h |
|
| ExtentMinToSpawnMinMax | FVector2D | Min/Max ExtentMin to spawn particles | NiagaraDataInterfaceChaosDestruction.h |
|
| FinalVelocityMagnitudeMinMax | FVector2D | Clamp particles velocity | NiagaraDataInterfaceChaosDestruction.h |
|
| ImpulseToSpawnMinMax | FVector2D | Min/Max collision accumulated impulse to spawn particles | NiagaraDataInterfaceChaosDestruction.h |
|
| InheritedVelocityMultiplier | float | How much of the collision velocity gets inherited | NiagaraDataInterfaceChaosDestruction.h |
|
| LocationFilteringMode | ELocationFilteringModeEnum | Location Filtering Mode | NiagaraDataInterfaceChaosDestruction.h |
|
| LocationXToSpawn | ELocationXToSpawnEnum | How to use LocationX to filter | NiagaraDataInterfaceChaosDestruction.h |
|
| LocationXToSpawnMinMax | FVector2D | Min/Max LocationX to spawn particles | NiagaraDataInterfaceChaosDestruction.h |
|
| LocationYToSpawn | ELocationYToSpawnEnum | How to use LocationY to filter | NiagaraDataInterfaceChaosDestruction.h |
|
| LocationYToSpawnMinMax | FVector2D | Min/Max LocationY to spawn particles | NiagaraDataInterfaceChaosDestruction.h |
|
| LocationZToSpawn | ELocationZToSpawnEnum | How to use LocationZ to filter | NiagaraDataInterfaceChaosDestruction.h |
|
| LocationZToSpawnMinMax | FVector2D | Min/Max LocationX to spawn particles | NiagaraDataInterfaceChaosDestruction.h |
|
| MassToSpawnMinMax | FVector2D | Min/Max mass to spawn particles | NiagaraDataInterfaceChaosDestruction.h |
|
| MaxDataPerCell | int32 | NiagaraDataInterfaceChaosDestruction.h |
|
|
| MaxLatency | float | NiagaraDataInterfaceChaosDestruction.h |
|
|
| MaxNumberOfDataEntriesToSpawn | int32 | Maximum number of collision/breaking/trailing entry used for spawning particles every time data from the physics solver gets processed | NiagaraDataInterfaceChaosDestruction.h |
|
| RandomPositionMagnitudeMinMax | FVector2D | Random displacement value for the particle spawn position | NiagaraDataInterfaceChaosDestruction.h |
|
| RandomVelocityGenerationType | ERandomVelocityGenerationTypeEnum | The method used to create the random velocities for the newly spawned particles | NiagaraDataInterfaceChaosDestruction.h |
|
| RandomVelocityMagnitudeMinMax | FVector2D | Every particles will be spawned with random velocity with magnitude in the range of [RandomVelocityMagnitudeMin, RandomVelocityMagnitudeMax] | NiagaraDataInterfaceChaosDestruction.h |
|
| SolverTimeToSpawnMinMax | FVector2D | Min/Max solver time mass to spawn particles | NiagaraDataInterfaceChaosDestruction.h |
|
| SpatialHashVolumeCellSize | FVector | SpatialHash volume resolution | NiagaraDataInterfaceChaosDestruction.h |
|
| SpatialHashVolumeMax | FVector | SpatialHash volume max | NiagaraDataInterfaceChaosDestruction.h |
|
| SpatialHashVolumeMin | FVector | SpatialHash volume min | NiagaraDataInterfaceChaosDestruction.h |
|
| SpawnChance | float | For every collision random number of particles will be spawned in the range of [SpawnMultiplierMin, SpawnMultiplierMax] | NiagaraDataInterfaceChaosDestruction.h |
|
| SpawnMultiplierMinMax | FVector2D | For every collision random number of particles will be spawned in the range of [SpawnMultiplierMin, SpawnMultiplierMax] | NiagaraDataInterfaceChaosDestruction.h |
|
| SpeedToSpawnMinMax | FVector2D | Min/Max speed to spawn particles | NiagaraDataInterfaceChaosDestruction.h |
|
| SpreadAngleMax | float | NiagaraDataInterfaceChaosDestruction.h |
|
|
| SurfaceTypeToSpawn | int32 | SurfaceType to spawn particles | NiagaraDataInterfaceChaosDestruction.h |
|
| TrailMinSpeedToSpawn | float | Min Linear Speed to generate trailing particles | NiagaraDataInterfaceChaosDestruction.h |
|
| VelocityOffsetMax | FVector | Max Offset value added to spawned particles velocity | NiagaraDataInterfaceChaosDestruction.h |
|
| VelocityOffsetMin | FVector | Min Offset value added to spawned particles velocity | NiagaraDataInterfaceChaosDestruction.h |
|
| VolumeToSpawnMinMax | FVector2D | Min/Max volume to spawn particles | NiagaraDataInterfaceChaosDestruction.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void GetAngularVelocity
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetBreakingData
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetCollisionData
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetColor
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetDensity
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetExtentMax
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetExtentMin
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetFriction
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceChaosDestruction.h | ||
int32 GetLastSpawnedPointID() |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetNormal
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetParticleIdsToSpawnAtTime
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetPointType
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetPosition
(
FVectorVMExternalFunctionContext& Context |
EXPOSED FUNCTIONS. | NiagaraDataInterfaceChaosDestruction.h | |
void GetRestitution
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetSize
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceChaosDestruction.h | ||
float GetSolverTime () |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetSolverTime
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetSurfaceType
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetTrailingData
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetTransform
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetVelocity
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetVolume
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceChaosDestruction.h |
Overridden from UNiagaraDataInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool AppendCompileHash
(
FNiagaraCompileHashVisitor* InVisitor |
GPU sim functionality. | NiagaraDataInterfaceChaosDestruction.h | |
virtual bool CanExecuteOnTarget
(
ENiagaraSimTarget Target |
NiagaraDataInterfaceChaosDestruction.h | ||
virtual void DestroyPerInstanceData
(
void* PerInstanceData, |
NiagaraDataInterfaceChaosDestruction.h | ||
virtual bool Equals
(
const UNiagaraDataInterface* Other |
NiagaraDataInterfaceChaosDestruction.h | ||
virtual bool GetFunctionHLSL
(
const FNiagaraDataInterfaceGPUParamInfo& ParamInfo, |
NiagaraDataInterfaceChaosDestruction.h | ||
virtual void GetParameterDefinitionHLSL
(
const FNiagaraDataInterfaceGPUParamInfo& ParamInfo, |
NiagaraDataInterfaceChaosDestruction.h | ||
virtual void GetVMExternalFunction
(
const FVMExternalFunctionBindingInfo& BindingInfo, |
NiagaraDataInterfaceChaosDestruction.h | ||
virtual bool HasPreSimulateTick() |
NiagaraDataInterfaceChaosDestruction.h | ||
virtual bool InitPerInstanceData
(
void* PerInstanceData, |
NiagaraDataInterfaceChaosDestruction.h | ||
virtual int32 PerInstanceDataSize() |
NiagaraDataInterfaceChaosDestruction.h | ||
virtual bool PerInstanceTick
(
void* PerInstanceData, |
NiagaraDataInterfaceChaosDestruction.h | ||
virtual void ProvidePerInstanceDataForRenderThread
(
void* DataForRenderThread, |
NiagaraDataInterfaceChaosDestruction.h | ||
virtual void SetShaderParameters
(
const FNiagaraDataInterfaceSetShaderParametersContext& Context |
NiagaraDataInterfaceChaosDestruction.h |
Overridden from UNiagaraDataInterfaceBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BuildShaderParameters
(
FNiagaraShaderParametersBuilder& ShaderParametersBuilder |
NiagaraDataInterfaceChaosDestruction.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
NiagaraDataInterfaceChaosDestruction.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
NiagaraDataInterfaceChaosDestruction.h | ||
virtual void PostInitProperties() |
ParticleIndex to process collisionData for | NiagaraDataInterfaceChaosDestruction.h | |
virtual void PostLoad() |
NiagaraDataInterfaceChaosDestruction.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool BreakingCallback
(
FNDIChaosDestruction_InstanceData* InstData |
NiagaraDataInterfaceChaosDestruction.h | ||
bool CollisionCallback
(
FNDIChaosDestruction_InstanceData* InstData |
NiagaraDataInterfaceChaosDestruction.h | ||
void FilterAllBreakings
(
TArray< Chaos::FBreakingDataExt >& AllBreakingsArray |
NiagaraDataInterfaceChaosDestruction.h | ||
void FilterAllCollisions
(
TArray< Chaos::FCollidingDataExt >& AllCollisionsArray |
NiagaraDataInterfaceChaosDestruction.h | ||
void FilterAllTrailings
(
TArray< Chaos::FTrailingDataExt >& AllTrailingsArray |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetBreakingsToSpawnFromBreakings
(
TArray< Chaos::FBreakingDataExt >& AllBreakingsArray, |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetCollisionsToSpawnFromCollisions
(
TArray< Chaos::FCollidingDataExt >& AllCollisionsArray, |
NiagaraDataInterfaceChaosDestruction.h | ||
void GetTrailingsToSpawnFromTrailings
(
TArray< Chaos::FTrailingDataExt >& AllTrailingsArray, |
NiagaraDataInterfaceChaosDestruction.h | ||
void HandleBreakingEvents
(
const Chaos::FBreakingEventData& Event |
NiagaraDataInterfaceChaosDestruction.h | ||
void HandleCollisionEvents
(
const Chaos::FCollisionEventData& Event |
NiagaraDataInterfaceChaosDestruction.h | ||
void HandleTrailingEvents
(
const Chaos::FTrailingEventData& Event |
NiagaraDataInterfaceChaosDestruction.h | ||
void RegisterWithSolverEventManager
(
Chaos::FPhysicsSolver* Solver |
NiagaraDataInterfaceChaosDestruction.h | ||
void ResetInstData
(
FNDIChaosDestruction_InstanceData* InstData |
NiagaraDataInterfaceChaosDestruction.h | ||
void SortBreakings
(
TArray< Chaos::FBreakingDataExt >& BreakingsArray |
NiagaraDataInterfaceChaosDestruction.h | ||
void SortCollisions
(
TArray< Chaos::FCollidingDataExt >& CollisionsArray |
NiagaraDataInterfaceChaosDestruction.h | ||
void SortTrailings
(
TArray< Chaos::FTrailingDataExt >& TrailingsArray |
NiagaraDataInterfaceChaosDestruction.h | ||
int32 SpawnParticlesFromBreaking
(
FSolverData SolverData, |
NiagaraDataInterfaceChaosDestruction.h | ||
int32 SpawnParticlesFromCollision
(
FSolverData SolverData, |
NiagaraDataInterfaceChaosDestruction.h | ||
int32 SpawnParticlesFromTrailing
(
FSolverData SolverData, |
NiagaraDataInterfaceChaosDestruction.h | ||
bool TrailingCallback
(
FNDIChaosDestruction_InstanceData* InstData |
NiagaraDataInterfaceChaosDestruction.h |
Overridden from UNiagaraDataInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CopyToInternal
(
UNiagaraDataInterface* Destination |
NiagaraDataInterfaceChaosDestruction.h | ||
virtual void GetFunctionsInternal
(
TArray< FNiagaraFunctionSignature >& OutFunctions |
NiagaraDataInterfaceChaosDestruction.h | ||
virtual void PushToRenderThreadImpl() |
NiagaraDataInterfaceChaosDestruction.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool BreakingDataRandomShuffleSortPredicate
(
const Chaos::FBreakingDataExt& Lhs, |
NiagaraDataInterfaceChaosDestruction.h | ||
static bool BreakingDataSortByMassPredicateMaxToMin
(
const Chaos::FBreakingDataExt& Lhs, |
NiagaraDataInterfaceChaosDestruction.h | ||
static bool BreakingDataSortByMassPredicateMinToMax
(
const Chaos::FBreakingDataExt& Lhs, |
NiagaraDataInterfaceChaosDestruction.h | ||
static bool CollisionDataRandomShuffleSortPredicate
(
const Chaos::FCollidingDataExt& Lhs, |
NiagaraDataInterfaceChaosDestruction.h | ||
static bool CollisionDataSortByMassPredicateMaxToMin
(
const Chaos::FCollidingDataExt& Lhs, |
Sort predicates to sort data. | NiagaraDataInterfaceChaosDestruction.h | |
static bool CollisionDataSortByMassPredicateMinToMax
(
const Chaos::FCollidingDataExt& Lhs, |
NiagaraDataInterfaceChaosDestruction.h | ||
static bool TrailingDataRandomShuffleSortPredicate
(
const Chaos::FTrailingDataExt& Lhs, |
NiagaraDataInterfaceChaosDestruction.h | ||
static bool TrailingDataSortByMassPredicateMaxToMin
(
const Chaos::FTrailingDataExt& Lhs, |
NiagaraDataInterfaceChaosDestruction.h | ||
static bool TrailingDataSortByMassPredicateMinToMax
(
const Chaos::FTrailingDataExt& Lhs, |
NiagaraDataInterfaceChaosDestruction.h |