NAME

DoSimplePolygon − Create a simple polygon primitive object

SYNOPSIS

C:

DtObject DoSimplePolygon(colormodel, vertextype, vertexcount, vertices, shape)
DtColorModel colormodel;
DtVertexType vertextype;
DtInt vertexcount;
DtReal vertices[];
DtShapeType shape;

Fortran:

INTEGER∗4 DOSPGN(COLMOD, VTXTYP, VTXCNT, VTXS, SHAPE)
INTEGER∗4 COLMOD
INTEGER∗4 VTXTYP
INTEGER∗4 VTXCNT
REAL∗8 VTXS(∗)
INTEGER∗4 SHAPE

DESCRIPTION

DoSimplePolygon creates a primitive object that defines a simple polygon.  A simple polygon is a planar collection of vertices, forming a single connected contour.  The contour may be either convex or concave and may contain any number of vertices.  The boundaries of the contour may self-intersect. 

The parameter colormodel specifies the color model used if the vertices contain color information for shading purposes.  The parameter vertextype specifies the exact nature of the vertices.  See the appendix on vertex types for more information on this parameter.  The parameter vertices is an array of vertex data.  The parameter vertexcount specifies the number of vertices in the simple polygon.  The parameter vertices is an array containing the vertices in order. 

The last vertex is automatically connected to the first. 

The parameter shape hints at the geometry of the simple polygon.  Correctly specifying the shape of the contour will result in optimal decomposition when necessary.  Incorrectly specifying the shape may result in an incorrect or aborted decomposition.  The possible values for shape are:

DcConvex <DCCNVX>
Path is wholly convex.

DcConcave <DCCNCV>
Path may be concave but not self-intersecting.

DcComplex <DCCPLX>
Path may be self-intersecting.

Geometric normals to the polygons in the mesh are calculated using the right-hand rule (the fingers of the right hand point in the order of vertices and the thumb points in the direction of the normal).  These normals are used to determine the way that the polygons face for backface culling and the shading when the polygons are faceted (no vertex normals provided and smoothflag off) or facet shading has been specified. 

ERRORS

DoSimplePolygon must be called with a valid specification for shape. 

[WARNING - invalid parameter]

DoSimplePolygon must be called with at least three vertices. 

[WARNING - insufficient information]

SEE ALSO

DoPolygon(3D), DoPolygonMesh(3D), DoSimplePolygonMesh(3D), VertexTypes(3D)

September 29, 2021