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

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

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

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraDataInterfaceCollisionQuery ( const FObjectInitializer& ObjectInitializer
)

   NiagaraDataInterfaceCollisionQuery.h  

Constants

Name Type Remarks Include Path
CriticalSection FCriticalSection   NiagaraDataInterfaceCollisionQuery.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
TraceChannelEnum UEnum *   NiagaraDataInterfaceCollisionQuery.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void PerformQueryAsyncCPU ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceCollisionQuery.h  

void PerformQuerySyncCPU ( FVectorVMExternalFunctionContext& Context
)

 VM functions. NiagaraDataInterfaceCollisionQuery.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. NiagaraDataInterfaceCollisionQuery.h  

virtual bool CanExecuteOnTarget ( ENiagaraSimTarget Target
) const

   NiagaraDataInterfaceCollisionQuery.h  

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

 Destroys the per instence data for this interface. NiagaraDataInterfaceCollisionQuery.h  

virtual void GetAssetTagsForContext ( const UObject* InAsset,
FGuid AssetVersion,
const TArray< const UNiagaraDataInterface* >& InProperties,
TMap< FName, uint32 >& NumericKeys,
TMap< FName, FString >& StringKeys
) const

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

virtual void GetCommonHLSL ( FString& OutHLSL
)

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

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

   NiagaraDataInterfaceCollisionQuery.h  

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

   NiagaraDataInterfaceCollisionQuery.h  

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

 Returns the delegate for the passed function signature. NiagaraDataInterfaceCollisionQuery.h  

virtual bool HasPostSimulateTick()

   NiagaraDataInterfaceCollisionQuery.h  

virtual bool HasPreSimulateTick()

   NiagaraDataInterfaceCollisionQuery.h  

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

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

virtual int32 PerInstanceDataSize ()

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

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

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

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

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

virtual bool RequiresDepthBuffer()

   NiagaraDataInterfaceCollisionQuery.h  

virtual bool RequiresGlobalDistanceField()

   NiagaraDataInterfaceCollisionQuery.h  
Set the shader parameters will only be called if the data interface provided shader parameters. NiagaraDataInterfaceCollisionQuery.h  

virtual bool UpgradeFunctionCall ( FNiagaraFunctionSignature& FunctionSignature
)

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

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. NiagaraDataInterfaceCollisionQuery.h  

Overridden from UNiagaraDataInterfaceBase

Name Remarks Include Path Unreal Specifiers

virtual void BuildShaderParameters ( FNiagaraShaderParametersBuilder& ShaderParametersBuilder
) const

   NiagaraDataInterfaceCollisionQuery.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostInitProperties()

   NiagaraDataInterfaceCollisionQuery.h  

Protected

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

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

   NiagaraDataInterfaceCollisionQuery.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page