op_anim_igp_rect_draw()
摘要
在查看器内的指定位置,使用指定的图形属性绘制矩形轮廓。
语法
op_anim_igp_rect_draw (anvid, props, x, y, width, height)
| 参数 | 类型 | 说明 |
|---|---|---|
anvid |
Anvid |
查看器 ID [该值是引用某个查看器的数字标识符。矩形将显示在该查看器的窗口中。] |
props |
int |
图形属性标志 [该值是动画图形属性标志 OPC_ANIM_COLOR_*、OPC_ANIM_PIXOP_*、OPC_ANIM_BGCOLOR_*、OPC_ANIM_STYLE_*、OPC_ANIM_ALIGNH_*、OPC_ANIM_ALIGNV_*、OPC_ANIM_FONT_* 和 OPC_ANIM_RETAIN 按位 OR 组合。更多信息见“Animation“ 第 3 页。] |
x |
int |
矩形左上角的 x 坐标,以像素为单位,从查看器窗口的原点(左上角)起测量 |
y |
int |
矩形左上角的 y 坐标,以像素为单位,从查看器窗口的原点(左上角)起测量 |
width |
int |
矩形的宽度,以像素为单位 |
height |
int |
矩形的高度,以像素为单位 |
返回类型
Andid
矩形的绘图 ID
[保留绘图会被分配 ID,以便之后可以被擦除(参见参考部分)。要使绘图被保留,必须传入图形属性标志 OPC_ANIM_RETAIN。非保留绘图会被分配 ID 常量 OPC_ANIM_ID_NIL。]
示例
/* 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);
详情
矩形绘图受 color、pixop、style 和 retain 图形属性的影响。矩形的 color 图形属性可以赋值 64 个索引颜色值中的任意一个(格式为 OPC_ANIM_COLOR_RGB<rgb>)或 25 个命名颜色值之一(默认颜色为黑色)。如果 pixop 图形属性被设置为默认值(OPC_ANIM_PIXOP_SRC)以外的值,绘制在非黑色查看器像素之上的矩形部分可能显示为所分配颜色以外的颜色(注意:当矩形绘图之后将被擦除时,应使用 pixop 值 OPC_ANIM_PIXOP_XOR)。矩形的 style 图形属性可取三个值之一:实线矩形线由符号常量 OPC_ANIM_STYLE_SOLID(默认)指定,虚线矩形线由 OPC_ANIM_STYLE_DASHES 指定,点线矩形线由 OPC_ANIM_STYLE_DOTS 指定。设置了 retain 图形属性(OPC_ANIM_RETAIN)的矩形绘图,将在关联的查看器窗口每次重绘时重新绘制;默认情况下,它们会直接消失。
如果 retain 图形属性未启用,或者由于缺少自定义动画探针、或存在当前未激活的自定义动画探针而导致 KP 执行被禁用,此 KP 将返回由符号常量 OPC_ANIM_ID_NIL 标识的特殊值。
除参考部分列出的查看器 ID 来源之外,符号常量 OPC_ANIM_ANVID_PBSPEC 也可用作替代查看器 ID,表示应从处于激活状态的无标签自定义动画探针获取真实的查看器 ID。
用途
提供了一种在动画中绘制矩形的机制。矩形可以作为完全自定义显示的组成部分,也可以作为某种动态事件或状态的指示器添加到模型图中。未填充的矩形适合划分动画图中的区域、替代表示节点、模块、状态等模型对象,或描绘协议层、数据包字段等抽象概念。
错误
- 诊断错误:Animation viewer ID (
<anvid>) is out-of-range.(由于anvid参数的值无效) - 诊断错误:Invalid property component (
<prop_comp>) for graphical primitive.(由于props参数的值不适用或无效) - 诊断错误:Kernel procedure argument (
<arg_name>) has out-of-range value (<value>).(由于x、y、width或height参数的值超出 short integer 的范围)
参考
- 使用 KP op_anim_igp_rect_fill() 以纯色或源自图标的图案填充矩形
- 使用 KP op_anim_mgp_rect_draw() 在宏的上下文中绘制矩形
- 使用 KP op_anim_igp_drawing_erase() 擦除并释放由本 KP 创建的保留矩形
- 使用 KP op_anim_viewer_open() 或 op_anim_viewer_open_std() 获取新创建动画查看器的 ID(或与此前已打开的查看器会合),或使用 KP op_anim_lprobe_anvid() 获取由带标签的自定义动画探针打开的查看器的 ID