UNiagaraDataInterfaceParticleRead

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Niagara

Header

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

Include

#include "NiagaraDataInterfaceParticleRead.h"

Syntax

UCLASS(EditInlineNew, Category="ParticleRead", Meta=(DisplayName="Particle Attribute Reader"))
class UNiagaraDataInterfaceParticleRead : public UNiagaraDataInterfaceRWBase

Variables

Name Description

Public variable UProperty Category, EditAnywhere

FString

 

EmitterName

Constructors

Name Description

Public function

UNiagaraDataInterfaceParticleRead

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Protected function

void

 

GetIndexFunctions

(
    TArray< FNiagaraFunctionSignature >...
)

Public function

void

 

GetNumParticles

(
    FVectorVMExternalFunctionContext& ...
)

Public function

void

 

GetNumSpawnedParticles

(
    FVectorVMExternalFunctionContext& ...
)

Public function

void

 

GetParticleIndex

(
    FVectorVMExternalFunctionContext& ...
)

Public function

void

 

GetParticleIndexFromIDTable

(
    FVectorVMExternalFunctionContext& ...
)

Protected function

void

 

GetPersistentIDFunctions

(
    TArray< FNiagaraFunctionSignature >...
)

Public function

void

 

GetSpawnedIDAtIndex

(
    FVectorVMExternalFunctionContext& ...
)

Public function

void

 

ReadBool

(
    FVectorVMExternalFunctionContext& ...,
    FName AttributeToRead
)

Public function

void

 

ReadBoolByIndex

(
    FVectorVMExternalFunctionContext& ...,
    FName AttributeToRead
)

Public function

void

 

ReadColor

(
    FVectorVMExternalFunctionContext& ...,
    FName AttributeToRead
)

Public function

void

 

ReadColorByIndex

(
    FVectorVMExternalFunctionContext& ...,
    FName AttributeToRead
)

Public function

void

 

ReadFloat

(
    FVectorVMExternalFunctionContext& ...,
    FName AttributeToRead
)

Public function

void

 

ReadFloatByIndex

(
    FVectorVMExternalFunctionContext& ...,
    FName AttributeToRead
)

Public function

void

 

ReadID

(
    FVectorVMExternalFunctionContext& ...,
    FName AttributeToRead
)

Public function

void

 

ReadIDByIndex

(
    FVectorVMExternalFunctionContext& ...,
    FName AttributeToRead
)

Public function

void

 

ReadInt

(
    FVectorVMExternalFunctionContext& ...,
    FName AttributeToRead
)

Public function

void

 

ReadIntByIndex

(
    FVectorVMExternalFunctionContext& ...,
    FName AttributeToRead
)

Public function

void

 

ReadPosition

(
    FVectorVMExternalFunctionContext& ...,
    FName AttributeToRead
)

Public function

void

 

ReadPositionByIndex

(
    FVectorVMExternalFunctionContext& ...,
    FName AttributeToRead
)

Public function

void

 

ReadQuat

(
    FVectorVMExternalFunctionContext& ...,
    FName AttributeToRead
)

Public function

void

 

ReadQuatByIndex

(
    FVectorVMExternalFunctionContext& ...,
    FName AttributeToRead
)

Public function

void

 

ReadVector2

(
    FVectorVMExternalFunctionContext& ...,
    FName AttributeToRead
)

Public function

void

 

ReadVector2ByIndex

(
    FVectorVMExternalFunctionContext& ...,
    FName AttributeToRead
)

Public function

void

 

ReadVector3

(
    FVectorVMExternalFunctionContext& ...,
    FName AttributeToRead
)

Public function

void

 

ReadVector3ByIndex

(
    FVectorVMExternalFunctionContext& ...,
    FName AttributeToRead
)

Public function

void

 

ReadVector4

(
    FVectorVMExternalFunctionContext& ...,
    FName AttributeToRead
)

Public function

void

 

ReadVector4ByIndex

(
    FVectorVMExternalFunctionContext& ...,
    FName AttributeToRead
)

Overridden from UNiagaraDataInterface

Name Description

Public function Virtual Const

bool

 

CanExecuteOnTarget

(
    ENiagaraSimTarget Target
)

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

void

 

GetFeedback

(
    UNiagaraSystem* InAsset,
    UNiagaraComponent* InComponent,
    TArray< FNiagaraDataInterfaceError ...,
    TArray< FNiagaraDataInterfaceFeedba...,
    TArray< FNiagaraDataInterfaceFeedba...
)

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

Public function Virtual

bool

 

GetFunctionHLSL

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

Public function Virtual

void

 

GetFunctions

(
    TArray< FNiagaraFunctionSignature >...
)

Gets all the available functions for this data interface.

Public function Virtual

void

 

GetParameterDefinitionHLSL

(
    const FNiagaraDataInterfaceGPUParam...,
    FString& OutHLSL
)

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.

Public function Virtual Const

bool

 

ReadsEmitterParticleData

(
    const FString& EmitterName
)

Public function Virtual

bool

 

UpgradeFunctionCall

(
    FNiagaraFunctionSignature& Functio...
)

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

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

bool

 

HasInternalAttributeReads

(
    const UNiagaraEmitter* OwnerEm...,
    const UNiagaraEmitter* Provide...
)

Returns true if the DI (owned by OwnerEmitter) reads any attributes from the Provider emitter

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

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostInitProperties()

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