op_anim_igp_bg_fill()

Abstract

Fills in the specified viewer’s window with a background color or pattern.

Syntax

op_anim_igp_bg_fill (anvid, props, pat_name)
Argument Type Description
anvid Anvid viewer ID
[This value is a numeric identifier which references a viewer. The background fill will be performed 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.]
pat_name char* pattern name
[This string indicates an icon to be used as a pattern for the fill operation.]

Return Type

Andid

drawing ID of filled background

[Retained drawings are issued IDs so they can later be erased (see the 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_RETAIN | 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

Background fills are affected by the color, pixop, retain, and style graphical properties. Note that the color of the background fill is set by the color graphical property, rather than the bgcolor graphical property (bgcolor is used only for the background color of text drawing). The default color is black. If the pixop graphical property is set to a value other than the default (OPC_ANIM_PIXOP_SRC), the background fill may merge in with any graphical figures displayed in the viewer, rather than replacing them (note that the pixop value OPC_ANIM_PIXOP_XOR should be used when the background fill will later be erased). Background fills with the retain graphical property set (OPC_ANIM_RETAIN) will be redrawn whenever the associated viewer window is redrawn.

The pat_name argument is only referenced if the style graphical property flag OPC_ANIM_STYLE_PATTERN is specified. A pattern fill repeatedly tiles the specified icon to fill the whole viewer window. The tiles are aligned to the absolute coordinates of the graphics display device, rather than the viewer, so moving a viewer may change the relative alignment of its pattern background with any other graphical figures displayed in the viewer. You can create icons and add them to an icon database by using the Icon Database Editor. For more information, see “Icon Database Editor“ on page 615.

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.

Purpose

Provides a mechanism to set a particular color as the background for a viewer window (the default background color of newly created viewers is black). This can be useful for special information displays in which a color background can enhance the presentation. Filling the whole viewer window is also an easy way to get the viewer back to a known state before preceding with subsequent animation requests.

Errors

  • Program Abort: segmentation violation (due to a badly formed string for the pat_name argument)
  • Diagnostic Error: Animation viewer ID (<anvid>) is out-of-range. (due to an invalid value for the anvid argument)
  • Diagnostic Error: Invalid property component (<prop_comp>) for graphical primitive. (due to an inapplicable or invalid value for the props argument)

Reference

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · Documentation compiled and provided by Beijing ZNetLink Technology Co., Ltd.

交流群 · QQ Group:OPNET/智网妙算网络仿真交流群(群号 486383494)

原文档 © 2017 Riverbed Technology · 本站为公益翻译,由 AI 辅助完成,请仔细甄别

Original documentation © 2017 Riverbed Technology. Community translation, AI-assisted. Contact: jiazequn@znetlink.com