op_anim_mgp_text_draw()
摘要
向指定宏添加一个绘制文本字符串的图元。
语法
op_anim_mgp_text_draw (anmid, props, x, y, text)
| 参数 | 类型 | 说明 |
|---|---|---|
anmid |
Anmid |
宏 ID [该值是引用某个已打开动画宏的数字标识符,由 KP op_anim_macro_create() 创建。] |
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 坐标,以像素为单位,从查看器窗口的原点(左上角)起测量 |
text |
char* |
文本字符串 |
返回类型
void
无返回值
示例
/** Construct a macro which depicts a field within a packet. **/
mid = op_anim_macro_create ("pk field");
/* Draw a rectangle fixed at (X,Y) which has width(W) = no. bits(B) x 8 */
op_anim_mgp_reg_set (mid, OPC_ANIM_REG_C_INT, 8);
op_anim_mgp_arop (mid, OPC_ANIM_REG_B_INT, OPC_ANIM_AROP_MULTIPLY,
OPC_ANIM_REG_C_INT, OPC_ANIM_REG_W_INT);
op_anim_mgp_rect_draw (mid, OPC_ANIM_COLOR_RED, OPC_ANIM_REG_X_INT,
OPC_ANIM_REG_Y_INT, OPC_ANIM_REG_W_INT, 15);
/* Draw the field name at (L,Y) where L = X + (W / 2) */
op_anim_mgp_reg_set (mid, OPC_ANIM_REG_C_INT, 2);
op_anim_mgp_arop (mid, OPC_ANIM_REG_W_INT, OPC_ANIM_AROP_DIVIDE, OPC_ANIM_REG_C_INT,
OPC_ANIM_REG_H_INT);
op_anim_mgp_arop (mid, OPC_ANIM_REG_X_INT, OPC_ANIM_AROP_ADD, OPC_ANIM_REG_H_INT,
OPC_ANIM_REG_L_INT);
op_anim_mgp_text_draw (mid, OPC_ANIM_ALIGNH_CENTER | OPC_ANIM_ALIGNV_BOTTOM |
OPC_ANIM_FONT_OPEN_10 | OPC_ANIM_COLOR_RED,
OPC_ANIM_REG_L_INT, OPC_ANIM_REG_Y_INT, OPC_ANIM_REG_S_STR);
op_anim_macro_close (mid);
详情
此 KP 的 props、x、y 和 text 参数可以接受宏寄存器 ID 符号常量,如第 8 页表 42“Animation Macro Register Identifier Symbolic Constants—Integer Values“所列的常量。如果为这些参数传入寄存器 ID,则实际值在宏被调用时从指定寄存器中取得。文本绘图受 color、bgcolor(背景颜色)、pixop、font 和 style 图形属性的影响。文本的 color 和 bgcolor 属性可以赋值 64 个索引颜色值中的任意一个(格式为 OPC_ANIM_COLOR_RGB<rgb>)或 25 个命名颜色值之一(默认的 color 和 bgcolor 值为黑色)。文本字符串的背景颜色出现在文本周围的包围矩形中,填充各个字符之间的像素;这可用于使文本条带与彩色背景相匹配。
如果 pixop 图形属性被设置为默认值(OPC_ANIM_PIXOP_SRC)以外的值,绘制在非黑色查看器像素之上的文本部分可能显示为所赋值以外的颜色(注意:如果指定宏将以 retain 属性被调用以便之后擦除,则应使用 pixop 值 OPC_ANIM_PIXOP_XOR)。
文本大小可以使用 font 图形属性设置(值的格式为 OPC_ANIM_FONT_OPEN_<ptsize>,其中 <ptsize> 可以是 10、12、14、18 或 24)。文本的窗口系统字体通过偏好文件(preferences file)中格式为 fn_x_open_<size>pt 的 “open” 字体环境属性设置。文本相对于指定点的水平和垂直对齐可以使用 style 图形属性设置。属性格式为:OPC_ANIM_ALIGNH_<h>,其中 <h> 为 LEFT、CENTER 或 RIGHT;以及 OPC_ANIM_ALIGHV_<v>,其中 <v> 为 TOP、CENTER 或 BOTTOM。默认对齐为水平左对齐(文本左边缘位于该点)和垂直顶部对齐(文本上边缘位于该点)。
用途
提供了一种在宏的上下文中绘制一行文本的机制。文本可以作为完全自定义显示的组成部分,也可以作为某种动态事件或状态的指示器添加到模型图中。文本在动画中可用于显示动态仿真状态(如队列溢出、路由更新、协议状态)、显示统计信息(如队列长度、冲突次数、平均吞吐量或时延),以及为图对象添加标签。
错误
- 程序中止:segmentation violation(由于
text参数的字符串格式错误) - 可恢复错误:Animation macro ID (
<anmid>) is [out-of-range] [unrecognized].(前者由于anmid参数的值无效,后者由于宏已被销毁) - 诊断错误:Invalid property component (
<prop_comp>) for graphical primitive.(由于props参数的字面值不适用或无效) - 诊断错误:Kernel procedure argument (
<arg>) has out-of-range value (<val>).(由于x或y参数的字面值超出 short 的范围)
参考
- 使用 KP op_anim_igp_text_draw() 以立即模式绘制文本
- 使用 KP op_anim_macro_create() 创建空宏
- 使用 KP op_anim_macro_close() 表示宏定义完成
- 使用 KP op_anim_igp_macro_draw() 在查看器中调用宏