Animation Script Requests

arg_int <anvid> <arg_id> <value>

Argument Type Description
<anvid> Anvid viewer ID
<arg_id> integer argument ID
[This numeric identifier specifies the target of the argument assignment performed by this request. If this request is issued in the context of an igp_macro_draw or igp_macro_redraw request, <arg_id> specifies the target register of a macro (the ID range [0-25] specifies the register range [A-Z]); if this request is being issued in the context of an ime_nobj_update request, <arg_id> specifies the target object attribute (the only object attribute assignable as an integer is “color”, as specified by an ID of 0).]
<value> integer argument value
[When assigning an object’s color, the range of accepted values is [0-63].]

KP analog: None

arg_dbl <anvid> <arg_id> <value>

Argument Type Description
<anvid> Anvid viewer ID
<arg_id> integer argument ID
[This numeric identifier specifies the target of the argument assignment performed by this request. If this request is issued in the context of an igp_macro_draw or igp_macro_redraw request, <arg_id> specifies the target register of a macro (the ID range [0-25] specifies the register range [A-Z]); if this request is being issued in the context of an ime_nobj_update request, <arg_id> specifies the target object attribute (the only object attributes assignable as doubles are “x position” and “y position”, as specified by the IDs 2 and 3, respectively).]
<value> double argument value

KP analog: None

arg_str <anvid> <arg_id> <value>

Argument Type Description
<anvid> Anvid viewer ID
<arg_id> integer argument ID
[This numeric identifier specifies the target of the argument assignment performed by this request. If this request is issued in the context of an igp_macro_draw or igp_macro_redraw request, <arg_id> specifies the target register of a macro (the ID range [0-25] specifies the register range [A-Z]); if this request is being issued in the context of an ime_nobj_update request, <arg_id> specifies the target object attribute (the only object attribute assignable as a string is “icon name”, as specified by an ID of 1).]
<value> string argument value

KP analog: None

arg_eol <anvid>

Argument Type Description
<anvid> Anvid viewer ID
[This request terminates a series of arg_<type> requests, where <type> is either int, dbl, or str. Argument assignment requests follow requests that have a variable number of arguments: igp_macro_draw, igp_macro_redraw, and ime_nobj_update.]

KP analog: None

force

Argument Type Description
no arguments

KP analog: op_anim_force()

flow_end

Argument Type Description
no arguments

KP analog: op_anim_flow_end()

igp_bg_fill <anvid> <props> [<pat_name>] [<andid>]

Argument Type Description
<anvid> Anvid viewer ID
<props> keyword list graphical property list
[<pat_name>] string pattern name
[This argument is optional, and should only be included if the <props> argument includes the property flag style_pattern.]
[<andid>] Andid drawing ID of request
[This numeric identifier is assigned to the drawing produced by this request. This argument is optional, and should only be included if the <props> argument includes the property flag retain_on.]

KP analog: op_anim_igp_bg_fill()

igp_circle_draw <anvid> <props> <ctr_x> <ctr_y> <radius> [<andid>]

Argument Type Description
<anvid> Anvid viewer ID
<props> keyword list graphical property list
<ctr_x> integer X coordinate of the circle’s center point
<ctr_y> integer Y coordinate of the circle’s center point
<radius> integer radius of the circle
[<andid>] Andid drawing ID of request
[This numeric identifier is assigned to the drawing produced by this request. This argument is optional, and should only be included if the <props> argument includes the property flag retain_on.]

KP analog: op_anim_igp_circle_draw()

igp_circle_fill <anvid> <props> [<pat_name>] <ctr_x> <ctr_y> <radius> [<andid>]

Argument Type Description
<anvid> Anvid viewer ID
<props> keyword list graphical property list
[<pat_name>] string pattern name
[This argument is optional, and should only be included if the <props> argument includes the property flag style_pattern.]
<ctr_x> integer X coordinate of the circle’s center point
<ctr_y> integer Y coordinate of the circle’s center point
<radius> integer radius of the circle
[<andid>] Andid drawing ID of request
[This numeric identifier is assigned to the drawing produced by this request. This argument is optional, and should only be included if the <props> argument includes the property flag retain_on.]

KP analog: op_anim_igp_circle_fill()

igp_drawing_erase <anvid> <andid> <mode>

Argument Type Description
<anvid> Anvid viewer ID
<andid> integer drawing ID
[<mode> keyword erase mode
[Accepted erase mode keywords are: none, redraw, xor, and xor_reset.]

KP analog: op_anim_igp_drawing_erase()

igp_icon_draw <anvid> <props> <ic_name> <x> <y> [<andid>]

Argument Type Description
<anvid> Anvid viewer ID
<props> keyword list graphical property list
<ic_name> string icon name
<x> integer X coordinate of icon upper-left corner
<y> integer Y coordinate of icon upper-left corner
[<andid>] Andid drawing ID of request
[This numeric identifier is assigned to the drawing produced by this request. This argument is optional, and should only be included if the <props> argument includes the property flag retain_on.]

KP analog: op_anim_igp_icon_draw()

igp_line_draw <anvid> <props> <x1> <y1> <x2> <y2> [<andid>]

Argument Type Description
<anvid> Anvid viewer ID
<props> keyword list graphical property list
<x1> integer X coordinate of line’s first endpoint
<y1> integer Y coordinate of line’s first endpoint
<x2> integer X coordinate of line’s second endpoint
<y2> integer Y coordinate of line’s second endpoint
[<andid>] Andid drawing ID of request
[This numeric identifier is assigned to the drawing produced by this request. This argument is optional, and should only be included if the <props> argument includes the property flag retain_on.]

KP analog: op_anim_igp_line_draw()

igp_macro_draw <anvid> <props> <anmid> [<andid>]

Argument Type Description
<anvid> Anvid viewer ID
<props> keyword list graphical property list
<anmid> Anmid macro ID
[<andid>] Andid drawing ID of request
[This numeric identifier is assigned to the drawing produced by this request. This argument is optional, and should only be included if the <props> argument includes the property flag retain_on.]

This request is followed by a series of one or more argument-setting requests of the types arg_int, arg_dbl, or arg_str; each of these requests specifies a macro register and its new value. The list of argument requests is terminated by a request of the type arg_eol.

KP analog: op_anim_igp_macro_draw()

igp_macro_redraw <anvid> <andid> <mode>

Argument Type Description
<anvid> Anvid viewer ID
<andid> Andid drawing ID of previously drawn macro
<mode> keyword erase mode
[Accepted erase mode keywords are: none, redraw, xor, and xor_reset.]

This request is followed by a series of one or more argument-setting requests of the types arg_int, arg_dbl, or arg_str; each of these requests specifies a macro register and its new value. The list of argument requests is terminated by a request of the type arg_eol.

KP analog: op_anim_igp_macro_redraw()

igp_rect_draw <anvid> <props> <x> <y> <width> <height> [<andid>]

Argument Type Description
<anvid> Anvid viewer ID
<props> keyword list graphical property list
<x> integer X coordinate of rectangle upper-left corner
<y> integer Y coordinate of rectangle upper-left corner
<width> integer width of rectangle
<height> integer height of rectangle
[<andid>] Andid drawing ID of request
[This numeric identifier is assigned to the drawing produced by this request. This argument is optional, and should only be included if the <props> argument includes the property flag retain_on.]

KP analog: op_anim_igp_rect_draw()

igp_rect_fill <anvid> <props> [<pat_name>] <x> <y> <width> <height> [<andid>]

Argument Type Description
<anvid> Anvid viewer ID
<props> keyword list graphical property list
[<pat_name>] string pattern name
[This argument is optional, and should only be included if the <props> argument includes the property flag style_pattern.]
<x> integer X coordinate of rectangle upper-left corner
<y> integer Y coordinate of rectangle upper-left corner
<width> integer width of rectangle
<height> integer height of rectangle
[<andid>] Andid drawing ID of request
[This numeric identifier is assigned to the drawing produced by this request. This argument is optional, and should only be included if the <props> argument includes the property flag retain_on.]

KP analog: op_anim_igp_rect_fill()

igp_text_draw <anvid> <props> <x> <y> <text> [<andid>]

Argument Type Description
<anvid> Anvid viewer ID
<props> keyword list graphical property list
<x> integer X coordinate of text position
<y> integer Y coordinate of text position
<text> string text string to be drawn
[<andid>] Andid drawing ID of request
[This numeric identifier is assigned to the drawing produced by this request. This argument is optional, and should only be included if the <props> argument includes the property flag retain_on.]

KP analog: op_anim_igp_text_draw()

ime_mod_draw <anvid> <anmid> <view_name> <mod_options> <props>

Argument Type Description
<anvid> Anvid viewer ID
<anmid> Anmid model ID
[This numeric identifier must match the ID of a model previously loaded via an ime_nmod_load request.]
<view_name> string model view name
<mod_options> integer model drawing option flags
[This value is a bitwise OR combination of option flags. The value 0 indicates that there are no options selected. The option flags are: display dynamic paths, such as orbits or trajectories (1); display the model at half its normal size (2); configure the displayed model with speed optimizations for same-size substitution of object icons (8).]
<props> keyword list graphical property list

KP analog: op_anim_ime_nmod_draw()
(this KP issues both ime_nmod_load and ime_mod_draw requests)

ime_nmod_load <anmid> <mod_type> <mod_name>

Argument Type Description
<anmid> Anmid model ID
[This numeric identifier is assigned to the model loaded by this request.]
<mod_type> integer model type code
[This numeric code specifies one of the model types available for use in an animation viewer. The values accepted by this argument are not listed in this manual, but instead appear within the description of the op_cvanim program.]
<mod_name> string model name

KP analog: op_anim_ime_nmod_draw()
(this KP issues both ime_nmod_load and ime_mod_draw requests)

ime_nobj_update <anvid> <obj_type> <obj_name>

Argument Type Description
<anvid> Anvid viewer ID
<obj_type> integer object type code
[This numeric code specifies one of the object types in the model diagram displayed by the specified viewer. The values accepted by this argument are not listed in this manual, but instead appear within the description of the op_cvanim program.]
<obj_name> string object name

This request is followed by a series of one or more argument--setting requests of the types arg_int, arg_dbl, or arg_str; each of these requests specifies an object attribute and its new value. The list of argument requests is terminated by a request of the type arg_eol.

KP analog: op_anim_ime_nobj_update()

macro_create <anmid>

Argument Type Description
<anmid> Anmid macro ID
[This numeric identifier is assigned to the macro produced by this request.]

KP analog: op_anim_macro_create()

macro_destroy <anmid>

Argument Type Description
<anmid> Anmid macro ID

KP analog: op_anim_macro_destroy()

mgp_arop <anmid> <opa_regid> <operator> <opb_regid> <res_regid>

Argument Type Description
<anmid> Anmid macro ID
<opa_regid> keyword macro drawing register ID* for operand A
<operator> keyword arithmetic operator code
[Accepted operator keywords are: add, subtract, multiply, and divide.]
<opb_regid> keyword macro drawing register ID* for operand B
<res_regid> keyword macro drawing register ID* for operation result
*[Accepted register ID keywords have the format reg_<L>, and are within the range reg_a through reg_z, inclusive.]

KP analog: op_anim_mgp_arop()

mgp_bg_fill <anmid> <arg_vals> [<props>] [<pat_name>]

Argument Type Description
<anmid> Anmid macro ID
<arg_vals> keyword list argument value source list (2 items)
[<props>] keyword list graphical property list*
[<pat_name>] string pattern name*
[This argument is optional, and should only be included if the <props> argument includes the property flag style_pattern.]

*[The above arguments marked with asterisks are optional, and should only be included if they are specified as having constant value in the <arg_vals> source list.]

KP analog: op_anim_mgp_bg_fill()

mgp_circle_draw <anmid> <arg_vals> [<props>] [<ctr_x>] [<ctr_y>] [<radius>]

Argument Type Description
<anmid> Anmid macro ID
<arg_vals> keyword list argument value source list (4 items)
[<props>] keyword list graphical property list*
[<ctr_x>] integer X coordinate of the circle’s center point*
[<ctr_y>] integer Y coordinate of the circle’s center point*
[<radius>] integer radius of the circle*

*[The above arguments marked with asterisks are optional, and should only be included if they are specified as having constant value in the <arg_vals> source list.]

KP analog: op_anim_mgp_circle_draw()

gp_circle_fill <anmid> <arg_vals> [<props>] [<pat_name>] [<ctr_x>] [<ctr_y>] [<radius>]

Argument Type Description
<anmid> Anmid macro ID
<arg_vals> keyword list argument value source list (5 items)
[<props>] keyword list graphical property list*
[<pat_name>] string pattern name*
[This argument is optional, and should only be included if the <props> argument includes the property flag style_pattern.]
[<ctr_x>] integer X coordinate of the circle’s center point*
[<ctr_y>] integer Y coordinate of the circle’s center point*
[<radius>] integer radius of the circle*

*[The above arguments marked with asterisks are optional, and should only be included if they are specified as having constant value in the <arg_vals> source list.]

KP analog: op_anim_mgp_circle_fill()

mgp_icon_draw <anmid> <arg_vals> [<props>] [<ic_name>] [<x>] [<y>]

Argument Type Description
anmid> Anmid macro ID
<arg_vals> keyword list argument value source list (4 items)
[<props>] keyword list graphical property list*
[<ic_name>] string icon name*
[<x>] integer X coordinate of icon upper-left corner*
[<y>] integer Y coordinate of icon upper-left corner*

*[The above arguments marked with asterisks are optional, and should only be included if they are specified as having constant value in the <arg_vals> source list.]

KP analog: op_anim_mgp_icon_draw()

mgp_line_draw <anmid> <arg_vals> [<props>] [<x1>] [<y1>] [<x2>] [<y2>]

Argument Type Description
<anmid> Anmid macro ID
<arg_vals> keyword list argument value source list (5 items)
[<props>] keyword list graphical property list*
[<x1>] integer X coordinate of line’s first endpoint*
[<y1>] integer Y coordinate of line’s first endpoint*
[<x2>] integer X coordinate of line’s second endpoint*
[<y2>] integer Y coordinate of line’s second endpoint*

*[The above arguments marked with asterisks are optional, and should only be included if they are specified as having constant value in the <arg_vals> source list.]

KP analog: op_anim_mgp_line_draw()

mgp_rect_draw <anmid> <arg_vals> [<props>] [<x>] [<y>] [<width>] [<height>]

Argument Type Description
<anmid> Anmid macro ID
<arg_vals> keyword list argument value source list (5 items)
[<props>] keyword list graphical property list*
[<x>] integer X coordinate of rectangle upper-left corner*
[<y>] integer Y coordinate of rectangle upper-left corner*
[<width>] integer width of rectangle*
[<height>] integer height of rectangle*

*[The above arguments marked with asterisks are optional, and should only be included if they are specified as having constant value in the <arg_vals> source list.]

KP analog: op_anim_mgp_rect_draw()

mgp_rect_fill <anmid> <arg_vals> [<props>] [<pat_name>] [<x>] [<y>] [<width>] [<height>]

Argument Type Description
<anmid> Anmid macro ID
<arg_vals> keyword list argument value source list (6 items)
[<props>] keyword list graphical property list*
[<pat_name>] string pattern name*
[This argument is optional, and should only be included if the <props> argument includes the property flag style_pattern.]
[<x>] integer X coordinate of rectangle upper-left corner*
[<y>] integer Y coordinate of rectangle upper-left corner*
[<width>] integer width of rectangle*
[<height>] integer height of rectangle*

*[The above arguments marked with asterisks are optional, and should only be included if they are specified as having constant value in the <arg_vals> source list.]

KP analog: op_anim_mgp_rect_fill()

mgp_reg_set_int <anmid> <regid> <value>

Argument Type Description
<anmid> Anmid macro ID
<regid> keyword macro drawing register ID
[Accepted register ID keywords have the format reg_<C>, where <C> is a single character, and are within the range reg_a through reg_z, inclusive.]
<value> integer value to be assigned to specified register

KP analog: op_anim_mgp_reg_set()

mgp_reg_set_dbl <anmid> <regid> <value>

Argument Type Description
<anmid> Anmid macro ID
<regid> keyword macro drawing register ID
[Accepted register ID keywords have the format reg_<C>, where <C> is a single character, and are within the range reg_a through reg_z, inclusive.]
<value> double value to be assigned to specified register

KP analog: op_anim_mgp_reg_set()

mgp_reg_set_str <anmid> <regid> <value>

Argument Type Description
<anmid> Anmid macro ID
<regid> keyword macro drawing register ID
[Accepted register ID keywords have the format reg_<C>, where <C> is a single character, and are within the range reg_a through reg_z, inclusive.]
<value> string value to be assigned to specified register

KP analog: op_anim_mgp_reg_set()

mgp_setup_end <anmid>

Argument Type Description
<anmid> Anmid macro ID

KP analog: op_anim_mgp_setup_end()

mgp_text_draw <anmid> <arg_vals> [<props>] [<x>] [<y>] [<text>]

Argument Type Description
<anmid> Anmid macro ID
<arg_vals> keyword list argument value source list (4 items)
[<props>] keyword list graphical property list*
[<x>] integer X coordinate of text position*
[<y>] integer Y coordinate of text position*
[<text>] string text string to be drawn*

*[The above arguments marked with asterisks are optional, and should only be included if they are specified as having constant value in the <arg_vals> source list.]

KP analog: op_anim_mgp_text_draw()

mme_nobj_pos <anmid> <arg_vals> [<obj_type>] [<obj_name>] <x_regid> <y_regid> [<vertex>]

Argument Type Description
<anmid> Anmid macro ID
<arg_vals> keyword list argument value source list (3 items)
[<obj_type>] keyword list object type code*
[This numeric code specifies one of the object types in the model diagram displayed by the specified viewer. The values accepted by this argument are not listed in this manual, but instead appear within the description of the op_cvanim program.]
[<obj_name>] string object name*
<x_regid> keyword drawing register ID for X coordinate of position
<y_regid> keyword drawing register ID for Y coordinate of position
[Accepted register ID keywords have the format reg_<C>, where <C> is a single character, and are within the range reg_a through reg_z, inclusive.]
[<vertex>] keyword object vertex code*
[Accepted vertex keywords are: icon_ctr, icon_n, icon_s, icon_e, icon_w, icon_ne, icon_nw, icon_se, icon_sw, path_src, path_dst, and path_mid.]

*[The above arguments marked with asterisks are optional, and should only be included if they are specified as having constant value in the <arg_vals> source list.]

KP analog: op_anim_mme_nobj_pos()

viewer_close <anvid>

Argument Type Description
<anvid> Anvid viewer ID

KP analog: op_anim_viewer_close()

viewer_open <anvid> <name> <x> <y> <w> <h>

Argument Type Description
<anvid> Anvid viewer ID
<name> string viewer name
<x> integer X coordinate of viewer upper-left corner
<y> integer Y coordinate of viewer upper-left corner
<w> integer width of viewer
<h> integer height of viewer

KP analog: op_anim_viewer_open()

viewer_open_std <anvid> <name> <loc_type>

Argument Type Description
<anvid> Anvid viewer ID
<name> string viewer name
<loc_type> keyword viewer location code
[Accepted location keywords are: custom, full, n_half, s_half, e_half, w_half, nw_qtr, ne_qtr, sw_qtr, and se_qtr.]

KP analog: op_anim_viewer_open_std()

viewer_redraw <anvid>

Argument Type Description
<anvid> Anvid viewer ID

KP analog: op_anim_viewer_redraw()

viewer_scroll <anvid> <x> <y>

Argument Type Description
<anvid> Anvid viewer ID
<x> integer X coordinate of the upper-left corner of specified viewer’s visible region
<y> integer Y coordinate of the upper-left corner of specified viewer’s visible region

KP analog: op_anim_viewer_scroll()

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · 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