API_RegularizedPoly

Structure for regularizing polygon or polyline.

    typedef struct {
        API_Coord       **coords;
        Int32           **pends;
        API_PolyArc     **parcs;
        UInt32          **vertexIDs;
        UInt32          **edgeIDs;
        UInt32          **contourIDs;
        GS::Bool8       needVertexAncestry;
        Int32           **vertexAncestry;
        GS::Bool8       needEdgeAncestry;
        Int32           **edgeAncestry;
        GS::Bool8       needContourAncestry;
        Int32           **contourAncestry;
    } API_RegularizedPoly;

Members

coords: Coordinate array.
pends: Polygon endpoints; see API_Polygon for more information.
parcs: Polygon arcs; see API_PolyArc and API_Polygon for more information.
vertexIDs: Unique identifiers the polygon vertices (unique inside the polygon). Optional.
edgeIDs: Unique identifiers the polygon edges (unique inside the polygon). Optional.
contourIDs: Unique identifiers the polygon contours (unique inside the polygon). Optional.
needVertexAncestry: Set to true if you would like to receive vertex ancestry after regularization. Input only parameter.
vertexAncestry: Array holding the indices of the vertices in the original polygon. Output only parameter. The array is filled only if it was requested with the needVertexAncestry parameter. The index value is 0 in case of new vertices. There is an index for all vertices. The array is indexed from 1.
needEdgeAncestry: Set to true if you would like to receive edge ancestry after regularization. Input only parameter.
edgeAncestry: Array holding the indices of the edges in the original polygon. Output only parameter. The array is filled only if it was requested with the needEdgeAncestry parameter. The index value is 0 in case of new edges. There is an index for all edges. The array is indexed from 1.
needContourAncestry: Set to true if you would like to receive contour ancestry after regularization. Input only parameter.
contourAncestry: Array holding the indices of the contours in the original polygon. Output only parameter. The array is filled only if it was requested with the needContourAncestry parameter. The index value is 0 in case of new contours. There is an index for all contours. The array is indexed from 1.

Remarks

This structure is used to regularize a polygon or a polyline. APIAny_RegularizePolygonID and APIAny_RegularizePolylineID goody functions use this as input and output.

Requirements

Version: API 5.1 or later

Header: APIdefs_Goodies.h

API_RegularizedPoly

Members

Remarks

Requirements

See Also