Basics
ShapeRegion - ConvertToRegion
Convert the shape region into a Region object.
IN
| Name | Type | Description |
|---|---|---|
| InShapeRegion | ShapeRegion | The input ShapeRegion |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The computed region. |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - CreateShapeRegion_Create
Creates a new empty ShapeRegion tagged as 'Region'.
IN
| Name | Type | Description |
|---|---|---|
| InShapeRegion | ShapeRegion | The input ShapeRegion |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutShapeRegion | ShapeRegion | The ShapeRegion instance. |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - CreateShapeRegion_CreateFromCircle
Constructs a new ShapeRegion object given a Circle2D.
IN
| Name | Type | Description |
|---|---|---|
| InCircle | Circle2D | Circle. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutShapeRegion | ShapeRegion | The ShapeRegion instance. |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - CreateShapeRegion_CreateFromEllipse
Constructs a new ShapeRegion object given an Ellipse2D.
IN
| Name | Type | Description |
|---|---|---|
| InEllipse | Ellipse2D | Ellipse. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutShapeRegion | ShapeRegion | The ShapeRegion instance. |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - CreateShapeRegion_CreateFromPolygon
Constructs a new Shape Region object given a Path.
IN
| Name | Type | Description |
|---|---|---|
| InPolygon | Path | Polygon. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutShapeRegion | ShapeRegion | The ShapeRegion instance. |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - CreateShapeRegion_CreateFromRectangle
Creates a new ShapeRegion using the provided rectangle.
IN
| Name | Type | Description |
|---|---|---|
| InRectangle | Rectangle2D | Input rectangle. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutShapeRegion | ShapeRegion | The ShapeRegion instance. |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - CreateShapeRegion_CreateFromRegion
Creates a new ShapeRegion using the provided Region.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | Input region. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutShapeRegion | ShapeRegion | The ShapeRegion instance. |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - CreateShapeRegion_CreateFromRing
Constructs a new ShapeRegion object given a Ring2D.
IN
| Name | Type | Description |
|---|---|---|
| InRing | Ring2D | Ring. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutShapeRegion | ShapeRegion | The ShapeRegion instance. |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - CreateShapeRegion_CreateFromTag
Creates a new ShapeRegion object using the provided tag.
IN
| Name | Type | Description |
|---|---|---|
| InTag | Enum < ShapeRegionType > | Tag identifying the encapsulated object. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutShapeRegion | ShapeRegion | The ShapeRegion instance. |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - Deserialize
De-serialize a ShapeRegion 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 |
|---|---|---|
| OutShapeRegion | ShapeRegion | Deserialized object. |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - GetCircle
Returns the Circle2D contained in the ShapeRegion object.
IN
| Name | Type | Description |
|---|---|---|
| InShapeRegion | ShapeRegion | The input ShapeRegion |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircle2D | Circle2D | The associated circle. |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - GetEllipse
Returns the Ellipse2D contained in the ShapeRegion object.
IN
| Name | Type | Description |
|---|---|---|
| InShapeRegion | ShapeRegion | The input ShapeRegion |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutEllipse2D | Ellipse2D | The associated ellipse. |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - GetPolygon
Returns the Path contained in the ShapeRegion object.
IN
| Name | Type | Description |
|---|---|---|
| InShapeRegion | ShapeRegion | The input ShapeRegion |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | The associated path. |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - GetRectangle
Returns the Rectangle2D contained in the ShapeRegion object.
IN
| Name | Type | Description |
|---|---|---|
| InShapeRegion | ShapeRegion | The input ShapeRegion |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRectangle2D | Rectangle2D | The Rectangle2D contained in the ShapeRegion object. |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - GetRegion
Returns the Region contained in the ShapeRegion object.
IN
| Name | Type | Description |
|---|---|---|
| InShapeRegion | ShapeRegion | The input ShapeRegion |
| 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 contained in the ShapeRegion object. |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - GetRing
Returns the Ring2D contained in the ShapeRegion object.
IN
| Name | Type | Description |
|---|---|---|
| InShapeRegion | ShapeRegion | The input ShapeRegion |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRing2D | Ring2D | The associated ring. |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - GetTag
Returns the ShapeRegion tag.
IN
| Name | Type | Description |
|---|---|---|
| InShapeRegion | ShapeRegion | The input ShapeRegion |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutShapeRegionType | Enum < ShapeRegionType > | The associated tag. |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - IsEmpty
Returns true if the ShapeRegion contains at least one point, false otherwise.
IN
| Name | Type | Description |
|---|---|---|
| InShapeRegion | ShapeRegion | The input ShapeRegion |
| 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 ShapeRegion contains at least one point, false otherwise. |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - Serialize
Serializes the ShapeRegion object.
IN
| Name | Type | Description |
|---|---|---|
| InShapeRegion | ShapeRegion | The input ShapeRegion |
| 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 |
ShapeRegion - SetCircle
Sets the Circle2D of the ShapeRegion object.
IN
| Name | Type | Description |
|---|---|---|
| InShapeRegion | ShapeRegion | The input ShapeRegion |
| InCircle | Circle2D | Input circle. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutShapeRegion | ShapeRegion | The modified Core.Data.Types.ShapeRegion |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - SetEllipse
Sets the Ellipse2D of the ShapeRegion object.
IN
| Name | Type | Description |
|---|---|---|
| InShapeRegion | ShapeRegion | The input ShapeRegion |
| InEllipse | Ellipse2D | Input ellipse. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutShapeRegion | ShapeRegion | The modified Core.Data.Types.ShapeRegion |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - SetPolygon
Sets the Path of the ShapeRegion object.
IN
| Name | Type | Description |
|---|---|---|
| InShapeRegion | ShapeRegion | The input ShapeRegion |
| InPolygon | Path | Input path. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutShapeRegion | ShapeRegion | The modified Core.Data.Types.ShapeRegion |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - SetRectangle
Sets the Rectangle2D of the ShapeRegion object.
IN
| Name | Type | Description |
|---|---|---|
| InShapeRegion | ShapeRegion | The input ShapeRegion |
| InRectangle | Rectangle2D | Input rectangle. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutShapeRegion | ShapeRegion | The modified Core.Data.Types.ShapeRegion |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - SetRegion
Sets the Region of the ShapeRegion object.
IN
| Name | Type | Description |
|---|---|---|
| InShapeRegion | ShapeRegion | The input ShapeRegion |
| InRegion | Region | Input region. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutShapeRegion | ShapeRegion | The modified Core.Data.Types.ShapeRegion |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - SetRing
Sets the Ring2D of the ShapeRegion object.
IN
| Name | Type | Description |
|---|---|---|
| InShapeRegion | ShapeRegion | The input ShapeRegion |
| InRing | Ring2D | Input ring. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutShapeRegion | ShapeRegion | The modified Core.Data.Types.ShapeRegion |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - SetTag
Sets the tag of the ShapeRegion object.
IN
| Name | Type | Description |
|---|---|---|
| InShapeRegion | ShapeRegion | The input ShapeRegion |
| InTag | Enum < ShapeRegionType > | Input tag. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutShapeRegion | ShapeRegion | The modified Core.Data.Types.ShapeRegion |
| Error | ErrorState | Gets the execution error message |