Navigation
API > API/Plugins > API/Plugins/Niagara
Data Interface used to collide against static meshes - whether it is the mesh distance field or a physics asset's collision primitive
| Name | UNiagaraDataInterfaceRigidMeshCollisionQuery |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraDataInterfaceRigidMeshCollisionQuery.h |
| Include Path | #include "NiagaraDataInterfaceRigidMeshCollisionQuery.h" |
Syntax
UCLASS (EditInlineNew, Category="Collision", Meta=(DisplayName="Rigid Mesh Collision Query"))
class UNiagaraDataInterfaceRigidMeshCollisionQuery : public UNiagaraDataInterface
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UNiagaraNotifyOnChanged → UNiagaraDataInterfaceBase → UNiagaraDataInterface → UNiagaraDataInterfaceRigidMeshCollisionQuery
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UNiagaraDataInterfaceRigidMeshCollisionQuery
(
const FObjectInitializer& ObjectInitializer |
NiagaraDataInterfaceRigidMeshCollisionQuery.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActorTags | TArray< FName > | Set of tags used to match against actors when searching for RigidBody providers. | NiagaraDataInterfaceRigidMeshCollisionQuery.h |
|
| bFilterByObjectType | bool | If enabled, FindActors will use filtering based on ObjectType instead of Channel. | NiagaraDataInterfaceRigidMeshCollisionQuery.h |
|
| ComponentTags | TArray< FName > | Set of tags used to match against components when searching for RigidBody providers. | NiagaraDataInterfaceRigidMeshCollisionQuery.h |
|
| GlobalSearchAllowed | bool | If enabled the global search can be executed depending on GlobalSearchForced and GlobalSearchFallback_Unscripted | NiagaraDataInterfaceRigidMeshCollisionQuery.h |
|
| GlobalSearchFallback_Unscripted | bool | If enabled the global search will be performed only if there are no explicit actors specified | NiagaraDataInterfaceRigidMeshCollisionQuery.h |
|
| GlobalSearchForced | bool | If enabled the global search will be performed only if there are no explicit actors specified | NiagaraDataInterfaceRigidMeshCollisionQuery.h |
|
| MaxNumPrimitives | int | Maximum number of RigidBody represented by this DataInterface. | NiagaraDataInterfaceRigidMeshCollisionQuery.h |
|
| OnlyUseMoveable | bool | If enabled only actors that are considered moveable will be searched for RigidBodies. | NiagaraDataInterfaceRigidMeshCollisionQuery.h |
|
| SourceActors | TArray< TSoftObjectPtr< AActor > > | Hardcoded references to actors that will be used as RigidBody providers. | NiagaraDataInterfaceRigidMeshCollisionQuery.h |
|
| UseComplexCollisions | bool | If enabled, complex collisions will be searched for. | NiagaraDataInterfaceRigidMeshCollisionQuery.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool FindActors
(
UWorld* World, |
NiagaraDataInterfaceRigidMeshCollisionQuery.h | ||
void FindActorsCPU
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceRigidMeshCollisionQuery.h | ||
bool GetExplicitActors
(
FNDIRigidMeshCollisionData& InstanceData |
NiagaraDataInterfaceRigidMeshCollisionQuery.h | ||
void GetNumElementsCPU
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceRigidMeshCollisionQuery.h | ||
bool GlobalFindActors
(
UWorld* World, |
NiagaraDataInterfaceRigidMeshCollisionQuery.h | ||
void IsWorldPositionInsideCombinedBoundsCPU
(
FVectorVMExternalFunctionContext& Context |
NiagaraDataInterfaceRigidMeshCollisionQuery.h | ||
bool UpdateSourceActors
(
FNiagaraSystemInstance* SystemInstance, |
NiagaraDataInterfaceRigidMeshCollisionQuery.h |
Overridden from UNiagaraDataInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool AppendCompileHash
(
FNiagaraCompileHashVisitor* InVisitor |
Allows the generic class defaults version of this class to specify any dependencies/version/etc that might invalidate the compile. | NiagaraDataInterfaceRigidMeshCollisionQuery.h | |
virtual ETickingGroup CalculateTickGroup
(
const void* PerInstanceData |
NiagaraDataInterfaceRigidMeshCollisionQuery.h | ||
virtual bool CanExecuteOnTarget
(
ENiagaraSimTarget Target |
NiagaraDataInterfaceRigidMeshCollisionQuery.h | ||
virtual void DestroyPerInstanceData
(
void* PerInstanceData, |
Destroys the per instance data for this interface. | NiagaraDataInterfaceRigidMeshCollisionQuery.h | |
virtual bool Equals
(
const UNiagaraDataInterface* Other |
Determines if this DataInterface is the same as another. | NiagaraDataInterfaceRigidMeshCollisionQuery.h | |
virtual void GetCommonHLSL
(
FString& OutHLSL |
GPU simulation functionality | NiagaraDataInterfaceRigidMeshCollisionQuery.h | |
virtual void GetFeedback
(
UNiagaraSystem* InAsset, |
Query the data interface to give feedback to the end user. | NiagaraDataInterfaceRigidMeshCollisionQuery.h | |
virtual bool GetFunctionHLSL
(
const FNiagaraDataInterfaceGPUParamInfo& ParamInfo, |
NiagaraDataInterfaceRigidMeshCollisionQuery.h | ||
virtual void GetParameterDefinitionHLSL
(
const FNiagaraDataInterfaceGPUParamInfo& ParamInfo, |
NiagaraDataInterfaceRigidMeshCollisionQuery.h | ||
virtual void GetVMExternalFunction
(
const FVMExternalFunctionBindingInfo& BindingInfo, |
UNiagaraDataInterface Interface | NiagaraDataInterfaceRigidMeshCollisionQuery.h | |
virtual bool HasPostSimulateTick() |
NiagaraDataInterfaceRigidMeshCollisionQuery.h | ||
virtual bool HasTickGroupPrereqs() |
NiagaraDataInterfaceRigidMeshCollisionQuery.h | ||
virtual bool InitPerInstanceData
(
void* PerInstanceData, |
Initializes the per instance data for this interface. | NiagaraDataInterfaceRigidMeshCollisionQuery.h | |
virtual int32 PerInstanceDataSize () |
Returns the size of the per instance data for this interface. | NiagaraDataInterfaceRigidMeshCollisionQuery.h | |
virtual bool PerInstanceTickPostSimulate
(
void* PerInstanceData, |
NiagaraDataInterfaceRigidMeshCollisionQuery.h | ||
virtual void ProvidePerInstanceDataForRenderThread
(
void* DataForRenderThread, |
Subclasses that wish to work with GPU systems/emitters must implement this. | NiagaraDataInterfaceRigidMeshCollisionQuery.h | |
virtual bool RequiresEarlyViewData() |
NiagaraDataInterfaceRigidMeshCollisionQuery.h | ||
virtual void SetShaderParameters
(
const FNiagaraDataInterfaceSetShaderParametersContext& Context |
Set the shader parameters will only be called if the data interface provided shader parameters. | NiagaraDataInterfaceRigidMeshCollisionQuery.h | |
virtual bool UpgradeFunctionCall
(
FNiagaraFunctionSignature& FunctionSignature |
Allows data interfaces the opportunity to rename / change the function signature and perform an upgrade. | NiagaraDataInterfaceRigidMeshCollisionQuery.h | |
virtual void ValidateFunction
(
const FNiagaraFunctionSignature& Function, |
Validates a function being compiled and allows interface classes to post custom compile errors when their API changes. | NiagaraDataInterfaceRigidMeshCollisionQuery.h |
Overridden from UNiagaraDataInterfaceBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BuildShaderParameters
(
FNiagaraShaderParametersBuilder& ShaderParametersBuilder |
NiagaraDataInterfaceRigidMeshCollisionQuery.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostInitProperties() |
UObject Interface | NiagaraDataInterfaceRigidMeshCollisionQuery.h | |
virtual void PostLoad() |
NiagaraDataInterfaceRigidMeshCollisionQuery.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool FilterActor
(
const AActor* Actor |
NiagaraDataInterfaceRigidMeshCollisionQuery.h | ||
bool FilterComponent
(
const UPrimitiveComponent* Component |
NiagaraDataInterfaceRigidMeshCollisionQuery.h |
Overridden from UNiagaraDataInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CopyToInternal
(
UNiagaraDataInterface* Destination |
Copy one niagara DI to this | NiagaraDataInterfaceRigidMeshCollisionQuery.h | |
virtual void GetFunctionsInternal
(
TArray< FNiagaraFunctionSignature >& OutFunctions |
NiagaraDataInterfaceRigidMeshCollisionQuery.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Tag_DEPRECATED | FString | NiagaraDataInterfaceRigidMeshCollisionQuery.h |