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 > Core > Math > FMath > FMath::ClosestPointOnSegment2D

Light Theme

Dark Theme

FMath::ClosestPointOnSegment2D

[FVector2D](API\Runtime\Core\Math\FVector2D) version of ClosestPointOnSegment.

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

Remarks

FVector2D version of ClosestPointOnSegment. Returns closest point on a segment to a given 2D 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