FMath::PlaneAABBRelativePosition

Determine the position of an AABB relative to a plane: completely above (in the direction of the normal of the plane), completely below or intersects it

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Math/UnrealMathUtility.h

Include

#include "Math/UnrealMathUtility.h"

Source

/Engine/Source/Runtime/Core/Private/Math/UnrealMath.cpp

Syntax

static int32 PlaneAABBRelativePosition
(
    const FPlane & P,
    const FBox & AABB
)

Remarks

Determine the position of an AABB relative to a plane: completely above (in the direction of the normal of the plane), completely below or intersects it

Returns

-1 if below, 1 if above, 0 if intersects

Parameters

Parameter

Description

P

the plane to test

AABB

the axis aligned bounding box to test

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