You are here: Start » AVL.NET » AVL.CreateGridRegion(AvlNet.Box, int, int, int, int, AvlNet.Region)

AVL.CreateGridRegion(AvlNet.Box, int, int, int, int, AvlNet.Region)

Creates a grid-shaped region with given parameters.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax


public static void CreateGridRegion(
	AvlNet.Box inGridBoundingBox,
	int inHorizontalStep,
	int inVerticalStep,
	int inFrameWidth,
	int inFrameHeight,
	out AvlNet.Region outRegion
)

Parameters

inGridBoundingBox
Type: AvlNet.Box
inHorizontalStep
Type: System.Int32
Horizontal distance between vertical grid lines.
inVerticalStep
Type: System.Int32
Vertical distance between horizontal grid lines.
inFrameWidth
Type: System.Int32
Width of the created region's frame
inFrameHeight
Type: System.Int32
Height of the created region's frame
outRegion
Type: AvlNet.Region
Output region

Description

The operation creates a region in a shape of a one-pixel-wide grid. Grid is described by its width, height, distances between its lines and coordinates of its upper-left corner.

The inFrameWidth and inFrameHeight parameters most often should be set equal to the dimensions of the image this region will be used with.

Examples

CreateGridRegion run with inGridBoundingBox parameters: X = 0, Y = 0, inGridWidth = 300, inGridHeight = 300 and with inHorizontalStep = 60, inVerticalStep = 60

Errors

Error type Description
DomainError Output region too big in CreateGridRegion.

See also