Skip to content

PolygonRelations

Path - Contains_Path

Checks if the provided path is contained inside the calling object. Note: It returns a correct result only if the path is actually a polygon (close and without self-intersections).

IN

Name Type Description
InPath Path The input Path
InSubPolygon Path Input polygon.
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 input polygon is fully contained in the calling object, false otherwise.
Error ErrorState Gets the execution error message

Path - Contains_Point

Checks if a point is contained inside the polygon. Note: It returns a correct result only if the path is actually a polygon (close and without self-intersections).

IN

Name Type Description
InPath Path The input Path
InPoint Point2D Input point.
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 point is contained in the polygon, false otherwise.
Error ErrorState Gets the execution error message

Path - Contains_Points

For each point in the array, checks if it is contained in the polygon. Note: It returns a correct result only if the path is actually a polygon (close and without self-intersections).

IN

Name Type Description
InPath Path The input Path
InPoints Point2DArray Array of input points.
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 every point of the array is contained in the polygon, false otherwise.
Error ErrorState Gets the execution error message

Path - IsConvex

Checks if the polygon is convex. Note: It returns a correct result only if the path is actually a polygon (close and without self-intersections).

IN

Name Type Description
InPath Path The input Path
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 polygon is convex, false otherwise.
Error ErrorState Gets the execution error message