You are here: Start » AVL.NET » Function Reference » Region » Region Features » AVL.RegionInscribedBox

AVL.RegionInscribedBox

Computes the largest box contained in a region.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void RegionInscribedBox
(
	AvlNet.Region inRegion,
	float inMinAspectRatio,
	float? inMaxAspectRatio,
	int inMinWidth,
	int? inMaxWidth,
	int inMinHeight,
	int? inMaxHeight,
	out AvlNet.Box? outBox
)

Parameters

Name Type Range Default Description
inRegionAvlNet.RegionInput region.
inMinAspectRatiofloat<0.0f, INF>0.0fMinimal aspect ratio of found box. Default value: 0.0f.
inMaxAspectRatiofloat?<0.0f, INF>Maximal aspect ratio of found box (reciprocal of inMinAspectRatio by default). Default value: atl::NIL.
inMinWidthint<1, 65535>1Minimal width of found box. Default value: 1.
inMaxWidthint?<1, 65535>Maximal width of found box. Default value: atl::NIL.
inMinHeightint<1, 65535>1Minimal height of found box. Default value: 1.
inMaxHeightint?<1, 65535>Maximal height of found box. Default value: atl::NIL.
outBoxAvlNet.Box?Found box with largest area.

Examples

RegionInscribedBox performed on a sample region with inMaxAspectRatio = Auto.

RegionInscribedBox performed on a sample region with inMaxAspectRatio = 2.0.

Function Overrides

See also