1. Epic GamesDeveloper
  3. INiagaraSimCacheCustomStorageInterface

INiagaraSimCacheCustomStorageInterface

The current API for storing data inside a simulation cache.

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

References

   
Module Niagara
Header /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraSimCacheCustomStorageInterface.h
Include #include "NiagaraSimCacheCustomStorageInterface.h"

Syntax

class INiagaraSimCacheCustomStorageInterface

Remarks

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.

Functions

  Type Name Description
Public function Virtual Const TArray< FNiagaraVariableBase > This function allows you to preserve a list of attributes when building a renderer only cache.
Public function Virtual Const UObject *

SimCacheBeginWrite ( UObject* SimCache,
FNiagaraSystemInstance* NiagaraSystemInstance,
const void* OptionalPerInstanceData,
FNiagaraSimCacheFeedbackContext& FeedbackContext
)

 Called when we begin to write data into a simulation cache.
Public function Virtual Const bool

SimCacheCompareFrame ( const UObject* LhsStorageObject,
const UObject* RhsStorageObject,
int FrameIndex,
TOptional< float > Tolerance,
FString& OutErrors
)

 Called to compare a frame between two separate simulation cache storages.
Public function Virtual Const bool

SimCacheEndWrite ( UObject* StorageObject
)

 Called when we complete writing data into the simulation cache.
Public function Virtual void

SimCachePostReadFrame ( void* OptionalPerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Called when the simulation cache has finished reading a frame.
Public function Virtual bool

SimCacheReadFrame ( UObject* StorageObject,
int FrameA,
int FrameB,
float Interp,
FNiagaraSystemInstance* SystemInstance,
void* OptionalPerInstanceData
)

 Read a frame of data from the simulation cache.
Public function Virtual Const TSharedPtr< FJsonObject >

SimCacheToJson ( const UObject* StorageObject,
int FrameIndex,
TOptional< FString > TargetFolder,
TOptional< FString > FilenamePrefix
)

 This converts the content of the storage object to a json representation.
Public function Virtual Const bool

SimCacheWriteFrame ( UObject* StorageObject,
int FrameIndex,
FNiagaraSystemInstance* SystemInstance,
const void* OptionalPerInstanceData,
FNiagaraSimCacheFeedbackContext& FeedbackContext
)

 Called when we are ready to write data into the simulation cache.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page