SclDigitise
Overview
Obtains the coordinates of the mouse location when the mouse button is depressed while in a Graphics viewport.
Synopsis
SclDigitise $PromptText xvar yvar zvar $MarkerStyle
Description
The text in the PromptText argument is displayed to instruct the user to take the necessary action required to locate the cursor using the mouse and press the mouse button to digitise a location in a Grapics viewport.
This command is only appropriate for use in a window that contains either a 3D or 2D Graphics component.
The coordinates that are returned to define the mouse location are in the same coordinate space as the data that is displayed in the graphics window.
The Z coordinate that is returned represents a value on the plane onto which the image is projected.
Arguments
- PromptText
- xvar, yvar, zvar
- MarkerStyle
Passed by value. The value of this argument is displayed in the graphics prompting region to instruct the user to perform the digitise action.
Passed by reference. These variables are assigned the X, Y and Z values of the position in the Graphics window where the mouse button is depressed.
Passed by value. The symbolic representation of the marker that is to be drawn at the location of the digitised point. Note that this argument is optional and if no value is included then no marker will be drawn. Valid marker symbols are shown in the table below.
| Marker symbol code | Description |
|---|---|
| "*" | A star of some sort. |
| "X" | An 'x' mark. |
| "+" | A `+' mark. |
| "." | A simple `.'. |
| "()" or "O" | An open circle, similar to `O'. Note: both a letter ("O" or "o") and a numeral ("0") will work. |
| "(*)" or "@" | A filled-in circle. |
| "(.)" | An open circle with a dot in the center. |
| "(+)" | An open circle with a + in the center. |
| "(x)" | An open circle with an 'X' in the center. |
| "(())" or "(O)" | An open circle with another circle inside. |
| {[]} | A hollow box. Note the use of {} to prevent TCL interpreting the [] as a command expansion. |
| {[*]} | A filled-in box. |
| {[.]} | A hollow box with a dot in the center. |
| {[x]} | A hollow box with an 'X' in the center. |
| "<>" | A hollow diamond. |
| "<*>" | A filled-in diamond. |
| "<.>" | A hollow diamond with a dot in the center. |
| "<+>" | A hollow diamond with a + in the center. |
| "/\\" | A hollow up-pointing triangle. |
| "/*\\" | A filled-in triangle. |
| "/.\\" | A hollow triangle with a dot in the center. |
| "|>" | A hollow rightward-triangle. |
| "|*>" | A filled-in rightward-triangle. |
| "|.>" | A hollow rightward-triangle with a dot in the center. |