CollisionConversions.h File Reference

#include "CoreMinimal.h"
#include "Engine/EngineTypes.h"
#include "EngineDefines.h"
#include "PhysicsEngine/BodyInstance.h"
#include "PhysicsPublic.h"

Go to the source code of this file.

Classes
struct	FCompareFHitResultTime

Macros
#define	DRAW_OVERLAPPING_TRIS   (!(UE_BUILD_SHIPPING || UE_BUILD_TEST))

Enumerations
enum class	EConvertQueryResult { Valid , Invalid }

Functions
EConvertQueryResult	ConvertQueryImpactHit (const UWorld *World, const FHitLocation &PHit, FHitResult &OutResult, float CheckLength, const FCollisionFilterData &QueryFilter, const FVector &StartLoc, const FVector &EndLoc, const FPhysicsGeometry *Geom, const FTransform &QueryTM, bool bReturnFaceIndex, bool bReturnPhysMat)
EConvertQueryResult	ConvertQueryImpactHit (const UWorld *World, const ChaosInterface::FPTLocationHit &PHit, FHitResult &OutResult, float CheckLength, const FCollisionFilterData &QueryFilter, const FVector &StartLoc, const FVector &EndLoc, const FPhysicsGeometry *Geom, const FTransform &QueryTM, bool bReturnFaceIndex, bool bReturnPhysMat)
template<typename Hit >
EConvertQueryResult	ConvertTraceResults (bool &OutHasValidBlockingHit, const UWorld *World, int32 NumHits, Hit *Hits, float CheckLength, const FCollisionFilterData &QueryFilter, TArray< FHitResult > &OutHits, const FVector &StartLoc, const FVector &EndLoc, const FPhysicsGeometry *Geom, const FTransform &QueryTM, float MaxDistance, bool bReturnFaceIndex, bool bReturnPhysMat)
template<typename Hit >
EConvertQueryResult	ConvertTraceResults (bool &OutHasValidBlockingHit, const UWorld *World, int32 NumHits, Hit *Hits, float CheckLength, const FCollisionFilterData &QueryFilter, FHitResult &OutHits, const FVector &StartLoc, const FVector &EndLoc, const FPhysicsGeometry *Geom, const FTransform &QueryTM, float MaxDistance, bool bReturnFaceIndex, bool bReturnPhysMat)
void	ConvertQueryOverlap (const UWorld *World, const FPhysicsShape &PShape, const FPhysicsActorHandle &PActor, FOverlapResult &OutOverlap, const FCollisionFilterData &QueryFilter)
bool	IsBlocking (const FPhysicsShape &PShape, const FCollisionFilterData &QueryFilter)
bool	ConvertOverlapResults (int32 NumOverlaps, FHitOverlap *POverlapResults, const FCollisionFilterData &QueryFilter, TArray< FOverlapResult > &OutOverlaps)
bool	ConvertOverlapResults (int32 NumOverlaps, ChaosInterface::FPTOverlapHit *POverlapResults, const FCollisionFilterData &QueryFilter, TArray< FOverlapResult > &OutOverlaps)
FHitResult	ConvertOverlapToHitResult (const FOverlapResult &Overlap)

Macro Definition Documentation

DRAW_OVERLAPPING_TRIS

#define DRAW_OVERLAPPING_TRIS   (!(UE_BUILD_SHIPPING || UE_BUILD_TEST))

Enumeration Type Documentation

EConvertQueryResult

enum class EConvertQueryResult

strong

Enumerator
Valid
Invalid

Function Documentation

ConvertOverlapResults() [1/2]

bool ConvertOverlapResults	(	int32	NumOverlaps,
		ChaosInterface::FPTOverlapHit *	POverlapResults,
		const FCollisionFilterData &	QueryFilter,
		TArray< FOverlapResult > &	OutOverlaps
	)

ConvertOverlapResults() [2/2]

bool ConvertOverlapResults	(	int32	NumOverlaps,
		FHitOverlap *	POverlapResults,
		const FCollisionFilterData &	QueryFilter,
		TArray< FOverlapResult > &	OutOverlaps
	)

Util to convert a list of overlap hits into FOverlapResult and add them to OutOverlaps, if not already there

Parameters

NumOverlaps	Number Of Overlaps that happened
POverlapResults	Overlaps list
QueryFilter	Query filter for converting

Returns

OutOverlaps Converted data

ConvertOverlapToHitResult()

FHitResult ConvertOverlapToHitResult

(

const FOverlapResult &

Overlap

)

Converts an overlap result to a hit result.

ConvertQueryImpactHit() [1/2]

EConvertQueryResult ConvertQueryImpactHit	(	const UWorld *	World,
		const ChaosInterface::FPTLocationHit &	PHit,
		FHitResult &	OutResult,
		float	CheckLength,
		const FCollisionFilterData &	QueryFilter,
		const FVector &	StartLoc,
		const FVector &	EndLoc,
		const FPhysicsGeometry *	Geom,
		const FTransform &	QueryTM,
		bool	bReturnFaceIndex,
		bool	bReturnPhysMat
	)

ConvertQueryImpactHit() [2/2]

EConvertQueryResult ConvertQueryImpactHit	(	const UWorld *	World,
		const FHitLocation &	PHit,
		FHitResult &	OutResult,
		float	CheckLength,
		const FCollisionFilterData &	QueryFilter,
		const FVector &	StartLoc,
		const FVector &	EndLoc,
		const FPhysicsGeometry *	Geom,
		const FTransform &	QueryTM,
		bool	bReturnFaceIndex,
		bool	bReturnPhysMat
	)

Util to convert single physX hit (raycast or sweep) to our hit result

Parameters

PHit	PhysX hit data
OutResult	(out) Result converted
CheckLength	Distance of trace
QueryFilter	Query Filter
StartLoc	Start of trace
EndLoc
Geom
bReturnFaceIndex	True if we want to lookup the face index
bReturnPhysMat	True if we want to lookup the physical material

Returns

Whether result passed NaN/Inf checks.

ConvertQueryOverlap()

void ConvertQueryOverlap	(	const UWorld *	World,
		const FPhysicsShape &	PShape,
		const FPhysicsActorHandle &	PActor,
		FOverlapResult &	OutOverlap,
		const FCollisionFilterData &	QueryFilter
	)

Util to convert physX or Chaos overlap query to our overlap result

Parameters

PShape	Shape that overlaps
PActor	Specific actor as PShape might be shared among many actors
OutOverlap	(out) Result converted
QueryFilter	Query Filter

ConvertTraceResults() [1/2]

template<typename Hit >

EConvertQueryResult ConvertTraceResults	(	bool &	OutHasValidBlockingHit,
		const UWorld *	World,
		int32	NumHits,
		Hit *	Hits,
		float	CheckLength,
		const FCollisionFilterData &	QueryFilter,
		FHitResult &	OutHits,
		const FVector &	StartLoc,
		const FVector &	EndLoc,
		const FPhysicsGeometry *	Geom,
		const FTransform &	QueryTM,
		float	MaxDistance,
		bool	bReturnFaceIndex,
		bool	bReturnPhysMat
	)

ConvertTraceResults() [2/2]

template<typename Hit >

EConvertQueryResult ConvertTraceResults	(	bool &	OutHasValidBlockingHit,
		const UWorld *	World,
		int32	NumHits,
		Hit *	Hits,
		float	CheckLength,
		const FCollisionFilterData &	QueryFilter,
		TArray< FHitResult > &	OutHits,
		const FVector &	StartLoc,
		const FVector &	EndLoc,
		const FPhysicsGeometry *	Geom,
		const FTransform &	QueryTM,
		float	MaxDistance,
		bool	bReturnFaceIndex,
		bool	bReturnPhysMat
	)

Util to convert physX sweep results to unreal hit results and add to array

Parameters

OutHasValidBlockingHit	set to whether there is a valid blocking hit found in the results.
NumHits	Number of Hits
Hits	Array of hits
CheckLength	Distance of trace
QueryFilter	Query Filter
StartLoc	Start of trace
EndLoc	End of trace
Geom
bReturnFaceIndex	True if we want to lookup the face index
bReturnPhysMat	True if we want to lookup the physical material

Returns

Whether all results passed NaN/Inf checks.

IsBlocking()

bool IsBlocking	(	const FPhysicsShape &	PShape,
		const FCollisionFilterData &	QueryFilter
	)

Util to determine if a shape is deemed blocking based on the query filter

Parameters

PShape

Shape that overlaps @QueryFilter Query Filter

Returns

true if the query filter and shape filter resolve to be blocking