WzSurface Procedure

PV-WAVE Foundation > Reference Guide > Procedure and Function Reference: W > WzSurface Procedure

WzSurface Procedure

Starts a VDA Tool used for surface plots.

Usage

WzSurface, z[, x, y]

Input Parameters

z — A 2D array containing the values that make up the surface or an equivalent expression. If x and y are supplied, the surface is plotted as a function of the X,Y locations specified by their contents. Otherwise, the surface is generated as a function of the array index of each element of z.

x — (optional) A vector or 2D array (or equivalent expression) specifying the x-coordinates for the surface.

If x is a vector, each element of x specifies the x-coordinate for a column of z. For example, x(0) specifies the x-coordinate for z(0, *).

If x is a 2D array, each element of x specifies the x-coordinate of the corresponding point in z (xij specifies the x-coordinate for zij).

y — (optional) A vector or 2D array (or equivalent expression) specifying the y-coordinates for the surface.

If y is a vector, each element of y specifies the y-coordinate for a row of z. For example, y(0) specifies the y-coordinate for
z (*, 0).

If y is a 2D array, each element of y specifies the y-coordinate of the corresponding point in z (yij specifies the y-coordinate for zij).

Keywords

NoBlock — If specified, the event loop (WwLoop) that is started by the VDA Tool will use the given value. By default a value of 1 (non-blocking loop) will be used. However, it may be necessary in certain circumstances to force a non-blocking loop by specifying NoBlock = 2. (See WwLoop in the PV‑WAVE Application Developer’s Guide for more information.)

Parent — The widget ID of the parent widget.

Position — Specifies, in pixels, the x and y (horizontal and vertical) coordinates for the starting location of the upper-left corner of the VDA Tool window.

Restore — A data structure previously saved by the Tools Manager with the TmSaveTools function. This keyword is reserved for internal use; it is not to be used at the command line (see Discussion).

Shade — Used to specify how to shade the surface. This keyword can be set to a variable (2D byte array) used to shade the surface, or to one of the following values:

1 — Gouraud shading

2 — Elevation shading

Default — not shaded

Template — A string containing the name of a VDA Tool template file.

XSize — Specifies, in pixels, the width of the drawing area.

YSize — Specifies, in pixels, the height of the drawing area.

Discussion

The Parent keyword is used to connect WzSurface to another application, such as the Navigator.

The Restore keyword is used specifically by the TM_RESTORE method. For information on the TM_RESTORE method, refer to the source code for WzPlot in:

(UNIX) <wavedir>/lib/vdatools/wzsurface.pro

(WIN) <wavedir>\lib\vdatools\wzsurface.pro

Where <wavedir> is the main PV‑WAVE directory.

A template is a VDA Tool without any data associated with it. The template contains all of the modifications to the VDA Tool — colors, axes, graphical elements — that were set when the template file was saved. Template files are saved with the Save Template As command from the File menu on the VDA Tool.

note	For information on how to use this VDA Tool, use online Help. Select the On Window command from the VDA Tool Help menu to bring up Help on this VDA Tool.

Example

var = DIST(40)

WzSurface, var, XSize=400, YSize=400