KP Options
Many of the arguments of Anim package KPs are integers that indicate options via symbolic constant “flags”. The most prevalent option is the props argument (abbreviation for properties). This argument indicates display options for graphical primitives drawn by Anim KPs, via a bitwise OR combination of symbolic constant values. Property flags and the corresponding symbolic constant prefixes are listed in Table 7. KPs that accept the props argument apply one or more properties to the resulting graphical primitive; the relevant properties for each KP are listed in the corresponding Details section.
Table 7: Graphical Primitive Properties
| Property | Constant Prefix | Description | Default |
|---|---|---|---|
pixop |
OPC_ANIM_PIXOP |
sets pixel operation of primitive (such as SRC and XOR) | SRC |
color |
OPC_ANIM_COLOR |
sets color of primitive | black |
bgcolor |
OPC_ANIM_BGCOLOR |
sets background color of text | black |
retention |
OPC_ANIM_RETAIN |
sets retention of primitive | non-retained |
style |
OPC_ANIM_STYLE |
sets draw or fill style of primitive | solid |
font |
OPC_ANIM_FONT |
sets font of text | open / 10pt |
alignh |
OPC_ANIM_ALIGNH |
sets horizontal alignment of text | left edge |
alignv |
OPC_ANIM_ALIGHV |
sets vertical alignment of text | top edge |
Each property has a default value, as listed above. To obtain a completely default property setting on a primitive, the symbolic constant OPC_ANIM_DEFPROPS can be passed. Non-default property settings will consist of one or more property symbolic constants combined via the C bitwise OR operator, as shown in the example below:
props = OPC_ANIM_RETAIN | OPC_ANIM_COLOR_GREEN;