The following PMGlobe commands are available in PMGlobe 3.
End PMGlobe (as though Exit had been selected from the Options menu, or
Close were selected in the system menu).
Used for obtaining the values of various PMGlobe settings for use with a
Rexx macro.
items is a list of one or more keywords, as given in the QUERY
and SET commands below. The values of the specified items are placed
into Rexx variables of the same name. (See above for a simple example.)
Defines a font, with nickname name (up to 15 characters). SIZE
sets the font size (total height in points), and FACE specifies the name
of a font (e.g., Helvetica, Courier, etc.). FACE, if
used, must be the last keyword in the command, and the remainder of the
command forms the face name.
Windows will choose a font as close as possible to the requested font.
If no FACE is specified then a default system proportional font
is used.
The default size for fonts is 12 points.
The colour for a font is specified using the COLOUR keyword and one of the
colours listed above. The default colour is Yellow.
Fonts may not be redefined. The default system proportional font is
predefined with the nickname default.
Erases either all DRAW graphics or all TRACK graphics. DRAW is the
default; TRACK is normally only used by PMGlobe, for drawing tracks.
Draws either a DRAW or a TRACK line from the current point to the point
specified, and then makes the specified point the current point.
DRAW is the default, and draws the line in the colour set by
DRAWCOLOUR.
TRACK is normally only used by PMGlobe, for drawing tracks, and draws
the line in the colour set by TRACKCOLOUR.
If no current point has been set (by GMOVE) before this command is
used, latitude 0 and longitude 0 are used.
Sets the current point for either DRAW or TRACK graphics. DRAW is the
default, and sets the current point for DRAW graphics. TRACK is
normally only used by PMGlobe, and sets the current point for TRACK
graphics.
Invoke the specified command-list or Rexx macro. The macro should be in
the working directory for the application, or have its path specified.
If the name or path contains blanks the file value must be a quoted
token.
For example: macro "c:\program files\pmglobe\sample"
If no filename extension is given, one of .pmg is added. The
remainder of the command is passed as the argument to the macro
(accessible in Rexx by the PARSE ARG instruction or ARG(1) built-in
function).
Note that at the highest level, macros run as a single separate thread.
Macros may invoke each other, using the MACRO command, up to a depth of
ten (other than this, only one macro can be running at a time). All
macros that are running will be halted by selecting
Halt macro from the Options menu or the command dialog.
Adds a mark to the displayed globe. Latitude and longitude (lat and
lon) set the position of the mark and are always required.
The mark will be indicated according to the setting of of SET
MARKER (default ‘+’) at the time of the MARK command, unless
overridden by the option MARKER. The value, m, of the marker can be any
of ‘.’, ‘+’, ‘x’, or ‘X’ for various shapes of
marker. ‘!’ may be used for a tiny (single-pixel) marker. m can be
OFF if no mark is to be shown.
The colour used for a mark is the current drawing colour, as set by SET
DRAWCOLOUR colour, at the time of the MARK command. If none was set
then White is used.
A mark may have some text associated with it, described by the CLOCK and
LABEL options. This text is displayed with the start of the baseline at
an offset from the mark as determined by the X and Y options; the
offsets are given in pixels, up to 1000, and may be positive or negative,
or CENTRE. The default X and Y offsets (X position and Y position) are +3.
If the text would extend beyond the bounds of the square enclosing the
globe, then its position is adjusted in order to stay within bounds (if
possible). The RIGHT option may be specified to use the right-hand end
of the baseline to position the text (and in this case the default X
position is –3).
If CLOCK is specified, the text begins with a time-of-day clock. The
zone may either be defined as an offset from GMT, in seconds,
or it may be the name of a time zone. This time zone name may either be
one of the default time zones or it may be one
specified by a previous ZONE command.
The time-of-day clock is shown in 24-hour or civil format, depending on
the setting of CLOCKCIVIL, and is refreshed according to the REFRESH
setting. Use the CLOCKDAY setting for an additional
tomorrow/yesterday indication (+/–), which immediately follows the
time-of-day clock.
If LABEL is specified, it must be the last option on the command: the
remainder of the command, after the keyword LABEL and one blank, forms
the label part of the text, which follows any clock and may be up to
100 characters.
For example:
mark 37o45 -122o27 clock PST label San Francisco
The font used for the text is the current font, as set by SET FONT
nickname, at the time of the MARK command. If none is set then the
default system font is used.
Markers, clocks, and labels can be included or excluded as a group by
using the MARKERS, CLOCKS, and LABELS settings respectively. No
markers, clocks, or labels are shown if the window size is less than or
equal to 64 pixels in either dimension.
Deletes one or more marks from the globe. Latitude and longitude (lat
and lon) are always required but either or both may be specified as ALL.
Any mark that matches the specified lat and lon is deleted (where ALL
matches any latitude or longitude, as appropriate). If neither lat nor
lon is ALL then at least one mark should exist with the given coordinates.
Display text in a message box. The message box can be moved, and does
not inhibit interaction with the globe or distance calculator. The
MESSAGE command waits until the OK pushbutton on the message box is
selected or the message box is closed. Commands are currently limited
to 200 characters, so the longest message possible is 192 characters.
Initiates a redrawing of the Globe. Normally a REDRAW is automatic at
the end of a macro or after a command is entered from the command
dialog. The REDRAW command is provided for long-running macros. The
command does not wait until redrawing is complete.
The ALL option requests that all features of the globe are redrawn,
including any grid lines and marks (normally only those features that
have changed since the last draw are drawn).
Queries the state of various PMGlobe settings. items is a list
of one or more keywords. The result of the QUERY command is displayed
on the PMGlobe console (which must be active before the command is
executed); each item’s name and value are shown, each starting on a new
line.
Any item that can be set by the SET command (see below) may also be
queried. The value of any item that may be set or queried may also be
obtained by a Rexx macro, using the EXTRACT command.
Valid items are:
- ACTIVE
- ON if the globe window is the active window, else OFF
- CLOCKMARKS
- number of clocks set using the MARK command
- DAYOFFSET
- time offset due to daylight savings (ON, OFF, or UNKNOWN)
- DAYSAVINGS
- the daylight savings offset in effect (in seconds), if
any, or UNKNOWN
- DIAMETER
- globe diameter in pixels (0 if unknown)
- FONTS
- number of fonts defined using the FONT command
- GMTOFFSET
- base time offset from GMT (in seconds), or UNKNOWN
- ININAME
- full path and file name of the .INI file used to save PMGlobe
settings
- MARKS
- number of marks set using the MARK command
- SUNLAT
- latitude at which the sun is overhead (x.xxx), or UNKNOWN
- SUNLON
- longitude at which the sun is overhead (x.xxx), or UNKNOWN
(multiply by -4 to get the time in minutes from solar noon)
- VERSION
- PMGlobe version number
- VERSIONB
- Version extended information
- ZONENAME
- current time zone full name, as supplied by Windows (‘???’ if
unknown)
Changes the state of various PMGlobe settings to newvalue,
which is the remainder of the command following the item name and one
blank.
item is one of the following names. The value of any item
that can be SET can also be queried using the QUERY command, or obtained
by a Rexx macro using the EXTRACT command (see above).
Flags (items that are either ON or OFF) can also be set to INVERT, which
changes the state of the flag from ON to OFF or vice versa.
Valid items are:
- BACKCOLOUR
- set the colour of the background (names as given in the general rules
above)
- CIRCULAR
- display the globe as a circular window (ON or OFF)
- CLOCKCIVIL
- use 12-hour clock format for any clocks (ON or OFF)
- CLOCKDAY
- add flag (+ for tomorrow, – for yesterday) to clocks (ON or OFF)
- CLOCKS
- display the clocks on marks (ON or OFF)
- CONSOLE
- display the windows console, to view Query output, Rexx tracing, etc. (ON or OFF)
- CROSSHAIR
- use the large cross-hair cursor when over globe (ON or OFF)
- DAYIMAGE
- set the image to be used for daylight or default view of the globe
(CLASSIC, DEFAULT, or FILE)
- DAYIMAGEFILE
-
set the file to be used when DAYIMAGE is set to FILE. The given file
must be fully specified or be in the current directory, and it must have
a file extension of .jpg, .gif, or .bmp. For best
results the image should be at least 900 pixels high.
Image files are reloaded when the globe image is refreshed if they are
in use and their name or timestamp changes.
- DRAWCOLOUR
- set the colour for drawing markers and graphics (names as above)
- ERRORBOX
- display command errors in a message box (ON or OFF)
- FONT
- sets the current font, by nickname
- GRIDCOLOUR
- set the colour of grid lines (names as above)
- GRIDLAT
- set the grid latitude line frequency (0 for off, or one of 10, 15, 30,
or 90)
- GRIDLON
- set the grid longitude line frequency (0 for off, or one of 10, 15,
or 30)
- GRIDPOLAR
- show grid polar circles (ON or OFF)
- GRIDTROPIC
- show grid tropics of Cancer and Capricorn (ON or OFF)
- HOVER
- show the longitude and latitude of the pointer in a hover window (ON or OFF)
- HOVERABOVE
- show the hover window above the cursor (ON or OFF)
- LABELS
- display the labels on marks (ON or OFF)
- LANDCOLOUR
- set the colour used for land in the Classic daylight image (names as above)
- MARGIN
- percentage border to allow around globe (0 through 49.999)
- MARKER
- current default marker (‘.’, ‘+’, ‘x’, ‘X’, or
OFF)
- MARKERS
- display the markers on marks (ON or OFF)
- MENUBAR
- display the menu bar above the globe (ON or OFF)
- NIGHTIMAGE
- set the image to be used for the night-time view of the globe
(CLASSIC, DEFAULT, FILE, HALFDAY, DARKDAY, or BLACK)
- NIGHTIMAGEFILE
-
set the file to be used when NIGHTIMAGE is set to FILE, following the
same rules as for DAYIMAGEFILE, above.
- REFRESH
- set the refresh interval (in seconds, maximum 24 hours)
- SHADING
- set ‘3-D’ shading (ON or OFF)
- SHOWDRAW
- show (update) picture of globe as it is calculated (ON or OFF)
- SPIN
- set ‘rotate with sun’ (ON or OFF). If ON, the viewpoint
changes with the time of day (the position of the sun is fixed, as set
by SUNOFFSET).
- STARTMACRO
- set the macro file (with extension .pmg) which will be run
when PMGlobe starts
- SUNLIGHT
- set ‘sun’ lighting (ON or OFF)
- SUNOFFSET
- set the offset to be used for the sun, if SPIN is ON. This is a
offset in seconds of up to +/– 12 hours, with the sun being
overhead at offset 0 and to the right of the screen if offset +6 hours
(+21600).
SUNOFFSET is updated automatically when a fixed view position is set.
- TITLE
- set the window title (max 50 characters)
- TITLEBAR
- display the PMGlobe window title bar (ON or OFF)
- TRACKCOLOUR
- set the colour for drawing tracks (names as above)
- TWILIGHT
- set the degrees of twilight shown (0 through 18 degrees)
- USEROFFSET
- time to add to real time (seconds, maximum +/– one year)
- VIEWLAT
- latitude of centre of view (x.xxx)
- VIEWLON
- longitude of centre of view (x.xxx)
- WATERCOLOUR
- set the colour used for lakes and seas in the Classic daylight image
(names as above)
The following settings are for development use only; the effect of
each is not defined:
- DIAG
- display diagnostic messages on the console (ON or OFF)
- DIAGMSG
- display Windows client messages on the console (ON or OFF)
- TEST
- controls certain test functions (ON or OFF)
Wait until a redraw is completed, or until a particular time-of-day, or
for a certain length of time from now. Any times are given in hours, with
optional minutes and seconds indicated by colons (for example, +0:20
would mean ‘wait for twenty minutes’). If a specific time of day is
given and is earlier than the current time of day, then the next day is
assumed. Multiple times (absolute, relative, or mixed) may be
specified, and WAIT will return when the earliest is reached. The
maximum wait time is 24 hours (+24).
If REDRAW is specified, then a REDRAW is started automatically, and WAIT
will return when the redraw is complete or any time condition specified
is met, whichever happens earlier.
Any WAIT called from a macro is also ended by selecting ‘Halt macro’
from the Options menu or the command dialog.
Defines a time zone, with nickname name (up to 15 characters and
starting with an alphabetic character), which can then be used to define
a clock in the MARK command. The title must
exactly match the full name of a Windows time zone as recorded in the
Windows Registry.[1]
For example:
Zone PAC Pacific Standard Time
Note that PMGlobe sets up a number of default
time zones so this command is only needed for new time zones.
Footnotes:
| [1] |
In
HKEY LOCAL MACHINE\Software\Microsoft\Windows NT\CurrentVersion\Time Zones
|
[previous | contents | next]
Copyright (c) IBM Corporation, 2009. All rights reserved. ©
Author:
Mike Cowlishaw,
mfc@speleotrove.com