Navigation
API > API/Plugins > API/Plugins/Niagara
Contains all the information requires to find the data / interpolate / rebase information.
| Name | FNiagaraSimCacheDataInterfaceReadContext |
| Type | struct |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraSimCacheCustomStorageInterface.h |
| Include Path | #include "NiagaraSimCacheCustomStorageInterface.h" |
Syntax
struct FNiagaraSimCacheDataInterfaceReadContext
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FrameIndexA | int | NiagaraSimCacheCustomStorageInterface.h | ||
| FrameIndexB | int | NiagaraSimCacheCustomStorageInterface.h | ||
| FrameInterp | float | NiagaraSimCacheCustomStorageInterface.h | ||
| InterpolateData | TOptional< bool > | NiagaraSimCacheCustomStorageInterface.h | ||
| LWCTileA | FVector3f | NiagaraSimCacheCustomStorageInterface.h | ||
| LWCTileB | FVector3f | NiagaraSimCacheCustomStorageInterface.h | ||
| OptionalPerInstanceData | void * | NiagaraSimCacheCustomStorageInterface.h | ||
| RebaseData | TOptional< bool > | NiagaraSimCacheCustomStorageInterface.h | ||
| RebaseTransformA | FTransform | NiagaraSimCacheCustomStorageInterface.h | ||
| RebaseTransformB | FTransform | NiagaraSimCacheCustomStorageInterface.h | ||
| StorageObject | UObject * | NiagaraSimCacheCustomStorageInterface.h | ||
| SystemInstance | FNiagaraSystemInstance * | NiagaraSimCacheCustomStorageInterface.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetFrameIndexA() |
Get the currrent frame we are interpolating from. | NiagaraSimCacheCustomStorageInterface.h | |
int32 GetFrameIndexB() |
Get the currrent frame we are interpolating to. | NiagaraSimCacheCustomStorageInterface.h | |
float GetFrameInterp() |
Get the currrent frame interpolation fraction. | NiagaraSimCacheCustomStorageInterface.h | |
FVector3f GetLWCTileA() |
Get the LWC tile the instance was in during caching for frame A. | NiagaraSimCacheCustomStorageInterface.h | |
FVector3f GetLWCTileB() |
Get the LWC tile the instance was in during caching for frame B. | NiagaraSimCacheCustomStorageInterface.h | |
T * GetOptionalStorageObject() |
Get the stored data interface object, can return nullptr if the cast fails. | NiagaraSimCacheCustomStorageInterface.h | |
T * GetPerInstanceData() |
Get the system instance data interface per instance data, will assert on nullptr. | NiagaraSimCacheCustomStorageInterface.h | |
const FTransform & GetRebaseTransformA() |
Get the transform to rebase data, this is not world space but LWC tile space. | NiagaraSimCacheCustomStorageInterface.h | |
const FTransform & GetRebaseTransformB() |
Get the transform to rebase data, this is not world space but LWC tile space. | NiagaraSimCacheCustomStorageInterface.h | |
T * GetStorageObject() |
Get the stored data interface object, will assert on nullptr. | NiagaraSimCacheCustomStorageInterface.h | |
FNiagaraSystemInstance * GetSystemInstance() |
Get the system instance the cache read is attached to. | NiagaraSimCacheCustomStorageInterface.h | |
bool ShouldInterpolate
(
bool DefaultValue |
Test to see if we should interpolate the data or not The default value is expected to be the 'just works' case for when the user did not set force include / exlucde and interpolation is enabled | NiagaraSimCacheCustomStorageInterface.h | |
bool ShouldRebaseData
(
bool DefaultValue |
Test to see if we should rebase the data or not The default value is expected to be the 'just works' case for when the user did not set force include / exlucde and rebasing is enabled | NiagaraSimCacheCustomStorageInterface.h |