Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Niagara > UNiagaraDataInterfaceCollisionQuery

Light Theme

Dark Theme

UNiagaraDataInterfaceCollisionQuery

Data Interface allowing sampling of color curves.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraDataInterfaceBase

UNiagaraDataInterface

UNiagaraDataInterfaceCollisionQuery

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, Category="Collision", Meta=(DisplayName="Collision Query"))
class UNiagaraDataInterfaceCollisionQuery : public UNiagaraDataInterface

Remarks

Data Interface allowing sampling of color curves.

Variables

		Name	Description
	FNiagaraSystemI...	SystemInstance

Constructors

	Name	Description
	UNiagaraDataInterfaceCollisionQuery ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	PerformQueryAsyncCPU ( FVectorVMContext& Context )
void	PerformQuerySyncCPU ( FVectorVMContext& Context )	VM functions.
void	QueryMeshDistanceField ( FVectorVMContext& Context )
void	QuerySceneDepth ( FVectorVMContext& Context )

Overridden from UNiagaraDataInterface

	Name	Description
bool	AppendCompileHash ( FNiagaraCompileHashVisitor* In... )	Allows the generic class defaults version of this class to specify any dependencies/version/etc that might invalidate the compile.
bool	CanExecuteOnTarget ( ENiagaraSimTarget Target )
void	DestroyPerInstanceData ( void* PerInstanceData, FNiagaraSystemInstance* InSyst... )	Destroys the per instence data for this interface.
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.
void	GetCommonHLSL ( FString& OutHLSL )	Allows data interfaces to provide common functionality that will be shared across interfaces on that type.
bool	GetFunctionHLSL ( const FNiagaraDataInterfaceGPUParam..., const FNiagaraDataInterfaceGenerate..., int FunctionInstanceIndex, FString& OutHLSL )
void	GetFunctions ( TArray< FNiagaraFunctionSignature >... )	Gets all the available functions for this data interface.
void	GetParameterDefinitionHLSL ( const FNiagaraDataInterfaceGPUParam..., FString& OutHLSL )
void	GetVMExternalFunction ( const FVMExternalFunctionBindingInf..., void* InstanceData, FVMExternalFunction& OutFunc )	Returns the delegate for the passed function signature.
bool	HasPostSimulateTick()
bool	HasPreSimulateTick()
bool	InitPerInstanceData ( void* PerInstanceData, FNiagaraSystemInstance* InSyst... )	Initializes the per instance data for this interface.
int32	PerInstanceDataSize()	Returns the size of the per instance data for this interface.
bool	PerInstanceTick ( void* PerInstanceData, FNiagaraSystemInstance* System..., float DeltaSeconds )	Ticks the per instance data for this interface, if it has any.
bool	PerInstanceTickPostSimulate ( void* PerInstanceData, FNiagaraSystemInstance* System..., float DeltaSeconds )
bool	RequiresDepthBuffer()
bool	RequiresDistanceFieldData()
bool	UpgradeFunctionCall ( FNiagaraFunctionSignature& Functio... )	Allows data interfaces the opportunity to rename / change the function signature and perform an upgrade.
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
void	BindParameters ( FNiagaraDataInterfaceParametersCS&..., const FNiagaraDataInterfaceGPUParam..., const FShaderParameterMap& Paramet... )	Methods that operate on an instance of type FNiagaraDataInterfaceParametersCS*, created by the above CreateComputeParameters() method
FNiagaraData...	CreateComputeParameters()	Constructs the correct CS parameter type for this DI (if any).
const FTypeL...	GetComputeParametersTypeDesc()
void	SetParameters ( const FNiagaraDataInterfaceParamete..., FRHICommandList& RHICmdList, const FNiagaraDataInterfaceSetArgs ... )
void	UnsetParameters ( const FNiagaraDataInterfaceParamete..., FRHICommandList& RHICmdList, const FNiagaraDataInterfaceSetArgs ... )

Overridden from UObject

		Name	Description
	void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Constants

Name	Description
CriticalSection

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss