Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > GeometryCore > TFrame3 > TFrame3::RayPlaneIntersection

Light Theme

Dark Theme

TFrame3::RayPlaneIntersection

Compute intersection of ray with plane defined by frame origin and axis as normal

Choose your operating system:

Windows

macOS

Linux

References

Module	GeometryCore
Header	/Engine/Source/Runtime/GeometryCore/Public/FrameTypes.h
Include	#include "FrameTypes.h"

Syntax

bool RayPlaneIntersection
(
    const TVector< RealType > & RayOrigin,
    const TVector< RealType > & RayDirection,
    int PlaneNormalAxis,
    UE::Math::TVector< RealType > & HitPointOut
) const

Remarks

Compute intersection of ray with plane defined by frame origin and axis as normal

Returns

true if ray intersects plane and HitPointOut is valid

Parameters

Parameter	Description
RayOrigin	origin of ray
RayDirection	direction of ray
PlaneNormalAxis	which axis of frame to use as plane normal
HitPointOut	intersection point, or invalid point if ray does not hit plane or is parallel to plane