Skip to content

Basics

Vector2D - CreateVector2D_Create

Creates a default Vector2D with length 0.

IN

Name Type Description
InVector2D Vector2D The input Vector2D
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutVector2D Vector2D The Vector2D instance.
Error ErrorState Gets the execution error message

Vector2D - CreateVector2D_CreateFromFloats

Creates a new Vector2D given its dimensions.

IN

Name Type Description
InDeltaX Float Vector length along the X axis.
InDeltaY Float Vector length along the Y axis.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutVector2D Vector2D The Vector2D instance.
Error ErrorState Gets the execution error message

Vector2D - CreateVector2D_CreateFromInts

Creates a new Vector2D given its dimensions.

IN

Name Type Description
InDeltaX Int Vector length along the X axis.
InDeltaY Int Vector length along the Y axis.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutVector2D Vector2D The Vector2D instance.
Error ErrorState Gets the execution error message

Vector2D - CreateVector2D_CreateFromPoints

Creates a new Vector2D using the provided points.

IN

Name Type Description
InFrom Point2D Starting point.
InTo Point2D Ending point.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutVector2D Vector2D The Vector2D instance.
Error ErrorState Gets the execution error message

Vector2D - CrossProduct

Returns the cross product of two vectors.

IN

Name Type Description
InVector1 Vector2D First vector.
InVector2 Vector2D Second vector.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutFloat Float Cross product.
Error ErrorState Gets the execution error message

Vector2D - Deserialize

De-serialize a Vector2D 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
OutVector2D Vector2D Deserialized object.
Error ErrorState Gets the execution error message

Vector2D - DotProduct

Returns the dot product of two vectors.

IN

Name Type Description
InVector1 Vector2D First vector.
InVector2 Vector2D Second vector.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutFloat Float Dot product.
Error ErrorState Gets the execution error message

Vector2D - Serialize

Serializes the object.

IN

Name Type Description
InVector2D Vector2D The input Vector2D
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

UCS2D - CreateUCS2D_Create

Creates the default UCS2D with default values.

IN

Name Type Description
InUCS2D UCS2D The input UCS2D
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutUCS2D UCS2D The UCS2D instance.
Error ErrorState Gets the execution error message

UCS2D - CreateUCS2D_CreateFromFloats

Creates a new UCS2D given origin coordinates, angle and scale.

IN

Name Type Description
InX Float X coordinate of the origin point.
InY Float Y coordinate of the origin point.
InAngle Float Input orientation 〔deg〕.
InScale Float Input scale. Range: (0, +inf).
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutUCS2D UCS2D The UCS2D instance.
Error ErrorState Gets the execution error message

UCS2D - CreateUCS2D_CreateFromPoint

Creates a new UCS2D given origin, angle and scale.

IN

Name Type Description
InOrigin Point2D Input origin.
InAngle Float Input orientation 〔deg〕.
InScale Float Input scale. Range: (0, +inf).
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutUCS2D UCS2D The UCS2D instance.
Error ErrorState Gets the execution error message

UCS2D - CreateUCS2D_CreateFromPoints

Creates a new UCS2D given two points on its axes.

IN

Name Type Description
InPoint1 Point2D First point.
InPoint2 Point2D Second point.
InAngle Float Input orientation 〔deg〕.
InScale Float Relative scale. Range: (0, +inf).
InScaleDivisor Float Scale divisor. Range: (0, +inf).
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutUCS2D UCS2D The UCS2D instance.
Error ErrorState Gets the execution error message

UCS2D - CreateUCS2D_CreateFromRectangle

Creates a new UCS2D from a reference rectangle.

IN

Name Type Description
InRectangle Rectangle2D Input reference rectangle.
InRelativeAngle Float Relative angle 〔deg〕.
InScale Float Input scale. Range: (0, +inf).
InScaleDivisor Float Scale divisor. Range: (0, +inf).
InPointAnchor Enum < Anchor2D > Relative position of the rectangle origin with respect to the coordinate system origin.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutUCS2D UCS2D The UCS2D instance.
Error ErrorState Gets the execution error message

UCS2D - CreateUCS2D_CreateFromSegment

Creates a new UCS2D from a reference segment.

IN

Name Type Description
InSegment Segment2D Reference segment.
InRelativeAngle Float Relative angle 〔deg〕.
InScale Float Coordinate system scale. Range: (0, +inf).
InScaleDivisor Float Scale divisor. Range: (0, +inf).
InPointAnchor Float Relative position of the coordinate system origin between the segment points. Range 〔0, 1〕.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutUCS2D UCS2D The UCS2D instance.
Error ErrorState Gets the execution error message

UCS2D - CreateUCS2D_CreateFromVector

Creates a new UCS2D given a translation vector, angle and scale.

IN

Name Type Description
InDelta Vector2D Shift from (0,0).
InAngle Float Input orientation 〔deg〕.
InScale Float Input scale. Range: (0, +inf).
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutUCS2D UCS2D The UCS2D instance.
Error ErrorState Gets the execution error message

UCS2D - Deserialize

De-serialize a UCS2D 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
OutUCS2D UCS2D Deserialized object.
Error ErrorState Gets the execution error message

UCS2D - Serialize

Serializes the object.

IN

Name Type Description
InUCS2D UCS2D The input UCS2D
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

Segment2D - CreateSegment2D_Create

Creates a new Segment2D object where both points are (0, 0).

IN

Name Type Description
InSegment2D Segment2D The input Segment2D
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutSegment2D Segment2D The Segment2D instance.
Error ErrorState Gets the execution error message

Segment2D - CreateSegment2D_CreateFromAnchorPoint

Creates a new Segment2D given direction, length and a contained point.

IN

Name Type Description
InPoint Point2D Input point.
InDirection Float Segment direction.
InLength Float Segment length. Range: 〔0, +inf).
InPointAnchor Float Position of the point in the segment. If 0, the point is the starting point while, if 1, the point is the end point.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutSegment2D Segment2D The Segment2D instance.
Error ErrorState Gets the execution error message

Segment2D - CreateSegment2D_CreateFromFloats

Creates a new Segment2D using the provided points coordinates.

IN

Name Type Description
InX1 Float X coordinate of the starting point.
InY1 Float Y coordinate of the starting point.
InX2 Float X coordinate of the ending point.
InY2 Float Y coordinate of the ending point.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutSegment2D Segment2D The Segment2D instance.
Error ErrorState Gets the execution error message

Segment2D - CreateSegment2D_CreateFromPoints

Creates a new Segment2D object using the provided points.

IN

Name Type Description
InPoint1 Point2D Starting point.
InPoint2 Point2D Ending point.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutSegment2D Segment2D The Segment2D instance.
Error ErrorState Gets the execution error message

Segment2D - Deserialize

De-serialize a Segment2D 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
OutSegment2D Segment2D Deserialized object.
Error ErrorState Gets the execution error message

Segment2D - GetDirection

Returns the segment direction.

IN

Name Type Description
InSegment2D Segment2D The input Segment2D
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutFloat Float Direction angle in the range 〔0, 360〕 〔deg〕.
Error ErrorState Gets the execution error message

Segment2D - GetSlope

Returns the slope of the segment. If the segment is vertical, returns NaN.

IN

Name Type Description
InSegment2D Segment2D The input Segment2D
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutFloat Float Slope of the segment.
Error ErrorState Gets the execution error message

Segment2D - HasSlope

Returns true if the segment is neither horizontal nor vertical, false otherwise.

IN

Name Type Description
InSegment2D Segment2D The input Segment2D
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 segment is neither horizontal nor vertical, false otherwise.
Error ErrorState Gets the execution error message

Segment2D - IsHorizontal

Returns true if the segment is horizontal, false otherwise.

IN

Name Type Description
InSegment2D Segment2D The input Segment2D
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 segment is horizontal, false otherwise.
Error ErrorState Gets the execution error message

Segment2D - IsVertical

Returns true if the segment is vertical, false otherwise.

IN

Name Type Description
InSegment2D Segment2D The input Segment2D
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 segment is vertical, false otherwise.
Error ErrorState Gets the execution error message

Segment2D - Serialize

Serializes the object.

IN

Name Type Description
InSegment2D Segment2D The input Segment2D
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

Ring2D - CreateRing2D_Create

Creates a new Ring2D with default values.

IN

Name Type Description
InRing2D Ring2D The input Ring2D
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutRing2D Ring2D The Ring2D instance.
Error ErrorState Gets the execution error message

Ring2D - CreateRing2D_CreateFromAnchorPoint

Creates a new Ring2D given a point and its position relative to the ring bounding box.

IN

Name Type Description
InPoint Point2D Input point.
InPointAnchor Enum < Anchor2D > Point anchor.
InInnerRadius Float Internal radius. Range: 〔0, +inf).
InOuterRadius Float External radius. Range: 〔0, +inf).
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutRing2D Ring2D The Ring2D instance.
Error ErrorState Gets the execution error message

Ring2D - CreateRing2D_CreateFromCenter

Creates a new Ring2D given center and radii.

IN

Name Type Description
InCenter Point2D Center point.
InRadius1 Float Inner radius. Range: 〔0, +inf).
InRadius2 Float Outer radius. Range: 〔0, +inf).
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutRing2D Ring2D The Ring2D instance.
Error ErrorState Gets the execution error message

Ring2D - CreateRing2D_CreateFromCircle

Creates a new Ring2D given a circle and border width.

IN

Name Type Description
InCircle Circle2D Input circle.
InRingWidth Float Ring width. Range: 〔0, +inf).
InBorderPosition Enum < BorderPosition > Border position.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutRing2D Ring2D The Ring2D instance.
Error ErrorState Gets the execution error message

Ring2D - CreateRing2D_CreateFromFloats

Creates a new Ring2D given center coordinates and radii.

IN

Name Type Description
InX Float X coordinate of the center point.
InY Float Y coordinate of the center point.
InRadius1 Float Inner radius. Range: 〔0, +inf).
InRadius2 Float Outer radius. Range: 〔0, +inf).
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutRing2D Ring2D The Ring2D instance.
Error ErrorState Gets the execution error message

Ring2D - Deserialize

De-serialize a Ring2D 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
OutRing2D Ring2D Deserialized object.
Error ErrorState Gets the execution error message

Ring2D - Serialize

Serializes the object.

IN

Name Type Description
InRing2D Ring2D The input Ring2D
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

Rectangle2D - CreateRectangle2D_Create

Creates a Rectangle2D with default values.

IN

Name Type Description
InRectangle2D Rectangle2D The input Rectangle2D
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 instance.
Error ErrorState Gets the execution error message

Rectangle2D - CreateRectangle2D_CreateFrom2Points

Creates a new Rectangle2D given its origin, the opposite point and the angle.

IN

Name Type Description
InOrigin Point2D Rectangle's origin.
InPoint Point2D Rectangle's corner opposite to the origin.
InAngle Float Input orientation angle 〔deg〕.
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 instance.
Error ErrorState Gets the execution error message

Rectangle2D - CreateRectangle2D_CreateFromAnchorPoint

Creates a new Rectangle2D using the provided anchor point.

IN

Name Type Description
InPoint Point2D Input point.
InPointAnchor Enum < Anchor2D > Position of input point.
InAngle Float Input orientation angle 〔deg〕.
InWidth Float Input width. Range: 〔0, +inf).
InHeight Float Input 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
OutRectangle2D Rectangle2D The Rectangle2D instance.
Error ErrorState Gets the execution error message

Rectangle2D - CreateRectangle2D_CreateFromFloats

Creates a new Rectangle2D given origin coordinates, angle, width and height.

IN

Name Type Description
InX Float X coordinate of the origin point.
InY Float Y coordinate of the origin point.
InAngle Float Input orientation angle 〔deg〕.
InWidth Float Input width. Range: 〔0, +inf).
InHeight Float Input 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
OutRectangle2D Rectangle2D The Rectangle2D instance.
Error ErrorState Gets the execution error message

Rectangle2D - CreateRectangle2D_CreateFromOrigin

Creates a new Rectangle2D given origin, angle, width and height.

IN

Name Type Description
InOrigin Point2D Input origin.
InAngle Float Input orientation angle 〔deg〕.
InWidth Float Input width. Range: 〔0, +inf).
InHeight Float Input 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
OutRectangle2D Rectangle2D The Rectangle2D instance.
Error ErrorState Gets the execution error message

Rectangle2D - Deserialize

De-serialize a Rectangle2D 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
OutRectangle2D Rectangle2D Deserialized object.
Error ErrorState Gets the execution error message

Rectangle2D - Serialize

Serializes the object.

IN

Name Type Description
InRectangle2D Rectangle2D The input Rectangle2D
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

Point2D - CreatePoint2D_Create

Creates a Point2D in (0,0).

IN

Name Type Description
InPoint2D Point2D The input Point2D
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutPoint2D Point2D The Point2D instance.
Error ErrorState Gets the execution error message

Point2D - CreatePoint2D_CreateFromFloatInt

Creates a new Point2D given a float and an integer.

IN

Name Type Description
InX Float X coordinate.
InY Int Y coordinate.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutPoint2D Point2D The Point2D instance.
Error ErrorState Gets the execution error message

Point2D - CreatePoint2D_CreateFromFloats

Creates a new Point2D given the coordinates.

IN

Name Type Description
InX Float X coordinate.
InY Float Y coordinate.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutPoint2D Point2D The Point2D instance.
Error ErrorState Gets the execution error message

Point2D - CreatePoint2D_CreateFromIntFloat

Creates a new Point2D given an integer and a float.

IN

Name Type Description
InX Int X coordinate.
InY Float Y coordinate.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutPoint2D Point2D The Point2D instance.
Error ErrorState Gets the execution error message

Point2D - CreatePoint2D_CreateFromInts

Creates a new Point2D given the coordinates.

IN

Name Type Description
InX Int X coordinate.
InY Int Y coordinate.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutPoint2D Point2D The Point2D instance.
Error ErrorState Gets the execution error message

Point2D - Deserialize

De-serialize a Point2D 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
OutPoint2D Point2D Deserialized object.
Error ErrorState Gets the execution error message

Point2D - Serialize

Serializes the object.

IN

Name Type Description
InPoint2D Point2D The input Point2D
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

Point2Di - CreatePoint2Di_Create

Creates a new Point2Di object, with (0,0) coordinates.

IN

Name Type Description
InPoint2Di Point2Di The input Point2Di
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutPoint2Di Point2Di The Point2Di instance.
Error ErrorState Gets the execution error message

Point2Di - CreatePoint2Di_CreateFromInts

Creates a new Point2Di object using the provided coordinates.

IN

Name Type Description
InX Int X coordinate.
InY Int Y coordinate.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutPoint2Di Point2Di The Point2Di instance.
Error ErrorState Gets the execution error message

Point2Di - Deserialize

De-serialize a Point2Di 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
OutPoint2Di Point2Di Deserialized object.
Error ErrorState Gets the execution error message

Point2Di - Serialize

Serializes Point2Di object.

IN

Name Type Description
InPoint2Di Point2Di The input Point2Di
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

Line2D - CreateLine2D_Create

Creates a default Line2D.

IN

Name Type Description
InLine2D Line2D The input Line2D
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutLine2D Line2D The Line2D instance.
Error ErrorState Gets the execution error message

Line2D - CreateLine2D_CreateFromFloats

Creates a new Line2D from A, B and C values.

IN

Name Type Description
InA Float Input A coefficient.
InB Float Input B coefficient.
InC Float Input C coefficient.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutLine2D Line2D The Line2D instance.
Error ErrorState Gets the execution error message

Line2D - CreateLine2D_CreateFromPointAndAngle

Creates a new Line2D object passing through a point and having the provided direction.

IN

Name Type Description
InPoint Point2D Reference point.
InAngle Float Line angle inclination 〔deg〕.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutLine2D Line2D The Line2D instance.
Error ErrorState Gets the execution error message

Line2D - CreateLine2D_CreateFromPoints

Creates a new Line2D object passing through two points.

IN

Name Type Description
InPoint1 Point2D First point.
InPoint2 Point2D Second point.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutLine2D Line2D The Line2D instance.
Error ErrorState Gets the execution error message

Line2D - Deserialize

De-serialize a Line2D 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
OutLine2D Line2D Deserialized object.
Error ErrorState Gets the execution error message

Line2D - GetA

Returns the coefficient A of the equation.

IN

Name Type Description
InLine2D Line2D The input Line2D
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutFloat Float A.
Error ErrorState Gets the execution error message

Line2D - GetB

Returns the coefficient B of the equation.

IN

Name Type Description
InLine2D Line2D The input Line2D
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutFloat Float B.
Error ErrorState Gets the execution error message

Line2D - GetC

Returns the coefficient C of the equation.

IN

Name Type Description
InLine2D Line2D The input Line2D
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutFloat Float C.
Error ErrorState Gets the execution error message

Line2D - GetM

Returns the slope of the line.

IN

Name Type Description
InLine2D Line2D The input Line2D
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutFloat Float The slope coefficient if the line is either horizontal or diagonal. The function returns NaN if the line is vertical.
Error ErrorState Gets the execution error message

Line2D - GetQ

Returns the intercept of the line.

IN

Name Type Description
InLine2D Line2D The input Line2D
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutFloat Float The intercept on the y-axis if the line is either horizontal or diagonal. The function returns the x-axis intercept if the line is vertical.
Error ErrorState Gets the execution error message

Line2D - HasSlope

Returns true if the line is neither vertical nor horizontal.

IN

Name Type Description
InLine2D Line2D The input Line2D
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 line is neither vertical nor horizontal, false otherwise.
Error ErrorState Gets the execution error message

Line2D - IsHorizontal

Returns true if the line is horizontal, false otherwise.

IN

Name Type Description
InLine2D Line2D The input Line2D
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 line is horizontal, false otherwise.
Error ErrorState Gets the execution error message

Line2D - IsVertical

Returns true if the line is vertical, false otherwise.

IN

Name Type Description
InLine2D Line2D The input Line2D
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 line is vertical, false otherwise.
Error ErrorState Gets the execution error message

Line2D - Serialize

Serializes the object.

IN

Name Type Description
InLine2D Line2D The input Line2D
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

Line2D - SetA

Sets a new value for the coefficient A in the equation.

IN

Name Type Description
InLine2D Line2D The input Line2D
InA Float New A.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutLine2D Line2D The modified Core.Data.Types.Line2D
Error ErrorState Gets the execution error message

Line2D - SetB

Sets a new value for the coefficient B in the equation.

IN

Name Type Description
InLine2D Line2D The input Line2D
InB Float New B.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutLine2D Line2D The modified Core.Data.Types.Line2D
Error ErrorState Gets the execution error message

Line2D - SetC

Sets a new value for the coefficient C in the equation.

IN

Name Type Description
InLine2D Line2D The input Line2D
InC Float New C.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutLine2D Line2D The modified Core.Data.Types.Line2D
Error ErrorState Gets the execution error message

Line2D - SetCoefficients

Set all the coefficients of the line.

IN

Name Type Description
InLine2D Line2D The input Line2D
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutLine2D Line2D The modified Core.Data.Types.Line2D
Error ErrorState Gets the execution error message

Ellipse2D - CreateEllipse2D_Create

Creates an Ellipse2D with default values.

IN

Name Type Description
InEllipse2D Ellipse2D The input Ellipse2D
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutEllipse2D Ellipse2D The Ellipse2D instance.
Error ErrorState Gets the execution error message

Ellipse2D - CreateEllipse2D_CreateFromCenter

Creates a new Ellipse2D given center, angle, width and height.

IN

Name Type Description
InCenter Point2D Input center.
InAngle Float Input orientation 〔deg〕.
InWidth Float Input width. Range: 〔0, +inf).
InHeight Float Input 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
OutEllipse2D Ellipse2D The Ellipse2D instance.
Error ErrorState Gets the execution error message

Ellipse2D - CreateEllipse2D_CreateFromFloats

Creates a new Ellipse2D given center coordinates, angle, width and height.

IN

Name Type Description
InX Float X coordinate of the center point.
InY Float Y coordinate of the center point.
InAngle Float Input orientation 〔deg〕.
InWidth Float Input width. Range: 〔0, +inf).
InHeight Float Input 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
OutEllipse2D Ellipse2D The Ellipse2D instance.
Error ErrorState Gets the execution error message

Ellipse2D - Deserialize

De-serialize an Ellipse2D 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
OutEllipse2D Ellipse2D Deserialized object.
Error ErrorState Gets the execution error message

Ellipse2D - Serialize

Serializes the object.

IN

Name Type Description
InEllipse2D Ellipse2D The input Ellipse2D
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

Circle2D - CreateCircle2D_Create

Creates a Circle2D with default values.

IN

Name Type Description
InCircle2D Circle2D The input Circle2D
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutCircle2D Circle2D The Circle2D instance.
Error ErrorState Gets the execution error message

Circle2D - CreateCircle2D_CreateFromAnchorPoint

Creates a new Circle2D given the radius and an anchor point.

IN

Name Type Description
InPoint Point2D Input point.
InPointAnchor Enum < Anchor2D > Input point alignment with respect to circle's bounding box.
InRadius Float Input radius. Range: 〔0, +inf).
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutCircle2D Circle2D The Circle2D instance.
Error ErrorState Gets the execution error message

Circle2D - CreateCircle2D_CreateFromCenter

Creates a new Circle2D given center and radius.

IN

Name Type Description
InCenter Point2D Input center.
InRadius Float Input radius. Range: 〔0, +inf).
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutCircle2D Circle2D The Circle2D instance.
Error ErrorState Gets the execution error message

Circle2D - CreateCircle2D_CreateFromCenterAndPoint

Creates a new Circle2D given the center and a point on its circumference.

IN

Name Type Description
InCenter Point2D Circle's center.
InPoint Point2D A point on the object circumference.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutCircle2D Circle2D The Circle2D instance.
Error ErrorState Gets the execution error message

Circle2D - CreateCircle2D_CreateFromFloats

Creates a new Circle2D given center coordinates and radius.

IN

Name Type Description
InX Float X coordinate of the center point.
InY Float Y coordinate of the center point.
InRadius Float Input radius. Range: 〔0, +inf).
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutCircle2D Circle2D The Circle2D instance.
Error ErrorState Gets the execution error message

Circle2D - CreateCircle2D_CreateFromInts

Creates a new Circle2D given center coordinates and radius.

IN

Name Type Description
InX Int X coordinate of the center point.
InY Int Y coordinate of the center point.
InRadius Int Input radius. Range: 〔0, +inf).
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutCircle2D Circle2D The Circle2D instance.
Error ErrorState Gets the execution error message

Circle2D - Deserialize

De-serialize a Circle2D 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
OutCircle2D Circle2D Deserialized object.
Error ErrorState Gets the execution error message

Circle2D - FromDiameter

Creates a new Circle2D given its diameter.

IN

Name Type Description
InDiameter Segment2D Circle's diameter.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutCircle2D Circle2D The computed circle.
Error ErrorState Gets the execution error message

Circle2D - FromDiameterPoints

Creates a new Circle2D given its diameter as two points.

IN

Name Type Description
InPoint1 Point2D First point of the diameter.
InPoint2 Point2D Second point of the diameter.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutCircle2D Circle2D The computed circle.
Error ErrorState Gets the execution error message

Circle2D - Serialize

Serializes the object.

IN

Name Type Description
InCircle2D Circle2D The input Circle2D
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

Box - CreateBox_CreateFromInts

Creates a new box, given the top-left corner, width and height.

IN

Name Type Description
InX Int X coordinate of the top-left corner.
InY Int Y coordinate of the top-right corner.
InWidth Int Width. Range: 〔0, +inf).
InHeight Int 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
OutBox Box The Box instance.
Error ErrorState Gets the execution error message

Box - Deserialize

De-serialize a Box 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
OutBox Box Deserialized object.
Error ErrorState Gets the execution error message

Box - GetArea

Returns the area of the box.

IN

Name Type Description
InBox Box The input Box
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutInt Int Box's area.
Error ErrorState Gets the execution error message

Box - GetCenter

Returns the box's center point.

IN

Name Type Description
InBox Box The input Box
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutPoint2D Point2D Box's center.
Error ErrorState Gets the execution error message

Box - Serialize

Serializes the object.

IN

Name Type Description
InBox Box The input Box
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

Arc2D - CreateArc2D_Create

Creates an Arc2D object with default values.

IN

Name Type Description
InArc2D Arc2D The input Arc2D
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutArc2D Arc2D The Arc2D instance.
Error ErrorState Gets the execution error message

Arc2D - CreateArc2D_CreateFromAnchorPoint

Creates a new Arc2D given radius, angles and anchor points.

IN

Name Type Description
InPoint Point2D Input point.
InPointAnchor Enum < Anchor2D > Input point alignment with respect to arc's bounding box.
InRadius Float Input radius.
InStartAngle Float Input start angle.
InSweepAngle Float Input sweep angle.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutArc2D Arc2D The Arc2D instance.
Error ErrorState Gets the execution error message

Arc2D - CreateArc2D_CreateFromCenter

Creates a new Arc2D given center, radius, startAngle and sweepAngle.

IN

Name Type Description
InCenter Point2D Input center.
InRadius Float Input radius.
InStartAngle Float Input start angle.
InSweepAngle Float Input sweep angle.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutArc2D Arc2D The Arc2D instance.
Error ErrorState Gets the execution error message

Arc2D - CreateArc2D_CreateFromFloats

Creates a new Arc2D given center coordinates, radius, startAngle and sweepAngle.

IN

Name Type Description
InX Float X coordinate of the center point.
InY Float Y coordinate of the center point.
InRadius Float Input radius.
InStartAngle Float Input start angle.
InSweepAngle Float Input sweep angle.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutArc2D Arc2D The Arc2D instance.
Error ErrorState Gets the execution error message

Arc2D - Deserialize

De-serialize an Arc2D 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
OutArc2D Arc2D Deserialized object.
Error ErrorState Gets the execution error message

Arc2D - Serialize

Serializes the object.

IN

Name Type Description
InArc2D Arc2D The input Arc2D
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

AnnotatedPoint2D - CreateAnnotatedPoint2D_CreateFromPoints

Creates a new AnnotatedPoint2D given the coordinates.

IN

Name Type Description
InPoint Point2D X coordinate.
InAnnotation Point2D Y coordinate.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutAnnotatedPoint2D AnnotatedPoint2D The AnnotatedPoint2D instance.
Error ErrorState Gets the execution error message

AnnotatedPoint2D - Deserialize

De-serialize a AnnotatedPoint2D 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
OutAnnotatedPoint2D AnnotatedPoint2D Deserialized object.
Error ErrorState Gets the execution error message

AnnotatedPoint2D - Serialize

Serializes the object.

IN

Name Type Description
InAnnotatedPoint2D AnnotatedPoint2D The input AnnotatedPoint2D
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