1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceGrid3DCollection

UNiagaraDataInterfaceGrid3DCollection

API > API/Plugins > API/Plugins/Niagara

   
Name UNiagaraDataInterfaceGrid3DCollection
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceGrid3DCollection.h
Include Path #include "NiagaraDataInterfaceGrid3DCollection.h"

Syntax

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

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraDataInterfaceGrid3DCollection ( const FObjectInitializer& ObjectInitializer
)

   NiagaraDataInterfaceGrid3DCollection.h  

Constants

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

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bOverrideFormat uint8   NiagaraDataInterfaceGrid3DCollection.h
  • EditAnywhere
  • Category="Grid"
  • Meta=(PinHiddenByDefault, InlineEditConditionToggle)
bPreviewGrid uint8   NiagaraDataInterfaceGrid3DCollection.h
  • EditAnywhere
  • Category="Grid"
  • Meta=(PinHiddenByDefault, InlineEditConditionToggle)
NumAttributes int32 Number of attributes stored on the grid. NiagaraDataInterfaceGrid3DCollection.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Grid"
OverrideBufferFormat ENiagaraGpuBufferFormat When enabled overrides the format used to store data inside the grid, otherwise uses the project default setting. NiagaraDataInterfaceGrid3DCollection.h
  • EditAnywhere
  • Category="Grid"
  • Meta=(EditCondition="bOverrideFormat")
PreviewAttribute FName   NiagaraDataInterfaceGrid3DCollection.h
  • EditAnywhere
  • Category="Grid"
  • Meta=(EditCondition="bPreviewGrid", ToolTip="When enabled allows you to preview the grid in a debug display")
RenderTargetUserParameter FNiagaraUserParameterBinding Reference to a user parameter if we're reading one. NiagaraDataInterfaceGrid3DCollection.h
  • EditAnywhere
  • Category="Grid"

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

   NiagaraDataInterfaceGrid3DCollection.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been replaced by object user variables on the emitter to specify render targets to fill with data.")

virtual 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 NiagaraDataInterfaceGrid3DCollection.h
  • BlueprintCallable
  • Category=Niagara
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been replaced by object user variables on the emitter to specify render targets to fill with data.")

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

 Finds all attributes by locating the data interface amongst the parameter stores. NiagaraDataInterfaceGrid3DCollection.h  

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

   NiagaraDataInterfaceGrid3DCollection.h
  • BlueprintCallable
  • Category=Niagara

TMap< FNiagaraSystemInstanceID, FGrid3DCollectionRWInstanceData_GameThread * > & GetSystemInstancesToProxyData_GT()

   NiagaraDataInterfaceGrid3DCollection.h  

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

   NiagaraDataInterfaceGrid3DCollection.h
  • BlueprintCallable
  • Category=Niagara

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

   NiagaraDataInterfaceGrid3DCollection.h  

void VMGetCellSize ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceGrid3DCollection.h  

void VMGetNumCells ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceGrid3DCollection.h  

void VMGetWorldBBoxSize ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceGrid3DCollection.h  

void VMSetNumCells ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceGrid3DCollection.h  

void VMUnitToFloatIndex ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceGrid3DCollection.h  

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool AppendCompileHash ( FNiagaraCompileHashVisitor* InVisitor
) const

 Allows the generic class defaults version of this class to specify any dependencies/version/etc that might invalidate the compile. NiagaraDataInterfaceGrid3DCollection.h  

virtual bool CanExposeVariables()

   NiagaraDataInterfaceGrid3DCollection.h  

virtual void DestroyPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Destroys the per instance data for this interface. NiagaraDataInterfaceGrid3DCollection.h  

virtual bool Equals ( const UNiagaraDataInterface* Other
) const

 Determines if this DataInterface is the same as another. NiagaraDataInterfaceGrid3DCollection.h  

virtual 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
) const

 Generate the necessary plumbing HLSL at the beginning of the stage where this is used as a sim stage iteration source. NiagaraDataInterfaceGrid3DCollection.h  

virtual 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
) const

 Generate the necessary plumbing HLSL at the end of the stage where this is used as a sim stage iteration source. NiagaraDataInterfaceGrid3DCollection.h  

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

 Generate the necessary HLSL to set up data when being added as a sim stage sim source. NiagaraDataInterfaceGrid3DCollection.h  

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

 Generate the necessary HLSL to tear down data when being added as a sim stage sim source. NiagaraDataInterfaceGrid3DCollection.h  

virtual void GetExposedVariables ( TArray< FNiagaraVariableBase >& OutVariables
) const

   NiagaraDataInterfaceGrid3DCollection.h  

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

   NiagaraDataInterfaceGrid3DCollection.h  
Query the data interface to give feedback to the end user. NiagaraDataInterfaceGrid3DCollection.h  

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

   NiagaraDataInterfaceGrid3DCollection.h  

virtual ENiagaraGpuDispatchType GetGpuDispatchType()

   NiagaraDataInterfaceGrid3DCollection.h  

virtual void GetParameterDefinitionHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
FString& OutHLSL
)

 GPU sim functionality. NiagaraDataInterfaceGrid3DCollection.h  

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

 VM functionality. NiagaraDataInterfaceGrid3DCollection.h  

virtual bool HasPostSimulateTick()

   NiagaraDataInterfaceGrid3DCollection.h  

virtual bool HasPreSimulateTick()

   NiagaraDataInterfaceGrid3DCollection.h  

virtual bool InitPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Initializes the per instance data for this interface. NiagaraDataInterfaceGrid3DCollection.h  

virtual int32 PerInstanceDataSize ()

 Returns the size of the per instance data for this interface. NiagaraDataInterfaceGrid3DCollection.h  

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

 Ticks the per instance data for this interface, if it has any. NiagaraDataInterfaceGrid3DCollection.h  

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

   NiagaraDataInterfaceGrid3DCollection.h  

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

 Subclasses that wish to work with GPU systems/emitters must implement this. NiagaraDataInterfaceGrid3DCollection.h  
Set the shader parameters will only be called if the data interface provided shader parameters. NiagaraDataInterfaceGrid3DCollection.h  

virtual bool ShouldCompile ( EShaderPlatform ShaderPlatform
) const

 GPU sim functionality. NiagaraDataInterfaceGrid3DCollection.h  

virtual bool SupportsIterationSourceNamespaceAttributesHLSL()

 Can this data interface be used as a StackContext parameter map replacement when being used as a sim stage iteration source? NiagaraDataInterfaceGrid3DCollection.h  

virtual bool SupportsSetupAndTeardownHLSL()

 Does this data interface need setup and teardown for each stage when working a sim stage sim source? NiagaraDataInterfaceGrid3DCollection.h  

virtual bool UpgradeFunctionCall ( FNiagaraFunctionSignature& FunctionSignature
)

 Allows data interfaces the opportunity to rename / change the function signature and perform an upgrade. NiagaraDataInterfaceGrid3DCollection.h  

Overridden from UNiagaraDataInterfaceBase

Name Remarks Include Path Unreal Specifiers

virtual void BuildShaderParameters ( FNiagaraShaderParametersBuilder& ShaderParametersBuilder
) const

   NiagaraDataInterfaceGrid3DCollection.h  

virtual FNiagaraDataInterfaceParametersCS * CreateShaderStorage ( const FNiagaraDataInterfaceGPUParamInfo& ParameterInfo,
const FShaderParameterMap& ParameterMap
) const

   NiagaraDataInterfaceGrid3DCollection.h  

virtual const FTypeLayoutDesc * GetShaderStorageType()

   NiagaraDataInterfaceGrid3DCollection.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostInitProperties()

   NiagaraDataInterfaceGrid3DCollection.h  

Protected

Name Remarks Include Path Unreal Specifiers

FName TypeDefinitionToAttributeIndexFunctionName ( const FNiagaraTypeDefinition& InDef
) const

   NiagaraDataInterfaceGrid3DCollection.h  

FName TypeDefinitionToGetFunctionName ( const FNiagaraTypeDefinition& InDef
) const

   NiagaraDataInterfaceGrid3DCollection.h  

const TCHAR * TypeDefinitionToHLSLTypeString ( const FNiagaraTypeDefinition& InDef
) const

   NiagaraDataInterfaceGrid3DCollection.h  

FName TypeDefinitionToSetFunctionName ( const FNiagaraTypeDefinition& InDef
) const

   NiagaraDataInterfaceGrid3DCollection.h  

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

   NiagaraDataInterfaceGrid3DCollection.h  

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

   NiagaraDataInterfaceGrid3DCollection.h  

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

   NiagaraDataInterfaceGrid3DCollection.h  

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

   NiagaraDataInterfaceGrid3DCollection.h  

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

   NiagaraDataInterfaceGrid3DCollection.h  

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

   NiagaraDataInterfaceGrid3DCollection.h  

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

   NiagaraDataInterfaceGrid3DCollection.h  

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool CopyToInternal ( UNiagaraDataInterface* Destination
) const

   NiagaraDataInterfaceGrid3DCollection.h  

virtual void GetFunctionsInternal ( TArray< FNiagaraFunctionSignature >& OutFunctions
) const

   NiagaraDataInterfaceGrid3DCollection.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool CanCreateVarFromFuncName ( const FName& FuncName
)

   NiagaraDataInterfaceGrid3DCollection.h  

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

   NiagaraDataInterfaceGrid3DCollection.h  

static int32 GetComponentCountFromFuncName ( const FName& FuncName
)

   NiagaraDataInterfaceGrid3DCollection.h  

static FNiagaraTypeDefinition GetValueTypeFromFuncName ( const FName& FuncName
)

   NiagaraDataInterfaceGrid3DCollection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page