1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceGrid3DCollection

UNiagaraDataInterfaceGrid3DCollection

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

References

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

Syntax

UCLASS (EditInlineNew, Category="Grid", CollapseCategories, Meta=(DisplayName="Grid3D Collection"),  
       Blueprintable, BlueprintType, MinimalAPI)  
class UNiagaraDataInterfaceGrid3DCollection : public UNiagaraDataInterfaceGrid3D

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bOverrideFormat  
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bPreviewGrid  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay int32 NumAttributes Number of attributes stored on the grid.
Public variable UProperty Category, EditAnywhere, Meta ENiagaraGpuBufferFormat OverrideBufferFormat When enabled overrides the format used to store data inside the grid, otherwise uses the project default setting.
Public variable UProperty Category, EditAnywhere, Meta FName PreviewAttribute  
Public variable UProperty Category, EditAnywhere FNiagaraUserParameterBinding RenderTargetUserParameter Reference to a user parameter if we're reading one.
Protected variable TMap< FNiagaraSystemInstanceID, FGrid3DCollectionRWInstanceData_GameThread * > SystemInstancesToProxyData_GT  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Static bool

CanCreateVarFromFuncName ( const FName& FuncName
)

  
Protected function Static void

CollectAttributesForScript ( UNiagaraScript* Script,
const UNiagaraDataInterface* DataInterface,
TArray< FNiagaraVariableBase >& OutVariables,
TArray< uint32 >& OutVariableOffsets,
int32& TotalAttributes,
TArray< FText >* OutWarnings
)

  
Public function Virtual UFunction BlueprintCallable, Category, Meta bool

FillRawVolumeTexture ( const UNiagaraComponent* Component,
UVolumeTexture* Dest,
int& TilesX,
int& TilesY,
int& TileZ
)

  
Public function Virtual UFunction BlueprintCallable, Category, Meta bool

FillVolumeTexture ( const UNiagaraComponent* Component,
UVolumeTexture* dest,
int AttributeIndex
)

 Fills a texture render target 2d with the current data from the simulation #todo(dmp): this will eventually go away when we formalize how data makes it out of Niagara #todo(dmp): reimplement for 3d
Public function Const void

FindAttributes ( TArray< FNiagaraVariableBase >& OutVariables,
TArray< uint32 >& OutVariableOffsets,
int32& OutNumAttribChannelsFound,
TArray< FText >* OutWarnings
)

 Finds all attributes by locating the data interface amongst the parameter stores.
Public function Static int32

GetComponentCountFromFuncName ( const FName& FuncName
)

  
Public function Virtual UFunction BlueprintCallable, Category void

GetRawTextureSize ( const UNiagaraComponent* Component,
int& SizeX,
int& SizeY,
int& SizeZ
)

  
Public function TMap< FNiagaraSystemInstanceID, FGrid3DCollectionRWInstanceData_GameThread * > &  
Public function Virtual UFunction BlueprintCallable, Category void

GetTextureSize ( const UNiagaraComponent* Component,
int& SizeX,
int& SizeY,
int& SizeZ
)

  
Public function Static FNiagaraTypeDefinition

GetValueTypeFromFuncName ( const FName& FuncName
)

  
Protected function Const FName  
Protected function Const FName  
Protected function Const const TCHAR *  
Protected function Const FName  
Public function void

VMGetAttributeIndex ( FVectorVMExternalFunctionContext& Context,
const FName& InName,
int32 NumChannels
)

  
Public function void

VMGetCellSize ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

VMGetNumCells ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

VMGetWorldBBoxSize ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

VMSetNumCells ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

VMUnitToFloatIndex ( FVectorVMExternalFunctionContext& Context
)

  
Protected function void

WriteAttributeGetIndexHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
const FNiagaraDataInterfaceGeneratedFunction& FunctionInfo,
int FunctionInstanceIndex,
int32 InNumChannels,
FString& OutHLSL
)

  
Protected function void

WriteGetAtIndexHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
const FNiagaraDataInterfaceGeneratedFunction& FunctionInfo,
int32 InNumChannels,
FString& OutHLSL
)

  
Protected function void

WriteGetHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
const FNiagaraDataInterfaceGeneratedFunction& FunctionInfo,
int FunctionInstanceIndex,
int32 InNumChannels,
FString& OutHLSL
)

  
Protected function void

WriteSampleAtIndexHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
const FNiagaraDataInterfaceGeneratedFunction& FunctionInfo,
int32 InNumChannels,
FString SampleFunction,
FString& OutHLSL
)

  
Protected function void

WriteSampleHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
const FNiagaraDataInterfaceGeneratedFunction& FunctionInfo,
int FunctionInstanceIndex,
int32 InNumChannels,
FString SampleFunction,
FString& OutHLSL
)

  
Protected function void

WriteSetAtIndexHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
const FNiagaraDataInterfaceGeneratedFunction& FunctionInfo,
int32 InNumChannels,
FString& OutHLSL
)

  
Protected function void

WriteSetHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
const FNiagaraDataInterfaceGeneratedFunction& FunctionInfo,
int FunctionInstanceIndex,
int32 InNumChannels,
FString& OutHLSL
)

  

Overridden from UNiagaraDataInterface

  Type Name Description
Public function Virtual Const bool Allows the generic class defaults version of this class to specify any dependencies/version/etc that might invalidate the compile.
Public function Virtual Const bool  
Protected function Virtual Const bool  
Public function Virtual void

DestroyPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Destroys the per instance data for this interface.
Public function Virtual Const bool

Equals ( const UNiagaraDataInterface* Other
)

 Determines if this DataInterface is the same as another.
Public function Virtual Const bool

GenerateIterationSourceNamespaceReadAttributesHLSL ( FNiagaraDataInterfaceGPUParamInfo& DIInstanceInfo,
const FNiagaraVariable& InIterationSourceVariable,
TConstArrayView< FNiagaraVariable > InArguments,
TConstArrayView< FNiagaraVariable > InAttributes,
TConstArrayView< FString > InAttributeHLSLNames,
bool bInSetToDefaults,
bool bSpawnOnly,
bool bPartialWrites,
TArray< FText >& OutErrors,
FString& OutHLSL
)

 Generate the necessary plumbing HLSL at the beginning of the stage where this is used as a sim stage iteration source.
Public function Virtual Const bool

GenerateIterationSourceNamespaceWriteAttributesHLSL ( FNiagaraDataInterfaceGPUParamInfo& DIInstanceInfo,
const FNiagaraVariable& InIterationSourceVariable,
TConstArrayView< FNiagaraVariable > InArguments,
TConstArrayView< FNiagaraVariable > InAttributes,
TConstArrayView< FString > InAttributeHLSLNames,
TConstArrayView< FNiagaraVariable > InAllAttributes,
bool bSpawnOnly,
bool bPartialWrites,
TArray< FText >& OutErrors,
FString& OutHLSL
)

 Generate the necessary plumbing HLSL at the end of the stage where this is used as a sim stage iteration source.
Public function Virtual Const bool

GenerateSetupHLSL ( FNiagaraDataInterfaceGPUParamInfo& DIInstanceInfo,
TConstArrayView< FNiagaraVariable > InArguments,
bool bSpawnOnly,
bool bPartialWrites,
TArray< FText >& OutErrors,
FString& OutHLSL
)

 Generate the necessary HLSL to set up data when being added as a sim stage sim source.
Public function Virtual Const bool

GenerateTeardownHLSL ( FNiagaraDataInterfaceGPUParamInfo& DIInstanceInfo,
TConstArrayView< FNiagaraVariable > InArguments,
bool bSpawnOnly,
bool bPartialWrites,
TArray< FText >& OutErrors,
FString& OutHLSL
)

 Generate the necessary HLSL to tear down data when being added as a sim stage sim source.
Public function Virtual Const void  
Public function Virtual Const bool

GetExposedVariableValue ( const FNiagaraVariableBase& InVariable,
void* InPerInstanceData,
FNiagaraSystemInstance* InSystemInstance,
void* OutData
)

  
Public function Virtual void Query the data interface to give feedback to the end user.
Public function Virtual bool

GetFunctionHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
const FNiagaraDataInterfaceGeneratedFunction& FunctionInfo,
int FunctionInstanceIndex,
FString& OutHLSL
)

  
Protected function Virtual Const void  
Public function Virtual Const ENiagaraGpuDispatchType  
Public function Virtual void GPU sim functionality.
Public function Virtual void

GetVMExternalFunction ( const FVMExternalFunctionBindingInfo& BindingInfo,
void* InstanceData,
FVMExternalFunction& OutFunc
)

 VM functionality.
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual bool

InitPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Initializes the per instance data for this interface.
Public function Virtual Const int32 Returns the size of the per instance data for this interface.
Public function Virtual bool

PerInstanceTick ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance,
float DeltaSeconds
)

 Ticks the per instance data for this interface, if it has any.
Public function Virtual bool

PerInstanceTickPostSimulate ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance,
float DeltaSeconds
)

  
Public function Virtual void

ProvidePerInstanceDataForRenderThread ( void* DataForRenderThread,
void* PerInstanceData,
const FNiagaraSystemInstanceID& SystemInstance
)

 Subclasses that wish to work with GPU systems/emitters must implement this.
Public function Virtual Const void Set the shader parameters will only be called if the data interface provided shader parameters.
Public function Virtual Const bool

ShouldCompile ( EShaderPlatform ShaderPlatform
)

 GPU sim functionality.
Public function Virtual Const bool Can this data interface be used as a StackContext parameter map replacement when being used as a sim stage iteration source?
Public function Virtual Const bool Does this data interface need setup and teardown for each stage when working a sim stage sim source?
Public function Virtual bool Allows data interfaces the opportunity to rename / change the function signature and perform an upgrade.

Overridden from UNiagaraDataInterfaceBase

  Type Name Description
Public function Virtual Const void Override this method to provide parameters to the GPU (SRV / UAV / Constants / etc) The most common usage will be to provide a single structure which is nested with other parameters.
Public function Virtual Const FNiagaraDataInterfaceParametersCS *

CreateShaderStorage ( const FNiagaraDataInterfaceGPUParamInfo& ParameterInfo,
const FShaderParameterMap& ParameterMap
)

 Optional storage that can be created per shader when not in legacy binding mode.
Public function Virtual Const const FTypeLayoutDesc * If we create shader storage we must also supply the type of the storage so we understand how to serialize it.

Overridden from UObject

  Type Name Description
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Constants

Name Description
AnonymousAttributeString  
AttributeIndicesBaseName  
ClearCellFunctionName  
CopyMaskedPreviousToCurrentForCellFunctionName  
CopyPreviousToCurrentForCellFunctionName  
CubicSampleGridFunctionName  
CubicSamplePreviousFullGridFunctionName  
CubicSamplePreviousGridAtIndexFunctionName  
CubicSamplePreviousGridFloatAtIndexFunctionName  
CubicSamplePreviousGridFloatFunctionName  
CubicSamplePreviousGridVector2AtIndexFunctionName  
CubicSamplePreviousGridVector2DFunctionName  
CubicSamplePreviousGridVector3AtIndexFunctionName  
CubicSamplePreviousGridVector4AtIndexFunctionName  
CubicSamplePreviousGridVector4FunctionName  
CubicSamplePreviousGridVectorFunctionName  
ExposedRTVar  
GetFloatAttributeIndexFunctionName  
GetFullGridPreviousValueFunctionName  
GetPreviousFloatValueAtIndexFunctionName  
GetPreviousFloatValueFunctionName  
GetPreviousValueAtIndexFunctionName  
GetPreviousVector2DValueFunctionName  
GetPreviousVector2ValueAtIndexFunctionName  
GetPreviousVector3ValueAtIndexFunctionName  
GetPreviousVector4ValueAtIndexFunctionName  
GetPreviousVector4ValueFunctionName  
GetPreviousVectorValueFunctionName  
GetValueFunctionName  
GetVector2DAttributeIndexFunctionName  
GetVector2ValueFunctionName  
GetVector4AttributeIndexFunctionName  
GetVectorAttributeIndexFunctionName  
GridName  
NumTilesName  
OneOverNumTilesName  
OutputGridName  
PerAttributeDataName  
SampleGridFunctionName  
SamplePreviousFullGridFunctionName  
SamplePreviousGridAtIndexFunctionName  
SamplePreviousGridFloatAtIndexFunctionName  
SamplePreviousGridFloatFunctionName  
SamplePreviousGridVector2AtIndexFunctionName  
SamplePreviousGridVector2DFunctionName  
SamplePreviousGridVector3AtIndexFunctionName  
SamplePreviousGridVector4AtIndexFunctionName  
SamplePreviousGridVector4FunctionName  
SamplePreviousGridVectorFunctionName  
SamplerName  
SetFloatValueAtIndexFunctionName  
SetFloatValueFunctionName  
SetFullGridValueFunctionName  
SetNumCellsFunctionName  
SetValueFunctionName  
SetVector2DValueFunctionName  
SetVector2ValueAtIndexFunctionName  
SetVector2ValueFunctionName  
SetVector3ValueAtIndexFunctionName  
SetVector3ValueFunctionName  
SetVector4ValueAtIndexFunctionName  
SetVector4ValueFunctionName  
SetVectorValueFunctionName  
TemplateShaderFilePath  
UnitClampMaxName  
UnitClampMinName  
VectorComponentNames  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page