Navigation
API > API/Plugins > API/Plugins/Niagara
References
| Module | Niagara |
| Header | /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraSimCacheCompare.h |
| Include | #include "NiagaraSimCacheCompare.h" |
Syntax
struct FNiagaraSimCacheCompare
Remarks
Allows you to compare two simulation caches for equality, or approximate equality. Due to platform differences simulations may not be equal when comparing one generates from one platform to another. Therefore you may need to be more flexible with some attributes, like positions, velocity, when comparing caches and adjust the tolerance accordingly. Note: This class is Experimental and the API may change
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bExcludeNoneDeterministicVariables | Should we exclude known none deterministic variables, i.e. ID / MaterialRandom. | |
| bool | bIncludeDataInterfaces | Should we include data interface as part of the comparison. | |
| float | DefaultFloatTolerance | Default float tolerance when comparing caches | |
| TOptional< float > | DefaultQuaternionTolerance | Tolerance when comparing quaternions, if not set uses the default UE tolerance. |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddExcludeAttribute
(
FNiagaraVariableBase Variable |
Add an attribute to exclude from the comparison. | |
| bool | Compare
(
const UNiagaraSimCache& LhsCache, |
Compare the provided caches. | |
| void | SetToleranceByName
(
const UNiagaraSimCache& SimCache, |
Setup comparison tolerances for variables that match the provided name wildcard. | |
| void | SetToleranceByType
(
const UNiagaraSimCache& SimCache, |
Setup comparison tolerances for variables that match the provided type. |