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

Light Theme

Dark Theme

UPrimitiveComponent::GetClosestPointOnCollision

Returns the distance and closest point to the collision surface.

Windows

MacOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Components/PrimitiveComponent.h
Include	#include "Components/PrimitiveComponent.h"
Source	/Engine/Source/Runtime/Engine/Private/PrimitiveComponentPhysics.cpp

Syntax

float GetClosestPointOnCollision
(
    const FVector & Point,
    FVector & OutPointOnBody,
    FName BoneName
) const

Remarks

Returns the distance and closest point to the collision surface. Component must have simple collision to be queried for closest point.

Returns

Success if returns > 0.f, if returns 0.f, it is either not convex or inside of the point If returns < 0.f, this primitive does not have collsion

Parameters

Parameter	Description
Point	World 3D vector
OutPointOnBody	Point on the surface of collision closest to Point
BoneName	If a SkeletalMeshComponent, name of body to set center of mass of. 'None' indicates root body.

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

Take our survey

Dismiss