You are here: Start » Function Reference » Region Basics » CreateCrossRegion

CreateCrossRegion

Creates a cross-shaped region with given parameters.

Syntax

void avl::CreateCrossRegion
(
	const avl::Box& inCrossBoundingBox,
	int inFrameWidth,
	int inFrameHeight,
	avl::Region& outRegion
)

void CreateCrossRegion
(
	Box inCrossBoundingBox,
	int inFrameWidth,
	int inFrameHeight,
	out Region outRegion
)

Parameters

Name	Type	Range	Description
inCrossBoundingBox	const Box&
inFrameWidth	int	0 -	Width of the created region's frame
inFrameHeight	int	0 -	Height of the created region's frame
outRegion	Region&		Output 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.

Hints

Remember to set inFrameWidth and inFrameHeight inputs to specify the region frame.

Examples

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

Errors

Error type	Description
DomainError	Output region too big in CreateCrossRegion.