UNiagaraDataInterfaceGrid2DCollectionReader

#todo(dmp): base class has all the RW attributes, even though we only care about the attributes that query the grid. Cleaning this up would be great

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Niagara

Header

/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceGrid2DCollectionReader.h

Include

#include "NiagaraDataInterfaceGrid2DCollectionReader.h"

Syntax

UCLASS(EditInlineNew, Category="Grid",
       Meta=(DisplayName="Grid2D Collection Reader", Experimental), Blueprintable, BlueprintType,
       HideCategories=(Grid, RW))
class UNiagaraDataInterfaceGrid2DCollectionReader : public UNiagaraDataInterfaceGrid2D

Remarks

#todo(dmp): base class has all the RW attributes, even though we only care about the attributes that query the grid. Cleaning this up would be great

Variables

Name Description

Public variable UProperty Category, EditAnywhere

FString

 

DIName

Name of the Grid2DCollection Data Interface on the emitter.

Public variable UProperty Category, EditAnywhere

FString

 

EmitterName

Name of the emitter to read from.

Protected variable

TMap< FNiagaraS...

 

SystemInstancesToProxyData_GT

Constructors

Name Description

Public function

UNiagaraDataInterfaceGrid2DCollectionReader

(
    const FObjectInitializer& ObjectIn...
)

Overridden from UNiagaraDataInterface

Name Description

Protected function Virtual Const

bool

 

CopyToInternal

(
    UNiagaraDataInterface* Destina...
)

Public function Virtual

void

 

DestroyPerInstanceData

(
    void* PerInstanceData,
    FNiagaraSystemInstance* System...
)

Destroys the per instance data for this interface.

Public function Virtual Const

bool

 

Equals

(
    const UNiagaraDataInterface* O...
)

Determines if this DataInterface is the same as another.

Public function Virtual Const

void

 

GetEmitterDependencies

(
    UNiagaraSystem* Asset,
    TArray< UNiagaraEmitter* >& D...
)

Allows a DI to specify data dependencies between emitters, so the system can ensure that the emitter instances are executed in the correct order.

Public function Virtual

bool

 

GetFunctionHLSL

(
    const FNiagaraDataInterfaceGPUParam...,
    const FNiagaraDataInterfaceGenerate...,
    int FunctionInstanceIndex,
    FString& OutHLSL
)

Public function Virtual

void

 

GetFunctions

(
    TArray< FNiagaraFunctionSignature >...
)

VM functionality.

Public function Virtual

void

 

GetParameterDefinitionHLSL

(
    const FNiagaraDataInterfaceGPUParam...,
    FString& OutHLSL
)

GPU sim functionality.

Public function Virtual

void

 

GetVMExternalFunction

(
    const FVMExternalFunctionBindingInf...,
    void* InstanceData,
    FVMExternalFunction& OutFunc
)

Returns the delegate for the passed function signature.

Public function Virtual

bool

 

InitPerInstanceData

(
    void* PerInstanceData,
    FNiagaraSystemInstance* System...
)

Initializes the per instance data for this interface.

Public function Virtual Const

int32

 

PerInstanceDataSize()

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

Public function Virtual

void

 

ProvidePerInstanceDataForRenderThread

(
    void* DataForRenderThread,
    void* PerInstanceData,
    const FNiagaraSystemInstanceID& Sy...
)

Subclasses that wish to work with GPU systems/emitters must implement this.

Overridden from UNiagaraDataInterfaceBase

Name Description

Public function Virtual

void

 

BindParameters

(
    FNiagaraDataInterfaceParametersCS&...,
    const FNiagaraDataInterfaceGPUParam...,
    const FShaderParameterMap& Paramet...
)

Methods that operate on an instance of type FNiagaraDataInterfaceParametersCS*, created by the above CreateComputeParameters() method

Public function Virtual Const

FNiagaraData...

 

CreateComputeParameters()

Constructs the correct CS parameter type for this DI (if any).

Public function Virtual Const

const FTypeL...

 

GetComputeParametersTypeDesc()

Public function Virtual Const

void

 

SetParameters

(
    const FNiagaraDataInterfaceParamete...,
    FRHICommandList& RHICmdList,
    const FNiagaraDataInterfaceSetArgs ...
)

Public function Virtual Const

void

 

UnsetParameters

(
    const FNiagaraDataInterfaceParamete...,
    FRHICommandList& RHICmdList,
    const FNiagaraDataInterfaceSetArgs ...
)

Overridden from UObject

Name Description

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Constants