FMath::ClosestPointOnSegment

Returns closest point on a segment to a given point.

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 FVector ClosestPointOnSegment
(
    const FVector & Point,
    const FVector & StartPoint,
    const FVector & EndPoint
)

Remarks

Returns closest point on a segment to a given point. The idea is to project point on line formed by segment. Then we see if the closest point on the line is outside of segment or inside.

Returns

point on the segment defined by (StartPoint, EndPoint) that is closest to Point.

Parameters

Parameter

Description

Point

point for which we find the closest point on the segment

StartPoint

StartPoint of segment

EndPoint

EndPoint of segment

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