Parameters
| Name | Explanation |
|---|---|
| x | The array that holds the retrieved points x-coordinate values * |
| y | The array that holds the retrieved points y-coordinate values * |
| Points | The number of points defining the polygonal area on the image. |
| * The arguments are returned in the first elements of the x arrays and y arrays. | |
Return Value
Returns True (nonzero) if successful. Returns False (0) if unsuccessful.
Explanation
The GetArrayPointsXY method retrieves the coordinate values for each of the points used to define the selection area drawn using the Select or the FreeSelect tools in the image-editing toolbar. This method is recommended for scripting and other languages that require variant types.
In the image editing toolbar, the Select tool and the FreeSelect tool can be used to select an area on an image. This selected area is defined by a set of points. In the case of the Select tool, a rectangular selection area is drawn so only 4 points are needed to define that area. In the case of the FreeSelect tool, however, the selection area can be defined by a large number of points. The GetArrayPointsNum method can be used to retrieve the number of points that define the selection area. The GetArrayPointsXY method can be used to retrieve each of the point's X,Y coordinates. The values are in pixels.
Also see the GetArrayPointsXY method.