geIsPointInsidePolygon

geIsPointInsidePolygon(
d_ cellViewId
l_point
l_pointsArray 
g_edges
) 
=> t / nil

Description

Checks if the specified point is inside a polygon.

Arguments

d_cellViewId	Database ID of the cellview containing the polygon.
l_point	Coordinates of the input point to be checked.
l_pointsArray	Coordinates of the polygon as an array of points.
g_edges	A Boolean value specifying whether the points on the edges of the polygon should be considered. The default value is t. Valid Values: t or nil

Value Returned

t	Returned if the polygon array of points l_ pointsArray contains the given point l_point.
nil	Returned if the polygon array of points does not contain the given point.

Example

Checks if the polygon described by the coordinates 1:1 1:4 3:6 5:4 5:1 in the current cellview contains the point 3:6. Because the points on the edges of the polygon are not considered, the function returns nil.

cv=geGetEditCellview() 

geIsPointInsidePolygon(cv 3:6 list(1:1 1:4 3:6 5:4 5:1) nil) 

-> nil

Related Topics

leIsPointInsideFig

Return to top