Ets_Shape_Region_Info_Get()
Note: Requires OPNET Development Kit
Abstract
Obtains the shape properties of a region.
Syntax
Ets_Shape_Region_Info_Get (region_shape_hndl, edge_line_width, edge_line_style, edge_line_color, fill_pattern, fill_fore_color, fill_back_color, center_x, center_y, section_lptr)
| Argument | Type | Description |
|---|---|---|
region_shape_hndl |
EtsT_Shape_Handle |
Handle to the region shape of interest. |
edge_line_width |
int * |
The width of border lines, in pixels. |
edge_line_style |
EtsT_Shape_Line_Style * |
The style of border lines, either EtsC_Shape_Line_Solid or EtsC_Shape_Line_None (invisible). |
edge_line_color |
EtsT_Color * |
The color of border lines. See Shape Colors for details. |
fill_pattern |
EtsT_Shape_Brush_Name * |
Pattern for filling the region (described in Details section). |
fill_fore_color |
EtsT_Color * |
Foreground color for fill patterns. Transparent if set to EtsC_Shape_Color_None. See Shape Colors for details. |
fill_back_color |
EtsT_Color * |
Background color for fill patterns. Transparent if set to EtsC_Shape_Color_None. See Shape Colors for details. |
center_x |
double * |
Not used. (optional) |
center_y |
double * |
Not used. (optional) |
section_lptr |
PrgT_List ** |
Pointer to a list of line segments that define the region. |
Return Type
EtsT_Compcode
EtsC_Compcode_Success, or EtsC_Compcode_Failure if the shape handle passed is not for a region.
Header
ets_api_shapeset.h
Details
See Ets_Shape_Region_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.