op_anim_igp_rect_draw()
Abstract
Draws a rectangle outline at the specified position within a viewer, using the specified graphical properties.
Syntax
op_anim_igp_rect_draw (anvid, props, x, y, width, height)
| Argument | Type | Description |
|---|---|---|
anvid |
Anvid |
viewer ID [This value is a numeric identifier which references a viewer. The rectangle will be displayed in the viewer’s window.] |
props |
int |
graphical property flags [This value is the bitwise OR combination of the Animation Graphical Properties flags OPC_ANIM_COLOR_*, OPC_ANIM_PIXOP_*, OPC_ANIM_BGCOLOR_*, OPC_ANIM_STYLE_*, OPC_ANIM_ALIGNH_*, OPC_ANIM_ALIGNV_*, OPC_ANIM_FONT_*, and OPC_ANIM_RETAIN. For more information, see “Animation“ on page 3.] |
x |
int |
x coordinate of rectangle upper-left corner, measured in pixels from the origin of the viewer window (upper-left corner). |
y |
int |
y coordinate of rectangle upper-left corner, measured in pixels from the origin of the viewer window (upper-left corner). |
width |
int |
width of rectangle, in pixels |
height |
int |
height of rectangle, in pixels |
Return Type
Andid
drawing ID of rectangle
[Retained drawings are issued IDs so they can later be erased (see Reference section). For a drawing to be retained, the graphical property flag OPC_ANIM_RETAIN must be passed. Non-retained drawings are issued the ID constant OPC_ANIM_ID_NIL.]
Example
/* Open a full-size animation viewer. */
vid = op_anim_viewer_open_std ("Example Viewer", OPC_ANIM_LOCATION_FULL);
/* Fill in the window with a background color. */
op_anim_igp_bg_fill (vid, OPC_ANIM_COLOR_STEEL, " ");
/** Divide the viewer into rectangular regions. **/
/* Draw left box. */
xmin = 10, ymin = 10;
wid = hgt = 400;
op_anim_igp_rect_draw (vid, OPC_ANIM_RETAIN | OPC_ANIM_COLOR_RED,
xmin, ymin, wid, hgt);
/* Draw right box. */
xmin = xmin + wid + 10;
op_anim_igp_rect_draw (vid, OPC_ANIM_RETAIN | OPC_ANIM_COLOR_RED,
xmin, ymin, wid, hgt);
Details
Rectangle drawings are affected by the color, pixop, style, and retain graphical properties. The color graphical property of the rectangle can be assigned any of the 64 indexed color values (with the format OPC_ANIM_COLOR_RGB<rgb>) or the 25 named color values (the default color is black). If the pixop graphical property is set to a value other than the default (OPC_ANIM_PIXOP_SRC), portions of the rectangle which are drawn over non-black viewer pixels may be displayed in a color other than that assigned (note that the pixop value OPC_ANIM_PIXOP_XOR should be used when the rectangle drawing will later be erased). The style graphical property of a rectangle can take on one of three values: solid rectangle lines can be specified by the symbolic constant OPC_ANIM_STYLE_SOLID (the default), dashed rectangle lines by OPC_ANIM_STYLE_DASHES, and dotted rectangle lines by OPC_ANIM_STYLE_DOTS. Rectangle drawings with the retain graphical property set (OPC_ANIM_RETAIN) will be redrawn whenever the associated viewer window is redrawn; by default, they will simply disappear.
The special value identified by the symbolic constant OPC_ANIM_ID_NIL is returned by this KP if the retain graphical property is not enabled, or if KP execution is disabled due to the lack of a custom animation probe, or the presence of a custom animation probe which is not currently active.
In addition to the sources of viewer IDs listed in the Reference section, the symbolic constant OPC_ANIM_ANVID_PBSPEC can be used as a substitute viewer ID, indicating that the real viewer ID should be obtained from an active unlabeled custom animation probe.
Purpose
Provides a mechanism to draw a rectangle as part of an animation. The rectangle can serve as a component in a completely customized display, or it can be added to a model diagram as an indicator of some dynamic event or status. Unfilled rectangles are useful for delimiting regions within an animated diagram, for alternatively representing model objects such as nodes, modules, and states, or for diagramming abstractions such as protocol layers or packet fields.
Errors
- Diagnostic Error: Animation viewer ID (
<anvid>) is out-of-range. (due to an invalid value for theanvidargument) - Diagnostic Error: Invalid property component (
<prop_comp>) for graphical primitive. (due to an inapplicable or invalid value for thepropsargument) - Diagnostic Error: Kernel procedure argument (
<arg_name>) has out-of-range value (<value>). (due to a value for the argumentsx,y,width, orheightthat exceeds the range of a short integer)
Reference
- Use the KP op_anim_igp_rect_fill() to fill a rectangle with a solid color or icon-derived pattern
- Use the KP op_anim_mgp_rect_draw() to draw a rectangle within the context of a macro
- Use the KP op_anim_igp_drawing_erase() to erase & deallocate a retained rectangle created by this KP
- Use the KPs op_anim_viewer_open() or op_anim_viewer_open_std() to obtain the ID of a newly created animation viewer (or rendezvous with a previously opened viewer), or the KP op_anim_lprobe_anvid() to obtain the ID of a viewer opened by a labeled custom animation probe