Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. INiagaraSimCacheCustomStorageInterface

INiagaraSimCacheCustomStorageInterface

The current API for storing data inside a simulation cache.

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

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual TArray< FNiagaraVariableBase > GetSimCacheRendererAttributes ( const UObject* UsageContext
) const

 This function allows you to preserve a list of attributes when building a renderer only cache. NiagaraSimCacheCustomStorageInterface.h  

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

 Called when we begin to write data into a simulation cache. NiagaraSimCacheCustomStorageInterface.h  

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

 Called to compare a frame between two separate simulation cache storages. NiagaraSimCacheCustomStorageInterface.h  

virtual bool SimCacheEndWrite ( UObject* StorageObject
) const

 Called when we complete writing data into the simulation cache. NiagaraSimCacheCustomStorageInterface.h  

virtual void SimCachePostReadFrame ( void* OptionalPerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 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,
int FrameA,
int FrameB,
float Interp,
FNiagaraSystemInstance* SystemInstance,
void* OptionalPerInstanceData
)

   NiagaraSimCacheCustomStorageInterface.h  

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

 This converts the content of the storage object to a json representation. NiagaraSimCacheCustomStorageInterface.h  

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

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page