Animation
Table 24: Animation Graphical Property Symbolic Constants—Text Alignment
| Constant | Description |
|---|---|
OPC_ANIM_ALIGNH_CENTER |
align horizontal center to text position |
OPC_ANIM_ALIGNH_LEFT |
align horizontal left edge to text position |
OPC_ANIM_ALIGNH_RIGHT |
align horizontal right edge to text position |
OPC_ANIM_ALIGNV_BOTTOM |
align vertical bottom edge to text position |
OPC_ANIM_ALIGNV_CENTER |
align vertical center to text position |
OPC_ANIM_ALIGNV_TOP |
align vertical top edge to text position |
Table 25: Animation Graphical Property Symbolic Constants—Background Colors
These constants define sixty-four background colors, from black to white, using the format:
OPC_ANIM_BGCOLOR_RGB<r><g><b>
where <r>, <g>, and <b> are numerals from 0-3, inclusive. For example:
| Constant | Description |
|---|---|
OPC_ANIM_BGCOLOR_RGB000 |
black (0th value) |
OPC_ANIM_BGCOLOR_RGB333 |
white (63rd value) |
These constants also include the following named background colors (which are duplicates of some of the RGB colors):
| Constant | Constant |
|---|---|
OPC_ANIM_BGCOLOR_BEIGE |
OPC_ANIM_BGCOLOR_BLACK |
OPC_ANIM_BGCOLOR_BLUE |
OPC_ANIM_BGCOLOR_BRICK |
OPC_ANIM_BGCOLOR_BROWN |
OPC_ANIM_BGCOLOR_CORN |
OPC_ANIM_BGCOLOR_CYAN |
OPC_ANIM_BGCOLOR_FUCHSIA |
OPC_ANIM_BGCOLOR_GREEN |
OPC_ANIM_BGCOLOR_MAGENTA |
OPC_ANIM_BGCOLOR_MAROON |
OPC_ANIM_BGCOLOR_OLIVE |
OPC_ANIM_BGCOLOR_ORANGE |
OPC_ANIM_BGCOLOR_ORCHID |
OPC_ANIM_BGCOLOR_PEACH |
OPC_ANIM_BGCOLOR_PINK |
OPC_ANIM_BGCOLOR_PLUM |
OPC_ANIM_BGCOLOR_PURPLE |
OPC_ANIM_BGCOLOR_RED |
OPC_ANIM_BGCOLOR_SIENNA |
OPC_ANIM_BGCOLOR_STEEL |
OPC_ANIM_BGCOLOR_TAN |
OPC_ANIM_BGCOLOR_VIOLET |
OPC_ANIM_BGCOLOR_WHITE |
OPC_ANIM_BGCOLOR_YELLOW |
Table 26: Animation Graphical Property Symbolic Constants—Colors
These constants define sixty-four colors, from black to white, using the format:
OPC_ANIM_COLOR_RGB<r><g><b>
where <r>, <g>, and <b> are numerals from 0-3, inclusive. For example:
| Constant | Description |
|---|---|
OPC_ANIM_COLOR_RGB000 |
black (0th value) |
OPC_ANIM_COLOR_RGB333 |
white (63rd value) |
These constants also include the following named colors (which are duplicates of some of the RGB colors):
| Constant | Constant |
|---|---|
OPC_ANIM_COLOR_BEIGE |
OPC_ANIM_COLOR_BLACK |
OPC_ANIM_COLOR_BLUE |
OPC_ANIM_COLOR_BRICK |
OPC_ANIM_COLOR_BROWN |
OPC_ANIM_COLOR_CORN |
OPC_ANIM_COLOR_CYAN |
OPC_ANIM_COLOR_FUCHSIA |
OPC_ANIM_COLOR_GREEN |
OPC_ANIM_COLOR_MAGENTA |
OPC_ANIM_COLOR_MAROON |
OPC_ANIM_COLOR_OLIVE |
OPC_ANIM_COLOR_ORANGE |
OPC_ANIM_COLOR_ORCHID |
OPC_ANIM_COLOR_PEACH |
OPC_ANIM_COLOR_PINK |
OPC_ANIM_COLOR_PLUM |
OPC_ANIM_COLOR_PURPLE |
OPC_ANIM_COLOR_RED |
OPC_ANIM_COLOR_SIENNA |
OPC_ANIM_COLOR_STEEL |
OPC_ANIM_COLOR_TAN |
OPC_ANIM_COLOR_VIOLET |
OPC_ANIM_COLOR_WHITE |
OPC_ANIM_COLOR_YELLOW |
Table 27: Animation Graphical Property Symbolic Constants—Text Fonts
| Constant | Description |
|---|---|
OPC_ANIM_FONT_OPEN_10 |
10-point size of the open font |
OPC_ANIM_FONT_OPEN_12 |
12-point size of the open font |
OPC_ANIM_FONT_OPEN_14 |
14-point size of the open font |
OPC_ANIM_FONT_OPEN_18 |
18-point size of the open font |
OPC_ANIM_FONT_OPEN_24 |
24-point size of the open font |
Table 28: Animation Graphical Property Symbolic Constants—Pixel Operators
| Constant | Description¹ |
|---|---|
OPC_ANIM_PIXOP_OR |
<dst> = <src> OR <dst> |
OPC_ANIM_PIXOP_SRC |
<dst> = <src> |
OPC_ANIM_PIXOP_XOR |
<dst> = <src> XOR <dst> |
OPC_ANIM_PIXOP_ZERO |
<dst> = 0 |
Note 1: In the following descriptions, <dst> represents a bit within a destination pixel (i.e., current window contents), and <src> represents a bit within a source pixel (i.e., graphical element being drawn). The pixel operator determines the final value of the destination pixel bits via one of the sixteen Boolean logic equations.
Table 29: Animation Graphical Property Symbolic Constants—Drawing Retention
| Constant | Description |
|---|---|
OPC_ANIM_RETAIN |
retain drawing |
Table 30: Animation Graphical Property Symbolic Constants—Macro Section Execution
| Constant | Description |
|---|---|
OPC_ANIM_SETUP |
specifies that macro execution is limited to setup section |
Table 31: Animation Graphical Property Symbolic Constants—Drawing/Filling Styles
| Constant | Description |
|---|---|
OPC_ANIM_STYLE_DASHES |
dashed lines |
OPC_ANIM_STYLE_DOTS |
dotted lines |
OPC_ANIM_STYLE_PATTERN |
pattern fill (from icon) |
OPC_ANIM_STYLE_SOLID |
solid lines |
Table 32: Animation Graphical Property Symbolic Constants—Default Properties
| Constant | Description |
|---|---|
OPC_ANIM_DEFPROPS |
specifies that default property settings are to be used |
Table 33: Animation Viewer ID Symbolic Constants
| Constant | Description |
|---|---|
OPC_ANIM_ANVID_NONE |
null ID indicating no viewers are defined |
OPC_ANIM_ANVID_PBSPEC |
custom animation probe-specified animation viewer ID |
Table 34: Animation Macro Arithmetic Operator Symbolic Constants
| Constant | Description |
|---|---|
OPC_ANIM_AROP_ADD |
addition |
OPC_ANIM_AROP_DIVIDE |
division |
OPC_ANIM_AROP_MULTIPLY |
multiplication |
OPC_ANIM_AROP_SUBTRACT |
subtraction |
Table 35: Animation Drawing Erase Mode Symbolic Constants
| Constant | Description |
|---|---|
OPC_ANIM_ERASE_MODE_NONE |
no erasure |
OPC_ANIM_ERASE_MODE_REDRAW |
erase via viewer redraw |
OPC_ANIM_ERASE_MODE_XOR |
erase via drawing Xor-mode redraw |
OPC_ANIM_ERASE_MODE_XOR_RESET |
erase via graphics section; re-execute setup and graphics section |
Table 36: Animation General ID Symbolic Constants
| Constant | Description |
|---|---|
OPC_ANIM_ID_NIL |
NIL ID |
Table 37: Animation Viewer Standard Location Symbolic Constants
| Constant | Description |
|---|---|
OPC_ANIM_LOCATION_E_HALF |
east half of workspace |
OPC_ANIM_LOCATION_FULL |
full workspace |
OPC_ANIM_LOCATION_N_HALF |
north half of workspace |
OPC_ANIM_LOCATION_NE_QTR |
northeast quarter of workspace |
OPC_ANIM_LOCATION_NW_QTR |
northwest quarter of workspace |
OPC_ANIM_LOCATION_S_HALF |
south half of workspace |
OPC_ANIM_LOCATION_SE_QTR |
southeast quarter of workspace |
OPC_ANIM_LOCATION_SW_QTR |
southwest quarter of workspace |
OPC_ANIM_LOCATION_W_HALF |
west half of workspace |
Table 38: Animation Model Drawing Option Symbolic Constants
| Constant | Description |
|---|---|
OPC_ANIM_MOD_OPTION_DYNPATHS |
draw dynamic paths (orbits & trajectories) |
OPC_ANIM_MOD_OPTION_HFSIZE |
draw model at half normal size |
OPC_ANIM_MOD_OPTION_ICONSUBS |
draw model with icon substitution mode enabled |
OPC_ANIM_MOD_OPTION_NONE |
no model drawing options |
Table 39: Animation Model Type Symbolic Constants
| Constant | Description |
|---|---|
OPC_ANIM_MODTYPE_NETWORK |
network model |
OPC_ANIM_MODTYPE_NODE |
node model |
OPC_ANIM_MODTYPE_PROCESS |
process model |
Table 40: Animation Object Attribute Symbolic Constants
| Constant | Description |
|---|---|
OPC_ANIM_OBJ_ATTR_COLOR |
object color (integer) |
OPC_ANIM_OBJ_ATTR_ICON |
object icon name (string) |
OPC_ANIM_OBJ_ATTR_XPOS |
object X coordinate (double) |
OPC_ANIM_OBJ_ATTR_YPOS |
object Y coordinate (double) |
OPC_ANIM_OBJ_ATTR_VECTOR_ANGLE |
object vector angle (double) |
Table 41: Animation Object Type Symbolic Constants
| Constant | Description |
|---|---|
OPC_ANIM_OBJTYPE_BUSLINK |
network model / bus link object |
OPC_ANIM_OBJTYPE_DUPLINK |
network model / duplex link object |
OPC_ANIM_OBJTYPE_MODULE |
node model / module object |
OPC_ANIM_OBJTYPE_NODE |
network model / node object (fixed, mobile, or satellite) |
OPC_ANIM_OBJTYPE_SIMPLINK |
network model / simplex link object |
OPC_ANIM_OBJTYPE_STATE |
process model / state object |
OPC_ANIM_OBJTYPE_STATWIRE |
node model / statistic wire object |
OPC_ANIM_OBJTYPE_STREAM |
node model / stream object |
OPC_ANIM_OBJTYPE_SUBNET |
network model / subnetwork object |
OPC_ANIM_OBJTYPE_TAPLINK |
network model / bus tap object |
OPC_ANIM_OBJTYPE_TRANS |
process model / transition object |
Table 42: Animation Macro Register Identifier Symbolic Constants—Integer Values
These constants define twenty-six integer registers, using the format:
OPC_ANIM_REG_<r>_INT
where <r> is a letter from A to Z, inclusive. For example:
| Constant | Description |
|---|---|
OPC_ANIM_REG_A_INT |
register A / integer value |
OPC_ANIM_REG_Z_INT |
register Z / integer value |
Table 43: Animation Macro Register Identifier Symbolic Constants—Double Values
These constants define twenty-six double registers, using the format:
OPC_ANIM_REG_<r>_DBL
where <r> is a letter from A to Z, inclusive. For example:
| Constant | Description |
|---|---|
OPC_ANIM_REG_A_DBL |
register A / double value |
OPC_ANIM_REG_Z_DBL |
register Z / double value |
Table 44: Animation Macro Register Identifier Symbolic Constants—String Values
These constants define twenty-six string registers, using the format:
OPC_ANIM_REG_<r>_STR
where <r> is a letter from A to Z, inclusive. For example:
| Constant | Description |
|---|---|
OPC_ANIM_REG_A_STR |
register A / string value |
OPC_ANIM_REG_Z_STR |
register Z / string value |
Table 45: Animation Path Traverse ID Symbolic Constants
| Constant | Description |
|---|---|
OPC_ANIM_TRAV_ID_FIRST |
matches first traverse ID in progress on path |
Table 46: Animation Path Traverse Option Symbolic Constants
| Constant | Description |
|---|---|
OPC_ANIM_TRAV_OPTION_CIRCLE |
circle mark |
OPC_ANIM_TRAV_OPTION_DST_ABORT |
abort traversal at destination of path |
OPC_ANIM_TRAV_OPTION_DST_BEGIN |
begin traversal at destination of path |
OPC_ANIM_TRAV_OPTION_DST_END |
end traversal at destination of path |
OPC_ANIM_TRAV_OPTION_FULL |
full traversal from path source to destination |
OPC_ANIM_TRAV_OPTION_REVERSE |
reverse direction |
OPC_ANIM_TRAV_OPTION_SQUARE |
square mark |
OPC_ANIM_TRAV_OPTION_SRC_ABORT |
abort traversal at source of path |
OPC_ANIM_TRAV_OPTION_SRC_BEGIN |
begin traversal at source of path |
OPC_ANIM_TRAV_OPTION_SRC_END |
end traversal at source of path |
OPC_ANIM_TRAV_OPTION_TEXT |
include text traverse label |
Table 47: Animation Model Object Vertices Symbolic Constants
| Constant | Description |
|---|---|
OPC_ANIM_VERTEX_ICON_CTR |
vertex is at center of icon |
OPC_ANIM_VERTEX_ICON_E |
vertex is at center of icon right edge |
OPC_ANIM_VERTEX_ICON_N |
vertex is at center of icon top edge |
OPC_ANIM_VERTEX_ICON_NE |
vertex is at top-right corner of icon |
OPC_ANIM_VERTEX_ICON_NW |
vertex is at top-left corner of icon |
OPC_ANIM_VERTEX_ICON_S |
vertex is at center of icon bottom edge |
OPC_ANIM_VERTEX_ICON_SE |
vertex is at bottom-right corner of icon |
OPC_ANIM_VERTEX_ICON_SW |
vertex is at bottom-left corner of icon |
OPC_ANIM_VERTEX_ICON_W |
vertex is at center of icon left edge |
OPC_ANIM_VERTEX_PATH_DST |
vertex is at destination point of path |
OPC_ANIM_VERTEX_PATH_MID |
vertex is at mid-point of path |
OPC_ANIM_VERTEX_PATH_SRC |
vertex is at source point of path |