UNiagaraDataInterfaceCollisionQuery

Data Interface allowing sampling of color curves.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Niagara

Header

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

Include

#include "NiagaraDataInterfaceCollisionQuery.h"

Syntax

UCLASS(EditInlineNew, Category="Collision", Meta=(DisplayName="Collision Query"))
class UNiagaraDataInterfaceCollisionQuery : public UNiagaraDataInterface

Remarks

Data Interface allowing sampling of color curves.

Variables

Name Description

Public variable UProperty Category, EditAnywhere

int32

 

MaxRetraces

If a collision is rejected, how many times do we attempt to retrace from that collision point forward to find a new, valid collision.

Public variable UProperty Category, EditAnywhere

int32

 

MaxTracesPerParticle

Public variable

FNiagaraSystemI...

 

SystemInstance

Constructors

Name Description

Public function

UNiagaraDataInterfaceCollisionQuery

(
    const FObjectInitializer& ObjectIn...
)

Functions

Overridden from UNiagaraDataInterface

Name Description

Public function Virtual Const

bool

 

AppendCompileHash

(
    FNiagaraCompileHashVisitor* In...
)

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

 

CanExecuteOnTarget

(
    ENiagaraSimTarget Target
)

Protected function Virtual Const

bool

 

CopyToInternal

(
    UNiagaraDataInterface* Destina...
)

Public function Virtual

void

 

DestroyPerInstanceData

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

Destroys the per instence data for this interface.

Public function Virtual Const

void

 

GetAssetTagsForContext

(
    const UObject* InAsset,
    const TArray< const UNiagaraDataInt...,
    TMap< FName, uint32 >& NumericKeys,
    TMap< FName, FString >& StringKeys
)

Method to add asset tags that are specific to this data interface.

Public function Virtual

void

 

GetCommonHLSL

(
    FString& OutHLSL
)

Allows data interfaces to provide common functionality that will be shared across interfaces on that type.

Public function Virtual

bool

 

GetFunctionHLSL

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

Public function Virtual

void

 

GetFunctions

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 Const

bool

 

HasPostSimulateTick()

Public function Virtual Const

bool

 

HasPreSimulateTick()

Public function Virtual

bool

 

InitPerInstanceData

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

Initializes the per instance data for this interface.

Public function Virtual Const

void

 

ModifyCompilationEnvironment

(
    EShaderPlatform ShaderPlatform,
    FShaderCompilerEnvironment& OutEnv...
)

Allows data interfaces to influence the compilation of GPU shaders and is only called on the CDO object not the instance.

Public function Virtual Const

int32

 

PerInstanceDataSize()

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

Public function Virtual

bool

 

PerInstanceTick

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

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

Public function Virtual

bool

 

PerInstanceTickPostSimulate

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

Public function Virtual Const

bool

 

PostSimulateCanOverlapFrames()

When set to true the simulation may not complete in the same frame it started, allowing maximum overlap with the GameThread.

Public function Virtual

void

 

PushToRenderThreadImpl()

Public function Virtual Const

bool

 

RequiresDepthBuffer()

Public function Virtual Const

bool

 

RequiresDistanceFieldData()

Public function Virtual Const

bool

 

RequiresRayTracingScene()

Public function Virtual

bool

 

UpgradeFunctionCall

(
    FNiagaraFunctionSignature& Functio...
)

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

Public function Virtual

void

 

ValidateFunction

(
    const FNiagaraFunctionSignature& F...,
    TArray< FText >& OutValidationErro...
)

Validates a function being compiled and allows interface classes to post custom compile errors when their API changes.

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

 

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.

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Constants

Name

Description

CriticalSection