Simanim animation functions

Reference Guide

Here, a description of the available functions is given. The functions are listed in alphabetical order. A function description consist of its name followed by its arguments, and a description of its behaviour below this.
Functions are given in bold and arguments of functions in italic. Arguments in between square brackets are optional. An argument followed by ... indicates that this argument may appear more than once. Arguments of options separated by | means that they are alternatives.
Anim::ActivateLine line
Activates line, which means that the line changes color.
Anim::AddClear item duplet ...
Adds the duplets to the clear-list of item. When the function Anim::Clear is called for item, the lines and texts indicated with the duplets are cleared (deactivated or deleted).
A duplet has the following form
     { type id }
type is either line or text, and id is the name of the line or text.
Anim::AddList list entry
Add entry to list.
Anim::AddQueue queue string
Add string to queue.
Anim::ChangeTextItem item string
Change the text displayed on item into string.
Anim::Clear item
Clear the things found in the clear-list of item, added by function Anim::AddClear.
Anim::Color
Returns 0 if it is a monochrome display, otherwise returns the depth of the color display.
Anim::ColorListbox normal select
Sets the color for listboxes to normal and for selected items in the listboxes to select.
Anim::Colorset set type normal active
Sets the normal and active colors for type in colorset set to normal and active. Type may be one of rect, oval, line, or text. If colorset set does not exist it is made with initial values copied from colorset 0.
Note: Colorsets 0 and 1 are predefined, but values can be changed with this function.
Anim::CombineTag item type id
Combines the tags for item and type so that when item is moved with the use of Anim::Move, id moves along. Type can either be item or line.
Anim::CreateBox pbox name [options]
Creates a box in the info-window with as parent-box pbox, and with id name. The top parent-box is created by default and is called info.
Options:
-side top | bottom | left | right
Specify to which side of the box the children (boxes and labels) will be placed.
Default top.
-fill none | x | y | both
If a child of this box is smaller than the available space for this child, it is stretched according the the value given for this option.
none
No stretching.
x
Stretch the children horizontally to fill the entire width of the available space for the children.
y
Stretch the children vertically to fill the entire height of the available space for the children.
both
Stretch the children both horizontally and vertically.
Default none.
-relief flat | groove | raised | ridge | sunken
The type of border (3D-effect) to be drawn around the box.
Default flat.
-bw width
The width of the border.
Default 0.
-ipadx pixels
Pixels specifies how much horizontal space to leave on each side of the children of the box.
Default 0.
-ipady pixels
Pixels specifies how much vertical space to leave on each side of the children of the box.
Default 0.
-expand
If this option is given, and if there is still space left unoccupied by the children, the children are expanded. Extra horizontal space is added to the children for which the -side option has the value left or right, and extra vertical space is added to the children for which the -side option has the value top or bottom.
Anim::CreateItem item type x y w h string [options]
Creates an item of type with the center at and with width 2 * w and height 2 * h. type can either be rect for a rectangle or oval for an oval. string is centered on item. Item serves as the name in order to make references to it in calls to the other functions.
Options:
-nolist
There will be no list associated with item.
-free
Registers the item as to be freed on a reset.
-color setname
Setname specifies the name of the colorset to be used for item. By default there are 2 colorsets available named 0 and New colorsets can be made with Anim::Colorset.
Default 0.
Anim::CreateLabel box name string [options]
Creates a label with string as text in box.
Options:
-var
string is treated as the name of a variable, which means that the value of the variable is displayed instead of string. When the variable is updated, the label is updated too.
-relief flat | groove | raised | ridge | sunken
The type of border (3D-effect) to be drawn around the label.
Default flat.
-bw width
The borderwidth of the label.
Default 2.
-width width
The width of the label.
Default 0.
-anchor anchor
Specifies how string is to be displayed in the space for the label. Possible values are n, ne, e, se, s, sw, w, nw, or center. For example, nw means display the top-left corner of string at the top-left corner of the label.
Default center.
-padx pixels
Extra space on the left and right of the label.
Default 1.
Anim::CreateLine line triplet triplet ... [options]
Draws a line from triplet to triplet to ... . A triplet has one of the following forms
      pos x y
to indicate position and
      item name anchor
to indicate the position of anchor of item name. Possible values for anchor are n, e, s, w, nw, ne, se, sw, ce, or chop.
Chop means that the line is chopped at the border of item.
Options:
-width width
The width of line.
Default 3.
-arrow none | first | last | both
Specify on which ends of the line to draw arrows.
Default none.
-color setname
Setname specifies the name of the colorset to be used for item. By default there are 2 colorsets available named 0 and New colorsets can be made with Anim::Colorset.
Default 0.
-nolower
Normally a line is lowered so that all items are displayed on top of this line. This option turns this off.
-free
Registers the line as to be freed on a reset.
Anim::CreateQueue queue x y w h [options]
Creates a queue consisting of a text-window and a scrollbar. It is positioned with the anchor given by the option -anchor on the position The text-window has the width w and the height h. The queue-items in a horizontal queue are separated by a space, and in a vertical queue they appear one a line.
Options:
-orientation horizontal | vertical
Specifies the orientation of queue.
Default horizontal.
-anchor anchor
Specifies the point of queue that will be put on the position Possible values are n, ne, e, se, s, sw, w, nw, or center.
Default center.
Anim::CreateStack stack x y w h [options]
Creates a stack consisting of a text-window and a scrollbar. It is positioned with the anchor given by the option -anchor on the position The text-window has the width w and the height h. The stack-items in a horizontal stack are separated by a space, and in a vertical stack they appear one a line.
Options:
-orientation horizontal | vertical
Specifies the orientation of stack.
Default horizontal.
-anchor anchor
Specifies the point of stack that will be put on the position Possible values are n, ne, e, se, s, sw, w, nw, or center.
Default center.
Anim::CreateText id string
Create a text string on the text-position indicated by id formerly created by either Anim::Textpos, Anim::TextposItem, Anim::TextposLine.
Anim::DeactivateItem item
Opposite of Anim::ActivateItem.
Anim::DeactivateLine line
Opposite of Anim::ActivateLine.
Anim::DeleteQueue queue text
Deletes element text from queue.
Anim::DeleteStack stack text
Deletes element text from stack.
Anim::DeleteText id
Deletes text from the text-position indicated by id, formerly created with Anim::CreateText.
Anim::DestroyItem item
Destroys the item indicated by item and formerly created by Anim::CreateItem.
Anim::DestroyLine line
Destroys the line indicated by line and formerly created by Anim::CreateLine.
Anim::Dim id dimension
Returns the dimension dimension of item id. Possible values for dimension are
     x  y  ce  n  e  s  w  nw  ne  se  sw  n,y  s,y  e,x  w,x  wid  ht
Anim::DimL id dimension
Returns the dimension dimension of line id. Possible values for dimension are
     start  end  start,x  start,y  end,x  end,y
Anim::DimQ id dimension
Returns the dimension dimension of queue id. Possible values for dimension are
     x  y  ce  n  e  s  w  nw  ne  se  sw  n,y  s,y  e,x  w,x  wid  ht
Anim::DimS id dimension
Returns the dimension dimension of stack id. Possible values for dimension are
     x  y  ce  n  e  s  w  nw  ne  se  sw  n,y  s,y  e,x  w,x  wid  ht
Anim::Init canvas
Initializes the animation library for window canvas.
This function is called by Anim::Windows.
Anim::InitArray name list
Initializes array name with indices and values taken from list. list must consist of a list of index value index value ... separated by spaces. On a reset, this initialization is also performed.
Anim::InitVar name value
Initializes variable name with value. On a reset, this initialization is also performed.
Anim::Move item movement ... [options]
Moves item along the path given by the movements, where a movement is one of the following
     left d
     right d
     up d
     down d
     leftto x
     rightto x
     upto y
     downto y
Here, d is a distance in pixels, x is a x-coordinate, and y is a y-coordinate.
Options:
-newid id
Changes the id of the item into id.
Anim::PopStack stack
Pops the top stack-item from stack.
Anim::PushStack stack string
Pushes string onto stack.
Anim::SubQueue queue
Removes the first queue-item from queue.
Anim::Textpos id x y anchor [options]
Creates a text-position with name I id with anchor on position Possible values are n, ne, e, se, s, sw, w, nw, or center.
Options:
-noreset
Indicates that the text on this position is not be deleted on a reset.
Anim::TextposItem id item corner anchor
Creates a text-position with name I id with anchor on corner of item. Possible values are n, ne, e, se, s, sw, w, nw, or center.
Anim::TextposLine id line anchor [options]
Creates a text-position with name I id with anchor somewhere along line according to the options or their defaults. Possible values are n, ne, e, se, s, sw, w, nw, or center.
Options:
-d distance
Gives the distance from the beginning of the line for the position of the anchor. distance must be given as a fraction (from 0.0 to 1.0) of the length of the line (or segment)
Default 0.5.
-s segment
segment indicates to which part of the line the calculations for the position of the anchor are done.
Default 1.
Anim::View x y
Brings position into view.
Anim::ViewX x
Brings horizontal position x into view.
Anim::ViewY y
Brings vertical position y into view.
Anim::Windows width height [options]
Initializes the windows with width and height for the width and height of the canvas.
It also creates a box with name info, to be used as parent-box for function Anim::CreateBox.
And calls Anim::Init for initialization of the animation library.
Options:
-text width height
Creates a text-window with width and height in characters, next to the canvas.

last modified: