1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceCollisionQuery

UNiagaraDataInterfaceCollisionQuery

Data Interface that can be used to query collision related data, like geometry traces or sampling the depth buffer.

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;EditInlineNew, Category&61;"Collision", Meta&61;&40;DisplayName&61;"Collision Query"&41;, MinimalAPI&41;  
class UNiagaraDataInterfaceCollisionQuery : public UNiagaraDataInterface

Remarks

Data Interface that can be used to query collision related data, like geometry traces or sampling the depth buffer.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

PerformQueryAsyncCPU ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

PerformQuerySyncCPU ( FVectorVMExternalFunctionContext& Context
)

 VM functions.

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  
Public function Virtual void

DestroyPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* InSystemInstance
)

 Destroys the per instence data for this interface.
Public function Virtual Const void

GetAssetTagsForContext ( const UObject* InAsset,
FGuid AssetVersion,
const TArray< const UNiagaraDataInterface* >& InProperties,
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 FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
const FNiagaraDataInterfaceGeneratedFunction& FunctionInfo,
int FunctionInstanceIndex,
FString& OutHLSL
)

  
Public function Virtual void Gets all the available functions for this data interface.
Public function Virtual void  
Public function Virtual void

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

 Returns the delegate for the passed function signature.
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual bool

InitPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* InSystemInstance
)

 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 Const bool When set to true the simulation may not complete in the same frame it started, allowing maximum overlap with the GameThread.
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const void Set the shader parameters will only be called if the data interface provided shader parameters.
Public function Virtual bool Allows data interfaces the opportunity to rename / change the function signature and perform an upgrade.
Public function Virtual void

ValidateFunction ( const FNiagaraFunctionSignature& Function,
TArray< FText >& OutValidationErrors
)

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

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.

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.

Classes

  Type Name Description
Public class FShaderParameters    

Constants

Name Description
CriticalSection  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page