Ets_Shape_Icon_Info_Get()
Note: Requires OPNET Development Kit
Abstract
Obtains the shape properties of an icon.
Syntax
Ets_Shape_Icon_Info_Get (icon_shape_hndl, center_x, center_y, icon_name, color, size, is_transparent)
| Argument | Type | Description |
|---|---|---|
icon_shape_hndl |
EtsT_Shape_Handle |
Handle to the icon shape of interest. |
center_x |
double * |
The x coordinate of the icon’s center. |
center_y |
double * |
The y coordinate of the icon’s center. |
icon_name |
EtsT_Shape_Icon_Name * |
The name of the icon, as given in an icon database. |
color |
EtsT_Color * |
The color of the icon. (See Shape Colors for details.) For icons with a transparency mask, this color is used to fill any non-transparent parts of the image. |
size |
int * |
The size of the displayed icon, in pixels. If size is 0, the icon will be displayed at its original size (that is, not scaled). |
is_transparent |
EstT_Boolean * |
Whether or not icon transparency should be used. |
Return Type
EtsT_Compcode
EtsC_Compcode_Success, or EtsC_Compcode_Failure if the shape handle passed is not for an icon.
Header
ets_api_shapeset.h
Details
See Ets_Shape_Icon_Create() for details about this shape’s arguments.