/*
** pgraph.dec - Publication Quality Graphics Support.
** (C) Copyright 1988-1998 by Aptech Systems, Inc.
** All Rights Reserved.
**
** This Software Product is PROPRIETARY SOURCE CODE OF APTECH
** SYSTEMS, INC.    This File Header must accompany all files using
** any portion, in whole or in part, of this Source Code.   In
** addition, the right to create such files is strictly limited by
** Section 2.A. of the GAUSS Applications License Agreement
** accompanying this Software Product.
**
** If you wish to distribute any portion of the proprietary Source
** Code, in whole or in part, you must first obtain written
** permission from Aptech Systems.
**
** This file contains declarations and help for the global variables used
** in the GAUSS publication quality graphics.

=======================   Table of contents   ==============================


          Axes Control and Scaling .......................... 23
          Text, Labels, Titles, and Fonts ................... 43
          Main Curve Lines and Symbols ...................... 63
          Extra Messages, Symbols, etc ...................... 74
          Windows, Page, and Plot Control ................... 86
          Output options ................................... 106

          Quick Reference to Common Globals ................ 119



Axes Control and Scaling

_paxes         Turn axes on or off
_pcrop         Control cropping of graphics data outside axes area
_pcross        Controls where axes intersect
_pframe        Draw a frame around 2D, 3D plots
_pgrid         Control major and minor grid lines
_pxpmax        Control precision of numbers on X axis
_pypmax        Control precision of numbers on Y axis
_pzpmax        Control precision of numbers on Z axis
_pxsci         Control use of scientific notation on X axis
_pysci         Control use of scientific notation on Y axis
_pzsci         Control use of scientific notation on Z axis
_pticout       Control direction of tic marks on axes
SCALE          Scale X,Y axes on 2-D plots
SCALE3D        Scale X,Y,Z axes for 3-D plots
XTICS          Scale X axis and control tic marks
YTICS          Scale Y axis and control tic marks
ZTICS          Scale Z axis and control tic marks

Text, Labels, Titles, and Fonts

_plegctl       Set location and size of plot legend
_plegstr       Specify legend text entries
_paxht         Control size of axes labels
_pnumht        Control size of axes numbering
_pnum          Axes number control and orientation
_pdate         Date string contents and control
_ptitlht       Control title size
XLABEL         X axis label
YLABEL         Y axis label
ZLABEL         Z axis label
TITLE          Specify main title for graph
ASCLABEL       Define character labels for tic marks
FONTS          Load fonts for labels, titles, messages and legend
VIEW           Set 3D observer position in workbox units
VIEWXYZ        Set 3D observer position in plot coordinates
VOLUME         Sets length, width, and height ratios of 3D workbox


Main Curve Lines and Symbols

_pboxctl       Control box plots
_plctrl        Control main curve and data symbols
_pcolor        Control line color for main curves
_pltype        Control line style for main curves
_plwidth       Control line thickness for main curves
_pstype        Control symbol type
_psymsiz       Control symbol size
_pzclr         Z level color control for CONTOUR and 3D graphs

Extra Messages, Symbols, Lines, Circles, Arrows, and Error Bars

_parrow        Create arrows
_parrow3       Create arrows for 3d graphs
_pline         Plot extra lines and circles
_pline3d       Plot extra lines for 3d graphs
_psym          Plot extra symbols
_psym3d        Plot extra symbols for 3d graphs
_perrbar       Plot error bars
_pmsgctl       Control position of message text
_pmsgstr       Specify additional message text

Windows, Page, and Plot Control

_pagesiz       Control size of graph for printer output
_pageshf       Shift the graph for printer output
_pbox          Draw a box (frame) around window using color
_plotsiz       Control plot area size
_plotshf       Control plot area position
_protate       Rotate the graph 90 degrees
AXMARGIN       Control of axes margins (axes lengths)
MARGIN         Control graph margins
BEGWIND        Window initialization procedure
ENDWIND        End window manipulation, display graphs
WINDOW         Create tiled windows of equal size
MAKEWIND       Create window with specified size and position
SETWIND        Set to specified window number
NEXTWIND       Set to next available window number
GETWIND        Get current window number
SAVEWIN        Save window configuration to a file
LOADWIN        Load a window configuration from a file

Output options
_pnotify       Control interactive "draft" mode
_pscreen       Control graphics output to screen
_psilent       Control final beep
_pzoom         Specify zoom parameters
_pcvfile       Name of format conversion file
_prtfile       Name of output print file
_ptek          Name of graphics .TKF file
_pqgedit       Interactive mouse-driven graphics editor (optional)
_pqgplay       Control whether PQGRUN or PLAY is used
HARDCOPY       Generate print or conversion file
SETCNVRT       Create response file for format conversion file


********************************************************************************
                     QUICK REFERENCE FOR COMMON GLOBALS
********************************************************************************

    _PAXES   Global _PAXES, previously a scalar for turning axes on/off, is
             now a scalar, 2x1 or 3x1 vector for independent control for
             each axis.  If a scalar value, the vector will be expanded to
             that value.

             Examples: _paxes = 0;      - turn off all axes
                       _paxes = 1;      - turn on all axes
                       _paxes = {1,0}   - turn X axis, Y off;
                       _paxes = {0,0,1} - turn Z axis on, X,Y off;

    _PARROW  Draw 2D arrows
             [M,1]  x starting point
             [M,2]  y starting point
             [M,3]  x ending point
             [M,4]  y ending point
             [M,5]  length ratio of arrow head to its half width
             [M,6]  size of arrow head in inches
             [M,7]  type and number of arrow heads mn.
                    "m", form of arrow head
                    "n", location of arrow head
             [M,8]  color of arrow.  1-15
             [M,9]  X,Y coordinate units: 1=plot coord, 2=inches
             [M,10] line type, 1-6
             [M,11] line thickness.

    Example: _parrow = { 10 10 20 20 5 .2 21 10 1 6 0 }


    _PARROW3 Draw 3D arrows
             [M,1]  x starting point in plot coord.
             [M,2]  y starting point in plot coord.
             [M,3]  z starting point in plot coord.
             [M,4]  x ending point in plot coord.
             [M,5]  y ending point in plot coord.
             [M,6]  z ending point in plot coord.
             [M,7]  length ratio of arrow head to its half width
             [M,8]  size of arrow head in inches
             [M,9]  type and number of arrow heads mn.
                    "m", form of arrow head
                    "n", location of arrow head
             [M,10] color of arrow.  1-15
             [M,11] line type, 1-6
             [M,12] line thickness.
             [M,13] Hidden line flag. 1=obscured by surface, 0=Off.

         Example: _parrow3 = { 10 10 10 20 20 20 5 .2 21 10 6 0 0 }


    _PBARTYP  Used with procedure BAR, controls bar shade and color.  Each
              row of this matrix corresponds to each column of bar data.

             [M,1]  Bar shade style.

                    0 - No shade, outline only.
                    1 - Dots.
                    2 - Horizontal lines.
                    3 - Diagonal lines, positive slope.
                    4 - Diagonal lines, negative slope.
                    5 - Diagonal crosshatch.
                    6 - Solid.

             [M,2]  Color for bar set.

         Example:

             @ three columns of bar data (10 bars per column) @
             y = rndu(10,3);
             @ shade and color for each column of bar data @
             _pbartyp = { 0 10, 2 11, 6 12 };
             bar(0,y);


    _PBARWID  Used with BAR, controls the bar width.  A real value between
             0 and 1.  If this value is positive the bars will overlap each
             other (default).  If this is negative the bars will be plotted
             side-by-side.

         Example:

             _pbarwid = -.7;   @ plot the bars side-by-side @
             bar(0,y);


    _PBOX    Draw a border around the window with color and line width.

         Example:
        _pbox = 0;         - turn off window border (default)
        _pbox = 15;        - window border with color 15 (bright white)
        _pbox = { 1,10,4 } - window border with color 10 and line width 4


    _PERRBAR Draw error bar
             [M,1]  x location in plot coordinates
             [M,2]  left end of error bar
             [M,3]  right end of error bar
             [M,4]  y location in plot coordinates
             [M,5]  bottom of error bar
             [M,6]  top of error bar
             [M,7]  line type (1-6)
             [M,8]  color (1-15)
             [M,9]  line thickness.

         Example: _perrbar = { 100 90 110 50 48 52 6 10 0 }


    _PLEGCTL Create Plot Legend, used in conjuntion with _PLEGSTR.
             [1]  X,Y coordinate units: 1=plot coord, 2=inches, 3=Tek pixels
             [2]  Legend text font size. 1 <= size <= 9.
             [3]  X coordinate of lower left corner of legend box
             [4]  Y coordinate of lower left corner of legend box

         Example: _plegctl = { 1 4 10 20 }


    _PLCTRL  Control main curve and frequency of symbols on main curves.
               < 0  draw symbols only every _plctrl points, no lines.
               = 0  draw line only, no symbols.
               > 0  draw line and symbols every _plctrl points.

         Examples:
             _plctrl =  -1;  @ symbol on all points, no curve drawn     @
             _plctrl = -10;  @ symbol every 10 points, no curve drawn   @
             _plctrl =   1;  @ symbol at all points, draw curves also   @
             _plctrl =  10;  @ symbol every 10 points, draw curves also @


    _PLINE   Draw lines, Circles, or Radii.
             [M,1]   Item type and coordinate system
                       1  Line in plot coordinates