1STUMSL(3NCARG)                   NCAR GRAPHICS                  STUMSL(3NCARG)
2
3
4

NAME

6       STUMSL - This routine is the user-definable external subroutine used to
7       draw masked streamlines. The default version of the routine draws any
8       polyline all of whose area identifiers are greater than or equal to
9       zero.
10

SYNOPSIS

12       CALL STUMSL (XCS,YCS,NCS,IAI,IAG,NAI)
13

DESCRIPTION

15       XCS         (REAL array, assumed size NCS, input): Array of X
16                   coordinates of the points defining the polyline with the
17                   given set of area identifiers.
18
19       YCS         (REAL array, assumed size NCS, input): Array of Y
20                   coordinates of the points defining the polyline with the
21                   given set of area identifiers.
22
23       NCS         (INTEGER, input): Number of points; assumed size of the X
24                   and Y coordinate arrays, XCS and YCS.
25
26       IAI         (INTEGER array, assumed size NAI, input): Array of area
27                   identifier values. Each value represents the area
28                   identifier with respect to the area group in the area group
29                   array with the same array index.
30
31       IAG         (INTEGER array, assumed size NAI, input): Array of area-
32                   identifier groups.
33
34       NAI         (INTEGER, input): Number of area identifier groups. The
35                   current version of Streamlines supports up to 64 area
36                   groups.
37

USAGE

39       ´STUMSL´ is the name given to the default version of the masked
40       streamline drawing routine, and it is also the name given to the
41       argument through which the external subroutine is passed to STREAM.
42       However, you may choose any acceptable FORTRAN identifier as the name
43       of a user-defined version of the routine. The substitute routine must
44       have an argument list equivalent to the default version of STUMSL.
45       Also, whether or not the default version is used, the subroutine that
46       calls STREAM should contain an external declaration of the routine,
47       such as:
48
49                 EXTERNAL STUMSL
50
51       If the MSK parameter is greater than 0, signifying that masking is to
52       be performed, Streamlines sends one or more sets of X and Y polyline
53       coordinate arrays to the area masking routine, ARDRLN, for each
54       streamline. ARDRLN subdivides the polyline into pieces such that each
55       smaller polyline has a single area identifier with respect to each area
56       identifier group, then makes a call to STUMSL for each polyline piece.
57       While the default version of STUMSL only checks to see that none of the
58       area identifiers are negative, a user-defined version could perform
59       more complicated decision processing based on knowledge of the meaning
60       of specific area identifier groups and/or area identifier values. Note
61       that, before invoking STUMSL, ARDRLN modifies the user coordinate space
62       by making the following calls:
63
64               CALL GETSET(VPL,VPR,VPB,VPT,WDL,WDR,WDB,WDT,LLG) CALL
65               SET(VPL,VPR,VPB,VPT,VPL,VPR,VPB,VPT,1)
66
67       These calls temporarily turn the user to NDC mapping into an identity,
68       allowing the user to call any of the routines, CURVE, CURVED, or the
69       GKS routine GPL, to render the polygon piece without worrying about a
70       possible non-identity mapping between user and world coordinates.
71
72       The current version of Streamlines supports masked drawing with up to
73       64 area groups. Streamlines will exit with an error message if an area
74       map with more than 64 groups is passed to it.
75

ACCESS

77       To use STUMSL, load the NCAR Graphics libraries ncarg, ncarg_gks, and
78       ncarg_c, preferably in that order.
79

SEE ALSO

81       Online: stgetc, stgeti, stgetr, stinit, stream, streamlines,
82       streamlines_params, strset, stsetc, stseti, stsetr, stuixy, stumta,
83       stumxy, ncarg_cbind.
84
85       Hardcopy: NCAR Graphics Fundamentals, UNIX Version
86

88       Copyright (C) 1987-2007
89       University Corporation for Atmospheric Research
90
91       This documentation is free software; you can redistribute it and/or
92       modify it under the terms of the GNU General Public License as
93       published by the Free Software Foundation; either version 2 of the
94       License, or (at your option) any later version.
95
96       This software is distributed in the hope that it will be useful, but
97       WITHOUT ANY WARRANTY; without even the implied warranty of
98       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
99       General Public License for more details.
100
101       You should have received a copy of the GNU General Public License along
102       with this software; if not, write to the Free Software Foundation,
103       Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
104
105
106
107UNIX                              April 1993                    STUMSL(3NCARG)
Impressum