1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceRigidMeshCollisionQuery

UNiagaraDataInterfaceRigidMeshCollisionQuery

Data Interface used to collide against static meshes - whether it is the mesh distance field or a physics asset's collision primitive

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

References

   
Module Niagara
Header /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraDataInterfaceRigidMeshCollisionQuery.h
Include #include "NiagaraDataInterfaceRigidMeshCollisionQuery.h"

Syntax

UCLASS&40;EditInlineNew, Category&61;"Collision", Meta&61;&40;DisplayName&61;"Rigid Mesh Collision Query"&41;&41;  
class UNiagaraDataInterfaceRigidMeshCollisionQuery : public UNiagaraDataInterface

Remarks

Data Interface used to collide against static meshes - whether it is the mesh distance field or a physics asset's collision primitive

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere TArray< FName > ActorTags Set of tags used to match against actors when searching for RigidBody providers.
Public variable UProperty Category, EditAnywhere TArray< FName > ComponentTags Set of tags used to match against components when searching for RigidBody providers.
Public variable UProperty Category, EditAnywhere int MaxNumPrimitives Maximum number of RigidBody represented by this DataInterface.
Public variable UProperty Category, EditAnywhere bool OnlyUseMoveable If enabled only actors that are considered moveable will be searched for RigidBodies.
Public variable UProperty Category, EditAnywhere TArray< TSoftObjectPtr< AActor > > SourceActors Hardcoded references to actors that will be used as RigidBody providers.
Public variable UProperty Category, EditAnywhere bool UseComplexCollisions If enabled, complex collisions will be searched for.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function Const bool

FilterActor ( const AActor* Actor
)

  
Protected function Const bool

FilterComponent ( const UPrimitiveComponent* Component
)

  
Public function Const bool

FindActors ( UWorld* World,
FNDIRigidMeshCollisionData& InstanceData,
ECollisionChannel Channel,
const FVector& OverlapLocation,
const FVector& OverlapExtent,
const FQuat& OverlapRotation
)

  
Public function void

FindActorsCPU ( FVectorVMExternalFunctionContext& Context
)

  
Public function bool  
Public function Const bool  

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 ETickingGroup

CalculateTickGroup ( const void* PerInstanceData
)

  
Public function Virtual Const bool  
Protected function Virtual Const bool Copy one niagara DI to this
Public function Virtual void

DestroyPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

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

DrawDebugHud ( FNDIDrawDebugHudContext& DebugHudContext
)

 Override this function to provide additional context to the debug HUD.
Public function Virtual Const bool

Equals ( const UNiagaraDataInterface* Other
)

 Determines if this DataInterface is the same as another.
Public function Virtual void

GetCommonHLSL ( FString& OutHLSL
)

 GPU simulation functionality
Public function Virtual void Query the data interface to give feedback to the end user.
Public function Virtual bool

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

  
Public function Virtual void UNiagaraDataInterface 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* SystemInstance
)

 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

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

  
Public function Virtual void

ProvidePerInstanceDataForRenderThread ( void* DataForRenderThread,
void* PerInstanceData,
const FNiagaraSystemInstanceID& SystemInstance
)

 Subclasses that wish to work with GPU systems/emitters must implement this.
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 UObject Interface
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Deprecated Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta bool GlobalSearchAllowed Global search will be deprecated in favor of using a spatial search through the FindActors function.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta bool GlobalSearchFallback_Unscripted Global search will be deprecated in favor of using a spatial search through the FindActors function.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta bool GlobalSearchForced Global search will be deprecated in favor of using a spatial search through the FindActors function.
Public variable UProperty FString Tag_DEPRECATED  

Deprecated Functions

  Type Name Description
Public function Const bool Global search will be deprecated in favor of using a spatial search through the FindActors function.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page