RealDocs

UKismetMathLibrary::Matrix_GetFrustumLeftPlane

function Engine Blueprint Since 4.0
#include "Kismet/KismetMathLibrary.h"
Access: public Specifiers: staticBlueprintPure

Description

Extracts the left clipping plane from a view-projection matrix. Returns false if extraction fails.

Caveats & Gotchas

  • The plane normal points inward (into the frustum), so a positive PlaneDot result means the point is inside the frustum on this side.
  • Assumes a row-major view-projection matrix laid out in the UE convention (right-handed, row vectors); a column-major matrix will produce a wrong result.

Signature

static UE_INL_API bool Matrix_GetFrustumLeftPlane(const FMatrix& M, FPlane& OutPlane)

Parameters

Name Type Description Default
M const FMatrix& The view-projection matrix to extract the left frustum plane from.
OutPlane FPlane& The extracted left plane of the frustum.

Return Type

bool

Example

Manual frustum culling against left plane C++
FPlane LeftPlane;
if (UKismetMathLibrary::Matrix_GetFrustumLeftPlane(ViewProjMatrix, LeftPlane))
{
    bool bInsideLeft = LeftPlane.PlaneDot(TestPoint) >= 0.0f;
}

Version History

Introduced in: 4.0

Version Status Notes
5.6 stable

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.