You are here: Start » Function Reference » Basic » Box » BoxToBoxDistance

BoxToBoxDistance

Header:	FIL.h
Namespace:	fil
Module:	FoundationLite

Computes minimal distance between one of the points of the first box with one of the points of the second box.

Syntax

void fil::BoxToBoxDistance
(
	const fil::Box& inBox1,
	const fil::Box& inBox2,
	float inResolution,
	float& outDistance,
	ftl::Optional<fil::Segment2D&> outConnectingSegment = ftl::NIL
)

Parameters

Name	Type	Range	Default
inBox1	const Box&
inBox2	const Box&
inResolution	float	0.0 -	1.0f
outDistance	float&
outConnectingSegment	Optional<Segment2D&>		NIL

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outConnectingSegment.