Ets_Shape_Region_Create()
Note: Requires OPNET Development Kit
Abstract
Creates a new region shape.
Syntax
Ets_Shape_Region_Create (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 |
|---|---|---|
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_Shape_Handle
A handle to the new shape.
Header
ets_api_shapeset.h
Details
A region is a set of closed filled areas with borders. The areas are defined by a set of bounding line sections, as given in the section list. Each element of that list defines a single segment using the EtsT_Shape_Line_Section data type, as described in Shape Data Types.
The fill pattern can be either an icon name (in;which case the shape is filled with tiled copies of the icon), EtsC_Shape_Brush_None (transparent fill), or EtsC_Shape_Brush_Solid (solid fill using the foreground color). If an icon is specified, its non-transparent areas are displayed using the foreground color and transparent areas use the background color.