Functions
	oevislib_net.Region.Region ()
	Creates a new empty Region.
	oevislib_net.Region.Region (int inWidth, int inHeight)
	Creates a new Region given frame dimensions.
	oevislib_net.Region.Region (Size inFrame)
	Creates a new Region given a frame.
	oevislib_net.Region.Region (Size inFrame, Array< PointsSequence > inPointsSequences)
	Creates a new Region using a frame and a set of points.
ByteBuffer	oevislib_net.Region.Serialize ()
	Serializes the object.
static Region	oevislib_net.Region.Deserialize (ByteBuffer inBuffer)
	De-serialize a Region buffer.
Size	oevislib_net.Region.GetFrame ()
	Returns the region frame.
int	oevislib_net.Region.GetSize ()
	Returns the number of points sequence in the region.
PointsSequence[]	oevislib_net.Region.GetData ()
	Returns the raw data pointer to the PointsSequence array.
void	oevislib_net.Region.Reserve (int inNewCapacity)
	Reserves (but not allocates) space for the Region data.
void	oevislib_net.Region.SetFrame (Size inFrame)
	Sets a new frame for the region.
void	oevislib_net.Region.Swap (Region inRegion)
	Exchange the content of two regions.
void	oevislib_net.Region.Add (PointsSequence inPointsSequence)
	Adds a new PointsSequence to the region.
void	oevislib_net.Region.Add (Point2Di inOffset, int inLength)
	Adds a new PointsSequence to the region, given the starting point and its length.
Array< Point2Di >	oevislib_net.Region.GetPoints ()
	Returns all the points contained in the region.
static Region	oevislib_net.Region.FromPoints (Array< Point2Di > inPositions, Size inFrame)
	Creates a new region compressing the provided points into sequences.
static Region	oevislib_net.Region.FromBox (Box inBox, Size inFrame)
	Creates a new region from a box.
static Region	oevislib_net.Region.FromBoxBorders (Box inBox, Size inFrame, int inBorderWidth=1, BorderPosition inBorderPosition=BorderPosition.Centered)
	Creates a new region starting from the borders of a box.
static Region	oevislib_net.Region.FromEllipse (Ellipse2D inEllipse, Size inFrame, Optional< UCS2D > inEllipseAlignment=null, Optional< Ellipse2D > outAlignedEllipse=null)
	Creates a new region from an ellipse object.
static Region	oevislib_net.Region.FromRing (Ring2D inRing, Size inFrame, Optional< UCS2D > inRingAlignment=null, Optional< Ring2D > outAlignedRing=null)
	Creates a new region from a ring.
static Region	oevislib_net.Region.FromCross (Box inCrossBoundingBox, Size inFrame)
	Creates a new region from a cross shape.
static Region	oevislib_net.Region.FromGrid (Box inGridBoundingBox, Size inFrame, int inHorizontalStep=1, int inVerticalStep=1)
	Creates a new region with a grid shape.
static Region	oevislib_net.Region.FromCircle (Circle2D inCircle, Size inFrame, Optional< UCS2D > inCircleAlignment=null, Optional< Circle2D > outAlignedCircle=null)
	Creates a new region given a circle.
static Region	oevislib_net.Region.FromPolygon (Path inPolygon, Size inFrame, Optional< UCS2D > inPolygonAlignment=null, Optional< Path > outAlignedPolygon=null)
	Creates a new region given a polygon.
static Region	oevislib_net.Region.FromPath (Path inPath, Size inFrame, float inWidth=1.0f, Optional< UCS2D > inPathAlignment=null, Optional< Path > outAlignedPath=null)
	Creates a new region given a path and a width.
static Region	oevislib_net.Region.FromRectangle (Rectangle2D inRectangle, Size inFrame, Optional< UCS2D > inRectangleAlignment=null, Optional< Rectangle2D > outAlignedRectangle=null)
	Creates a new region given a rectangle.
bool	oevislib_net.Region.IsOnFrame ()
	Checks if the region is adjacent to its frame.
bool	oevislib_net.Region.IsEmpty ()
	Checks if the region contains any point.
static Region	oevislib_net.Region.FromSegment (Segment2D inSegment, Size inFrame, float inWidth=1.0f, Optional< UCS2D > inSegmentAlignment=null, Optional< Segment2D > outAlignedSegment=null)
	Creates a new region from a segment.
static Region	oevislib_net.Region.FromLine (Line2D inLine, Size inFrame, float inWidth=1, Optional< UCS2D > inLineAlignment=null, Optional< Line2D > outAlignedLine=null)
	Creates a new region from a line.
void	oevislib_net.Region.Verify ()
	Checks if the region is valid.

Detailed Description

Function Documentation

◆ Add() [1/2]

void oevislib_net.Region.Add	(	Point2Di	inOffset,
		int	inLength )

inline

Adds a new PointsSequence to the region, given the starting point and its length.

Parameters

inOffset	Starting point.
inLength	Sequence length. Range: [1, +inf).

◆ Add() [2/2]

void oevislib_net.Region.Add ( PointsSequence inPointsSequence )

inline

Adds a new PointsSequence to the region.

Parameters

inPointsSequence New PointsSequence.

◆ Deserialize()

Region oevislib_net.Region.Deserialize ( ByteBuffer inBuffer )

inlinestatic

De-serialize a Region buffer.

Parameters

inBuffer Buffer containing the object.

Returns: Deserialized object.

◆ FromBox()

Region oevislib_net.Region.FromBox	(	Box	inBox,
		Size	inFrame )

inlinestatic

Creates a new region from a box.

Parameters

inBox	Box that contains the region points.
inFrame	Size of the region frame.

Returns: The Region object.

◆ FromBoxBorders()

Region oevislib_net.Region.FromBoxBorders	(	Box	inBox,
		Size	inFrame,
		int	inBorderWidth = 1,
		BorderPosition	inBorderPosition = BorderPosition::Centered )

inlinestatic

Creates a new region starting from the borders of a box.

Parameters

inBox	Box used to compute borders.
inFrame	Size of the region frame.
inBorderWidth	Width of the box borders. Range: [0, +inf).
inBorderPosition	Position used to compute borders starting from the provided box.

Returns: The Region object.

◆ FromCircle()

Region oevislib_net.Region.FromCircle	(	Circle2D	inCircle,
		Size	inFrame,
		Optional< UCS2D >	inCircleAlignment = null,
		Optional< Circle2D >	outAlignedCircle = null )

inlinestatic

Creates a new region given a circle.

Parameters

inCircle	The circle
inFrame	Region dimensions.
inCircleAlignment	Coordinate system used to align the input circle.
outAlignedCircle	Input circle aligned using the provided coordinate system.

Returns: The Region object.

◆ FromCross()

Region oevislib_net.Region.FromCross	(	Box	inCrossBoundingBox,
		Size	inFrame )

inlinestatic

Creates a new region from a cross shape.

Parameters

inCrossBoundingBox	Box that contains the cross.
inFrame	Region dimensions.

Returns: The Region object.

◆ FromEllipse()

Region oevislib_net.Region.FromEllipse	(	Ellipse2D	inEllipse,
		Size	inFrame,
		Optional< UCS2D >	inEllipseAlignment = null,
		Optional< Ellipse2D >	outAlignedEllipse = null )

inlinestatic

Creates a new region from an ellipse object.

Parameters

inEllipse	Input ellipse.
inFrame	Size of the region frame.
inEllipseAlignment	Coordinate system used to align the ellipse object.
outAlignedEllipse	Ellipse object aligned to the provided coordinate system.

Returns: The Region object.

◆ FromGrid()

Region oevislib_net.Region.FromGrid	(	Box	inGridBoundingBox,
		Size	inFrame,
		int	inHorizontalStep = 1,
		int	inVerticalStep = 1 )

inlinestatic

Creates a new region with a grid shape.

Parameters

inGridBoundingBox	The box that contains the grid.
inFrame	The region dimensions.
inHorizontalStep	Step for the horizontal axis. Range: [1, +inf).
inVerticalStep	Step for the vertical axis. Range: [1, +inf).

Returns: The Region object.

◆ FromLine()

Region oevislib_net.Region.FromLine	(	Line2D	inLine,
		Size	inFrame,
		float	inWidth = 1,
		Optional< UCS2D >	inLineAlignment = null,
		Optional< Line2D >	outAlignedLine = null )

inlinestatic

Creates a new region from a line.

Parameters

inLine	Input line.
inFrame	Region dimensions.
inWidth	Width of the region built around the input line. Range: [0, +inf).
inLineAlignment	Coordinate system used to align the input line.
outAlignedLine	Input line aligned using the provided coordinate system.

Returns: The Region object.

◆ FromPath()

Region oevislib_net.Region.FromPath	(	Path	inPath,
		Size	inFrame,
		float	inWidth = 1::0f,
		Optional< UCS2D >	inPathAlignment = null,
		Optional< Path >	outAlignedPath = null )

inlinestatic

Creates a new region given a path and a width.

Parameters

inPath	Reference path.
inFrame	Region dimensions.
inWidth	Width of the region built around the reference path. Range: [0, +inf).
inPathAlignment	Coordinate system used to align the input path.
outAlignedPath	Input path aligned using the provided coordinate system.

Returns: The Region object.

◆ FromPoints()

Region oevislib_net.Region.FromPoints	(	Array< Point2Di >	inPositions,
		Size	inFrame )

inlinestatic

Creates a new region compressing the provided points into sequences.

Parameters

inPositions	Array with all the region points.
inFrame	Size of the region frame.

Returns: The Region object.

◆ FromPolygon()

Region oevislib_net.Region.FromPolygon	(	Path	inPolygon,
		Size	inFrame,
		Optional< UCS2D >	inPolygonAlignment = null,
		Optional< Path >	outAlignedPolygon = null )

inlinestatic

Creates a new region given a polygon.

Parameters

inPolygon	Reference polygon.
inFrame	Region dimensions.
inPolygonAlignment	Coordinate system used to align the input polygon.
outAlignedPolygon	Input polygon aligned using the provided coordinate system.

Returns: The Region object.

◆ FromRectangle()

Region oevislib_net.Region.FromRectangle	(	Rectangle2D	inRectangle,
		Size	inFrame,
		Optional< UCS2D >	inRectangleAlignment = null,
		Optional< Rectangle2D >	outAlignedRectangle = null )

inlinestatic

Creates a new region given a rectangle.

Parameters

inRectangle	Input rectangle.
inFrame	Region dimensions.
inRectangleAlignment	Coordinate system used to align the input rectangle.
outAlignedRectangle	Input rectangle aligned using the provided coordinate system.

Returns: The Region object.

◆ FromRing()

Region oevislib_net.Region.FromRing	(	Ring2D	inRing,
		Size	inFrame,
		Optional< UCS2D >	inRingAlignment = null,
		Optional< Ring2D >	outAlignedRing = null )

inlinestatic

Creates a new region from a ring.

Parameters

inRing	Input ring.
inFrame	Region dimensions.
inRingAlignment	Coordinate system used to align the ring object.
outAlignedRing	Ring object aligned to the provided coordinate system.

Returns: The Region object.

◆ FromSegment()

Region oevislib_net.Region.FromSegment	(	Segment2D	inSegment,
		Size	inFrame,
		float	inWidth = 1::0f,
		Optional< UCS2D >	inSegmentAlignment = null,
		Optional< Segment2D >	outAlignedSegment = null )

inlinestatic

Creates a new region from a segment.

Parameters

inSegment	Input segment.
inFrame	Region dimensions.
inWidth	Width of the region built around the input segment. Range: [0, +inf).
inSegmentAlignment	Coordinate system used to align the input segment.
outAlignedSegment	Segment object aligned using the provided coordinate system.

Returns: The Region object.

◆ GetData()

PointsSequence[] oevislib_net.Region.GetData ( )

inline

Returns the raw data pointer to the PointsSequence array.

Returns: The raw data pointer to the PointsSequence array.

◆ GetFrame()

Size oevislib_net.Region.GetFrame ( )

inline

Returns the region frame.

Returns: A size object.

◆ GetPoints()

Array< Point2Di > oevislib_net.Region.GetPoints ( )

inline

Returns all the points contained in the region.

Returns: Array containing region points.

◆ GetSize()

int oevislib_net.Region.GetSize ( )

inline

Returns the number of points sequence in the region.

Returns: Number of points sequences in the region.

◆ IsEmpty()

bool oevislib_net.Region.IsEmpty ( )

inline

Checks if the region contains any point.

Returns: True if the region contains at least one point, false otherwise.

◆ IsOnFrame()

bool oevislib_net.Region.IsOnFrame ( )

inline

Checks if the region is adjacent to its frame.

Returns: True if at least one point is adjacent to the frame, false otherwise.

◆ Region() [1/4]

oevislib_net.Region.Region ( )

inline

Creates a new empty Region.

◆ Region() [2/4]

oevislib_net.Region.Region	(	int	inWidth,
		int	inHeight )

inline

Creates a new Region given frame dimensions.

Parameters

inWidth	Frame width. Range: [0, +inf).
inHeight	Frame height. Range: [0, +inf).

◆ Region() [3/4]

oevislib_net.Region.Region ( Size inFrame )

inline

Creates a new Region given a frame.

Parameters

inFrame Frame dimensions.

◆ Region() [4/4]

oevislib_net.Region.Region	(	Size	inFrame,
		Array< PointsSequence >	inPointsSequences )

inline

Creates a new Region using a frame and a set of points.

Parameters

inFrame	Frame size.
inPointsSequences	Points sequences.

◆ Reserve()

void oevislib_net.Region.Reserve ( int inNewCapacity )

inline

Reserves (but not allocates) space for the Region data.

Parameters

inNewCapacity New capacity. Range: [0, +inf).

◆ Serialize()

ByteBuffer oevislib_net.Region.Serialize ( )

inline

Serializes the object.

Returns: Buffer where the object is stored.

◆ SetFrame()

void oevislib_net.Region.SetFrame ( Size inFrame )

inline

Sets a new frame for the region.

Parameters

inFrame New region frame. It must contain all the region points.

◆ Swap()

void oevislib_net.Region.Swap ( Region inRegion )

inline

Exchange the content of two regions.

Parameters

inRegion The object that will be swapped.

◆ Verify()

void oevislib_net.Region.Verify ( )

inline

Checks if the region is valid.

A region is valid if and only ifIts points sequences are ordered with increasing y coordinate. Its points sequences are ordered with increasing x coordinate. Its points sequences have positive length. Its points sequences do not overlap and are not contiguous. It does not contain points outside its frame.

Functions

Detailed Description

Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ Deserialize()

◆ FromBox()

◆ FromBoxBorders()

◆ FromCircle()

◆ FromCross()

◆ FromEllipse()

◆ FromGrid()

◆ FromLine()

◆ FromPath()

◆ FromPoints()

◆ FromPolygon()

◆ FromRectangle()

◆ FromRing()

◆ FromSegment()

◆ GetData()

◆ GetFrame()

◆ GetPoints()

◆ GetSize()

◆ IsEmpty()

◆ IsOnFrame()

◆ Region() [1/4]

◆ Region() [2/4]

◆ Region() [3/4]

◆ Region() [4/4]

◆ Reserve()

◆ Serialize()

◆ SetFrame()

◆ Swap()

◆ Verify()