Navigation
API > API/Plugins > API/Plugins/Niagara
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
| Name | FNiagaraSimCacheCompare |
| Type | struct |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraSimCacheCompare.h |
| Include Path | #include "NiagaraSimCacheCompare.h" |
Syntax
struct FNiagaraSimCacheCompare
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bExcludeNoneDeterministicVariables | bool | Should we exclude known none deterministic variables, i.e. ID / MaterialRandom. | NiagaraSimCacheCompare.h | |
| bIncludeDataInterfaces | bool | Should we include data interface as part of the comparison. | NiagaraSimCacheCompare.h | |
| DefaultFloatTolerance | float | Default float tolerance when comparing caches | NiagaraSimCacheCompare.h | |
| DefaultQuaternionTolerance | TOptional< float > | Tolerance when comparing quaternions, if not set uses the default UE tolerance. | NiagaraSimCacheCompare.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AttributesToExclude_ByWildcard | TArray< FString > | NiagaraSimCacheCompare.h | ||
| AttributesToExclude_ParticleScript | TSet< FNiagaraVariableBase > | NiagaraSimCacheCompare.h | ||
| AttributesToExclude_SystemScript | TSet< FNiagaraVariableBase > | NiagaraSimCacheCompare.h | ||
| VariableToFloatTolerances_ParticleScript | TMap< FNiagaraVariableBase, float > | NiagaraSimCacheCompare.h | ||
| VariableToFloatTolerances_SystemScript | TMap< FNiagaraVariableBase, float > | NiagaraSimCacheCompare.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddExcludeAttribute
(
FNiagaraVariableBase Variable |
Add an attribute to exclude from the comparison. | NiagaraSimCacheCompare.h | |
void AddExcludeAttributesByWildcard
(
FString Wildcard |
Adds an exclude rule to match against attreibute names. | NiagaraSimCacheCompare.h | |
bool Compare
(
const UNiagaraSimCache& LhsCache, |
Compare the provided caches. | NiagaraSimCacheCompare.h | |
void SetToleranceByName
(
const UNiagaraSimCache& SimCache, |
Setup comparison tolerances for variables that match the provided name wildcard. | NiagaraSimCacheCompare.h | |
void SetToleranceByType
(
const UNiagaraSimCache& SimCache, |
Setup comparison tolerances for variables that match the provided type. | NiagaraSimCacheCompare.h |