Ets_Shape_Polygon_Info_Get()
Note: Requires OPNET Development Kit
Abstract
Obtains the shape properties of a polygon.
Syntax
Ets_Shape_Polygon_Info_Get (polygon_shape_hndl, line_width, line_style, line_color, smooth, section_lptr)
| Argument | Type | Description |
|---|---|---|
polygon_shape_hndl |
EtsT_Shape_Handle |
Handle to the polygon shape of interest. |
line_width |
int * |
The width of the lines, in pixels. |
line_style |
EtsT_Shape_Line_Style * |
The style of the lines, either EtsC_Shape_Line_Solid or EtsC_Shape_Line_None (invisible). |
line_color |
EtsT_Color * |
The color of the lines. See Shape Colors for details. |
smooth |
EtsT_Boolean * |
Specifies whether or not the line segment joints should be smoothed. |
section_lptr |
PrgT_List ** |
Pointer to a list of line segments that make up the polygon. |
Return Type
EtsT_Compcode
EtsC_Compcode_Success, or EtsC_Compcode_Failure if the shape handle passed is not for a polygon.
Header
ets_api_shapeset.h
Details
See Ets_Shape_Polygon_Create() for details about this shape's arguments.
The elements of section_lptr are pointers to line segments of type EtsT_Shape_Line_Section. You must deallocate this list after use.