You are here: Start » AVL.NET » Function Reference » Region » Region Basics » AVL.CreateCrossRegion

AVL.CreateCrossRegion

Creates a cross-shaped region with given parameters.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void CreateCrossRegion
(
	AvlNet.Box inCrossBoundingBox,
	int inFrameWidth,
	int inFrameHeight,
	AvlNet.Region outRegion
)

Parameters

Name Type Range Default Description
inCrossBoundingBoxAvlNet.Box
inFrameWidthint<0, 65535>Width of the created region's frame.
inFrameHeightint<0, 65535>Height of the created region's frame.
outRegionAvlNet.RegionOutput region.

Description

The operation creates a region in a shape of a one-pixel-wide cross. Cross is described by its width, height and coordinates of upper-left corner of its bounding box.

The inFrameWidth and inFrameHeight parameters most often should be set equal to the dimensions of the image this region will be used with. If the input cross exceeds these dimensions, the output region will be cropped.

Examples

CreateCrossRegion run with inCrossBoundingBox parameters: X = 50, Y = 100, Width = 200, inCrossHeight = 100.

See also