IN_V1_POLYGON_* structures

image\bltlrgsq_shg.gif Editions  image\bltlrgsq_shg.gif Example

You can define, place, and retrieve descriptions of polygons, boxes, and box-shaped highlight areas by using the IN_PlaceVectorObject and IN_GetVectorObjectDescription functions, and the following structures:

image\bltlrgsq_shg.gif IN_V1_POLYGON_OBJECT

image\bltlrgsq_shg.gif IN_OBJECT_HEADER

image\bltlrgsq_shg.gif IN_V1_POLYGON_PARMS

IN_OBJECT_HEADER

Syntax

typedef struct tagApiObjectHeader {

IN_OBJECT_TYPE objectType;

USHORT version;

USHORT size;

USHORT flags;

ULONG objectID;

ULONG parentID;

} IN_OBJECT_HEADER, FAR *IN_OBJECT_HEADER_PTR;

Parameters

Values

Meaning

objectType

IN_OBJTYPE_POLYGON (5)

polygon

 

IN_OBJTYPE_BOX (9)

box

 

IN_OBJTYPE_HIGHLIGHT_BOX (10)

box-shaped highlight area

version

1

version number

size

sizeof(IN_V1_POLYGON_OBJECT) + (sizeof(IN_POINT) * (points - 1) )

size of the data structure. The structure allocates 1 point, so the total is (points - 1).

flags

IN_OBJFLAG_* values

 

objectID

identifier of the vector object

parentID

identifier of the group of objects that the vector object belongs to. Use 0 if the object is not part of a group.

IN_V1_POLYGON_PARMS

Syntax

typedef struct tagApiPolygonParmsV1 {

IN_MEASUREMENT thickness;

IN_RGB lineColor;

IN_RGB fillColor;

IN_LINESTYLE lineStyle;

IN_FILLSTYLE fillStyle;

IN_JOINSTYLE joinStyle;

IN_POLYFILLMODE polyFillMode;

IN_CURVESTYLE curveStyle;

} IN_V1_POLYGON_PARMS, FAR *IN_V1_POLYGON_PARMS_PTR;

Parameters

Values

Meaning

thickness

Measurement structure

thickness of the object's lines

lineColor

RGB color

line color. Use background (0,0,0) for erased areas.

fillColor

RGB color

fill color. Use background (0,0,0) for erased areas.

lineStyle

IN_LINESTYLE_* values

line style (solid, dashed, dotted...)

fillStyle

IN_FILL_* values

For examples, click Fill styles

joinStyle

IN_JOIN_* values

style of corners

polyFillMode

IN_POLYFILL_WINDING

fill each poly-polygon

curveStyle

IN_CURVE_NONE

connects points with straight lines. Example

 

IN_CURVE_BSPLINE

connects points with arcs. Example

IN_V1_POLYGON_OBJECT

Syntax

typedef struct tagApiPolygonObjectV1 {

IN_OBJECT_HEADER header;

IN_V1_POLYGON_PARMS parms;

USHORT pointCount;

IN_POINT points[1];

} IN_V1_POLYGON_OBJECT, FAR *IN_V1_POLYGON_OBJECT_PTR;

Parameters

Values

Meaning

header

IN_OBJECT_HEADER

object header structure

parms

IN_V1_POLYGON_PARMS

parameters of the object

pointCount

number of points in the object. For example, a box would have 4 points.

points[1]

floating point, x, y values

each x, y coordinate in the object, in inches. See Remarks.

Remarks

The points[] array is dynamically allocated based on the number of points in the object