VS:PtInPoly
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Description
Function PtInPoly returns TRUE if the point specified point lies within, or on, the referenced polygon or polyline object.
FUNCTION PtInPoly(
pX,pY :REAL;
h :HANDLE) : BOOLEAN;
def vs.PtInPoly(p, h): return BOOLEAN
Parameters
p REAL X-Y coordinate point. h HANDLE Handle to polygon.
Remarks
( _c_ 2021.12.27): This only works on polygons or segments of polylines whose vertex type is corner. Any point on poly segments with other vertex type (bezier, arc, radius, cubic) will return false.
Example
VectorScript
PROCEDURE Example; VAR polyHandle :HANDLE; locusHandle :HANDLE; x, y :REAL; BEGIN CallTool(-204); polyHandle := FSActLayer; CallTool(-221); locusHandle := FSActLayer; GetLocPt(locusHandle, x, y); Message(PtInPoly(x, y, polyHandle)); END; RUN(Example);
Python
Version
Availability: from All Versions