op_anim_igp_line_draw()
摘要
在查看器内的两个指定点之间,使用指定的图形属性绘制一条线段。
语法
op_anim_igp_line_draw (anvid, props, x1, y1, x2, y2)
| 参数 | 类型 | 说明 |
|---|---|---|
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 页。] |
x1 |
int |
线段第一个端点的 x 坐标¹ |
y1 |
int |
线段第一个端点的 y 坐标¹ |
x2 |
int |
线段第二个端点的 x 坐标¹ |
y2 |
int |
线段第二个端点的 y 坐标¹ |
注 1:以像素为单位,从查看器窗口的原点(左上角)起测量
返回类型
Andid
线段的绘图 ID
[保留绘图会被分配 ID,以便之后可以被擦除(参见参考部分)。要使绘图被保留,必须传入图形属性标志 OPC_ANIM_RETAIN。非保留绘图会被分配 ID 常量 OPC_ANIM_ID_NIL。]
示例
/** Draw a symbol that represents queue saturation. **/
/** (symbol is a square containing an X) **/
sym_props = OPC_ANIM_COLOR_BLUE | OPC_ANIM_RETAIN;
/* Draw square. */
op_anim_igp_line_draw (vid, sym_props, xpos - 20, ypos - 20, xpos + 20,
ypos - 20);
op_anim_igp_line_draw (vid, sym_props, xpos - 20, ypos + 20, xpos + 20,
ypos + 20);
op_anim_igp_line_draw (vid, sym_props, xpos - 20, ypos - 20, xpos - 20,
ypos + 20);
op_anim_igp_line_draw (vid, sym_props, xpos + 20, ypos - 20, xpos + 20,
ypos + 20);
/* Draw X. */
op_anim_igp_line_draw (vid, sym_props, xpos - 20, ypos - 20, xpos + 20,
ypos + 20);
op_anim_igp_line_draw (vid, sym_props, xpos - 20, ypos + 20, xpos + 20,
ypos - 20);
/* Make sure the requests are displayed together on screen. */
op_anim_force ();
详情
线段绘图受 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 应从处于激活状态的无标签自定义动画探针获取。
用途
提供了一种在动画中绘制线段的机制。线段可以作为完全自定义显示的组成部分,也可以作为某种动态事件或状态的指示器添加到模型图中。线段绘图适合描绘模型图组件之间的动态连接:例如远程中断、数据包投递、无线电传输和已建立的电路。不过,这些应用最好通过在宏内绘制线段来完成,可使用内核过程 op_anim_mgp_line_draw(),因为在宏中可以通过内核过程 op_anim_mme_nobj_pos() 直接获取模型对象的位置。状态转移图或点对点传输日志等与模型无关的动画也可以利用 Igp 线段。
错误
- 诊断错误: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>).(由于x1、y1、x2或y2参数的值超出 short integer 的范围)
参考
- 使用内核过程 op_anim_igp_rect_draw() 绘制正方形或矩形
- 使用内核过程 op_anim_mgp_line_draw() 在宏的上下文中绘制线段
- 使用内核过程 op_anim_igp_drawing_erase() 擦除并释放由本内核过程创建的保留线段
- 使用内核过程 op_anim_viewer_open() 或 op_anim_viewer_open_std() 获取新创建动画查看器的 ID(或与此前已打开的查看器会合),或使用内核过程 op_anim_lprobe_anvid() 获取由带标签的自定义动画探针打开的查看器的 ID