Basics
Region - Add_Points
Adds a new PointsSequence to the region, given the starting point and its length.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InOffset | Point2Di | Starting point. |
| InLength | Int | Sequence length. Range: 〔1, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The modified Core.Data.Types.Region |
| Error | ErrorState | Gets the execution error message |
Region - Add_PointSequence
Adds a new PointsSequence to the region.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InPointsSequence | PointsSequence | New PointsSequence. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The modified Core.Data.Types.Region |
| Error | ErrorState | Gets the execution error message |
Region - CreateRegion_Create
Creates a new empty Region.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The Region instance. |
| Error | ErrorState | Gets the execution error message |
Region - CreateRegion_CreateFromData
Creates a new Region using a frame and a set of points.
IN
| Name | Type | Description |
|---|---|---|
| InFrame | Size | Frame size. |
| InPointsSequences | PointsSequenceArray | Points sequences. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The Region instance. |
| Error | ErrorState | Gets the execution error message |
Region - CreateRegion_CreateFromFrame
Creates a new Region given a frame.
IN
| Name | Type | Description |
|---|---|---|
| InFrame | Size | Frame dimensions. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The Region instance. |
| Error | ErrorState | Gets the execution error message |
Region - CreateRegion_CreateFromFrameDimensions
Creates a new Region given frame dimensions.
IN
| Name | Type | Description |
|---|---|---|
| InWidth | Int | Frame width. Range: 〔0, +inf）. |
| InHeight | Int | Frame height. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The Region instance. |
| Error | ErrorState | Gets the execution error message |
Region - Deserialize
De-serialize a Region buffer.
IN
| Name | Type | Description |
|---|---|---|
| InBuffer | Buffer | Buffer containing the object. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | Deserialized object. |
| Error | ErrorState | Gets the execution error message |
Region - FromBox
Creates a new region from a box.
IN
| Name | Type | Description |
|---|---|---|
| InBox | Box | Box that contains the region points. |
| InFrame | Size | Size of the region frame. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The Region object. |
| Error | ErrorState | Gets the execution error message |
Region - FromBoxBorders
Creates a new region starting from the borders of a box.
IN
| Name | Type | Description |
|---|---|---|
| InBox | Box | Box used to compute borders. |
| InFrame | Size | Size of the region frame. |
| InBorderWidth | Int | Width of the box borders. Range: 〔0, +inf）. |
| InBorderPosition | Enum < BorderPosition > | Position used to compute borders starting from the provided box. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The Region object. |
| Error | ErrorState | Gets the execution error message |
Region - FromCircle
Creates a new region given a circle.
IN
| Name | Type | Description |
|---|---|---|
| InCircle | Circle2D | The circle |
| InFrame | Size | Region dimensions. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The Region object. |
| Error | ErrorState | Gets the execution error message |
Region - FromCross
Creates a new region from a cross shape.
IN
| Name | Type | Description |
|---|---|---|
| InCrossBoundingBox | Box | Box that contains the cross. |
| InFrame | Size | Region dimensions. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The Region object. |
| Error | ErrorState | Gets the execution error message |
Region - FromEllipse
Creates a new region from an ellipse object.
IN
| Name | Type | Description |
|---|---|---|
| InEllipse | Ellipse2D | Input ellipse. |
| InFrame | Size | Size of the region frame. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The Region object. |
| Error | ErrorState | Gets the execution error message |
Region - FromGrid
Creates a new region with a grid shape.
IN
| Name | Type | Description |
|---|---|---|
| InGridBoundingBox | Box | The box that contains the grid. |
| InFrame | Size | The region dimensions. |
| InHorizontalStep | Int | Step for the horizontal axis. Range: 〔1, +inf）. |
| InVerticalStep | Int | Step for the vertical axis. Range: 〔1, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The Region object. |
| Error | ErrorState | Gets the execution error message |
Region - FromLine
Creates a new region from a line.
IN
| Name | Type | Description |
|---|---|---|
| InLine | Line2D | Input line. |
| InFrame | Size | Region dimensions. |
| InWidth | Float | Width of the region built around the input line. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The Region object. |
| Error | ErrorState | Gets the execution error message |
Region - FromPath
Creates a new region given a path and a width.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | Reference path. |
| InFrame | Size | Region dimensions. |
| InWidth | Float | Width of the region built around the reference path. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The Region object. |
| Error | ErrorState | Gets the execution error message |
Region - FromPoints
Creates a new region compressing the provided points into sequences.
IN
| Name | Type | Description |
|---|---|---|
| InPositions | Point2DiArray | Array with all the region points. |
| InFrame | Size | Size of the region frame. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The Region object. |
| Error | ErrorState | Gets the execution error message |
Region - FromPolygon
Creates a new region given a polygon.
IN
| Name | Type | Description |
|---|---|---|
| InPolygon | Path | Reference polygon. |
| InFrame | Size | Region dimensions. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The Region object. |
| Error | ErrorState | Gets the execution error message |
Region - FromRectangle
Creates a new region given a rectangle.
IN
| Name | Type | Description |
|---|---|---|
| InRectangle | Rectangle2D | Input rectangle. |
| InFrame | Size | Region dimensions. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The Region object. |
| Error | ErrorState | Gets the execution error message |
Region - FromRing
Creates a new region from a ring.
IN
| Name | Type | Description |
|---|---|---|
| InRing | Ring2D | Input ring. |
| InFrame | Size | Region dimensions. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The Region object. |
| Error | ErrorState | Gets the execution error message |
Region - FromSegment
Creates a new region from a segment.
IN
| Name | Type | Description |
|---|---|---|
| InSegment | Segment2D | Input segment. |
| InFrame | Size | Region dimensions. |
| InWidth | Float | Width of the region built around the input segment. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The Region object. |
| Error | ErrorState | Gets the execution error message |
Region - GetData
Returns the raw data pointer to the PointsSequence array.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPointsSequence | PointsSequenceArray | The raw data pointer to the PointsSequence array. |
| Error | ErrorState | Gets the execution error message |
Region - GetFrame
Returns the region frame.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSize | Size | A size object. |
| Error | ErrorState | Gets the execution error message |
Region - GetPoints
Returns all the points contained in the region.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPoint2Di | Point2DiArray | Array containing region points. |
| Error | ErrorState | Gets the execution error message |
Region - GetSize
Returns the number of points sequence in the region.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutInt | Int | Number of points sequences in the region. |
| Error | ErrorState | Gets the execution error message |
Region - IsEmpty
Checks if the region contains any point.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutBool | Bool | True if the region contains at least one point, false otherwise. |
| Error | ErrorState | Gets the execution error message |
Region - IsOnFrame
Checks if the region is adjacent to its frame.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutBool | Bool | True if at least one point is adjacent to the frame, false otherwise. |
| Error | ErrorState | Gets the execution error message |
Region - Reserve
Reserves (but not allocates) space for the Region data.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InNewCapacity | Int | New capacity. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The modified Core.Data.Types.Region |
| Error | ErrorState | Gets the execution error message |
Region - Serialize
Serializes the object.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutByteBuffer | Buffer | Buffer where the object is stored. |
| Error | ErrorState | Gets the execution error message |
Region - SetFrame
Sets a new frame for the region.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InFrame | Size | New region frame. It must contain all the region points. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The modified Core.Data.Types.Region |
| Error | ErrorState | Gets the execution error message |
Region - Swap
Exchange the content of two regions.
IN
| Name | Type | Description |
|---|---|---|
| InRegion1 | Region | The input Region |
| InRegion2 | Region | The object that will be swapped. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion1 | Region | The modified Core.Data.Types.Region |
| Error | ErrorState | Gets the execution error message |
Region - Verify
Checks if the region is valid. Note: A region is valid if and only if 1. Its points sequences are ordered with increasing y coordinate. 2. Its points sequences are ordered with increasing x coordinate. 3. Its points sequences have positive length. 4. Its points sequences do not overlap and are not contiguous. 5. It does not contain points outside its frame.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The modified Core.Data.Types.Region |
| Error | ErrorState | Gets the execution error message |