Navigation
API > API/Plugins > API/Plugins/Niagara
The current API for storing data inside a simulation cache. This is highly experimental and the API will change as we split editor / runtime data storage.
See INiagaraDataInterfaceSimCacheVisualizer to implement a custom visualizer widget for the stored data.
| Name | INiagaraSimCacheCustomStorageInterface |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraSimCacheCustomStorageInterface.h |
| Include Path | #include "NiagaraSimCacheCustomStorageInterface.h" |
Syntax
class INiagaraSimCacheCustomStorageInterface
Derived Classes
- UNiagaraDataInterfaceArray
- UNiagaraDataInterfaceHairStrands
- UNiagaraDataInterfaceRenderTarget2D
- UNiagaraDataInterfaceRenderTargetVolume
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TArray< FNiagaraVariableBase > GetSimCacheRendererAttributes
(
const UObject* UsageContext |
This function allows you to preserve a list of attributes when building a renderer only cache. | NiagaraSimCacheCustomStorageInterface.h | |
virtual UObject * SimCacheBeginWrite
(
UObject* SimCache, |
Called when we begin to write data into a simulation cache. | NiagaraSimCacheCustomStorageInterface.h | |
virtual bool SimCacheCompareFrame
(
const UObject* LhsStorageObject, |
Called to compare a frame between two separate simulation cache storages. | NiagaraSimCacheCustomStorageInterface.h | |
virtual bool SimCacheEndWrite
(
UObject* StorageObject |
Called when we complete writing data into the simulation cache. | NiagaraSimCacheCustomStorageInterface.h | |
virtual void SimCachePostReadFrame
(
void* OptionalPerInstanceData, |
Called when the simulation cache has finished reading a frame. | NiagaraSimCacheCustomStorageInterface.h | |
virtual bool SimCacheReadFrame
(
const FNiagaraSimCacheDataInterfaceReadContext& ReadContext |
Read a frame of data from the simulation cache. | NiagaraSimCacheCustomStorageInterface.h | |
virtual bool SimCacheReadFrame
(
UObject* StorageObject, |
NiagaraSimCacheCustomStorageInterface.h | ||
virtual TSharedPtr< FJsonObject > SimCacheToJson
(
const UObject* StorageObject, |
This converts the content of the storage object to a json representation. | NiagaraSimCacheCustomStorageInterface.h | |
virtual bool SimCacheWriteFrame
(
UObject* StorageObject, |
Called when we are ready to write data into the simulation cache. | NiagaraSimCacheCustomStorageInterface.h |