1Plotchar_params(3NCARG) NCAR GRAPHICS Plotchar_params(3NCARG)
2
6 Plotchar_params - This document briefly describes all the internal
7 parameters of Plotchar.
8
10 The following shows all of the internal parameters that affect the
11 behavior of PCHIQU. Each entry includes the name of a parameter, its
12 FORTRAN type, its default value, and a short description of the
13 parameter.
14 Internal Parameters of PCHIQU
16 ´AS´ - Real - 0.
18 When this parameter is nonzero, it forces extra space
19 between characters. A negative value is interpreted in
20 digitization units. A positive value is interpreted as a
21 multiplier of the nominal character width specified by
22 the argument SIZE (and, in the case of the PWRITX
23 database, one of ´PW´, ´IW´, or ´CW´, whichever is
24 appropriate).
25 ´BC´ - Integer array - all -1's
27 An array of three "box colors". Element 1 applies to the
28 outline of the box, element 2 to fill of the box, and
29 element 3 to fill of the box shadow. The value "-1" means
30 "unspecified"; and a value greater than or equal to 0
31 selects a particular color index. To access element 1,
32 use the parameter name ´BC(1)´; to access element 2, use
33 ´BC(2)´; etc. The name ´BC´ by itself refers to element
34 1.
35 ´BF´ - Integer - 0
37 When this parameter is nonzero, it requests a box around
38 each string of characters written by PCHIQU. The value is
39 interpreted as a three-bit flag: Add 1 to the value to
40 have the outline of the box drawn, 2 to have the box
41 filled, and 4 to have its shadow drawn. (1 implies "draw
42 outline", 2 implies "fill box", 3 implies "fill box and
43 draw outline", 4 implies "fill shadow", 5 implies "fill
44 shadow and draw outline", 6 implies "fill shadow and fill
45 box", and 7 implies "fill shadow, fill box, and draw
46 outline".)
47 ´BL´ - Real - 0.
49 When this parameter is greater than zero, it specifies
50 the line width to be used while drawing the box around a
51 character string. A value less than or equal to zero
52 means "unspecified".
53 ´BM´ - Real - .15
55 The width of box margins (the space between the
56 characters and the outline of the box), stated as a
57 fraction of principal character height.
58 ´BX´ - Real - -.05
60 The X offset for box shadows, stated as a fraction of
61 principal character height. This is actually an offset in
62 the direction ANGD.
63 ´BY´ - Real - -.05
65 The Y offset for box shadows, stated as a fraction of
66 principal character height. This is actually an offset in
67 the direction ANGD+90.
68 ´CC´ - Integer array - all -1´s
70 An array of color indices. Element 0 specifies the
71 principal character color and elements 1 through 16
72 specify special colors to be used for certain characters.
73 The value -1 means "unspecified"; a value greater than or
74 equal to zero is a particular color index to be used. The
75 routine PCDLSC may be called to define a standard default
76 set of colors for elements 1 through 16. To access
77 element 0, use the parameter name ´CC(0)´; to access
78 element 1, use ´CC(1)´; etc. The name ´CC´ by itself
79 refers to element 0.
80 ´CD´ - Integer - 0
82 The value 0 selects the complex dataset from the PWRITX
83 database; 1 selects the duplex dataset.
84 ´CE´ - Integer - 0
86 The value 0 selects centering of strings as specified by
87 the argument CNTR and 1 selects exact centering, using
88 text-extent quantities. This works as desired only when
89 ´QU´ is zero.
90 ´CH´ - Real - 9.
92 Digitized cartographic height.
93 ´CL´ - Real - 0.
95 If greater than zero, this is the desired principal line
96 width to be used while drawing characters. A value less
97 than or equal to zero says that line width is
98 unspecified.
99 ´CS´ - Real - 0.
101 Constant-spacing flag. The high-quality character sets
102 normally have variable spacing when written "across" the
103 frame. When this parameter is set nonzero, it forces the
104 centers of the characters to be spaced a constant
105 distance apart. If a negative value is used, its absolute
106 value specifies the spacing in digitization units. If a
107 positive value is used, it is interpreted as a multiplier
108 of the nominal character width specified by the argument
109 SIZE (and, in the case of the PWRITX database, one of
110 ´PW´, ´IW´, or ´CW´, whichever is appropriate). Medium-
111 and low-quality characters are not affected by this
112 parameter.
113 ´CV´ - Real - 14.
115 Digitized cartographic vertical spacing.
116 ´CW´ - Real - 8.
118 Digitized cartographic width.
119 ´DB´ - Real - none
121 Output only - distance from (XPOS,YPOS) to the bottom
122 edge of the text-extent box for the last string drawn, in
123 the fractional system.
124 ´DL´ - Real - none
126 Output only - distance from (XPOS,YPOS) to the left edge
127 of the text-extent box for the last string drawn, in the
128 fractional system.
129 ´DO´ - Integer - 1
131 The drawing order for the characters. If the value is
132 positive, characters are drawn in the order in which they
133 appear in the input character string; otherwise, they are
134 drawn in the opposite order. If the absolute value is a
135 1, all shadows are drawn, followed by all character
136 bodies, followed by all outlines. If the absolute value
137 is 2 or greater, each character is drawn completely
138 (including its shadow, its body, and its outline) before
139 moving on to the next character; this can be used,
140 together with ´SS´, to "stack" characters so that they
141 apparently overlap one another.
142 ´DR´ - Real - none
144 Output only - distance from (XPOS,YPOS) to the right edge
145 of the text-extent box for the last string drawn, in the
146 fractional system.
147 ´DT´ - Real - none
149 Output only - distance from (XPOS,YPOS) to the top edge
150 of the text-extent box for the last string drawn, in the
151 fractional system.
152 ´FB´ - Real - .00003
154 Fidelity parameter for Bezier curves used to draw the
155 filled fonts. The value specifies how close the
156 interpolated curve should be to the actual Bezier curve
157 and is specified as a fraction of the height of the
158 plotter frame.
159 ´FC´ - Character - ´:' (a colon)
161 Function-code character.
162 ´FN´ - Character or Integer - 0
164 Font number. The default value, 0, implies the use of the
165 PWRITX database. Use a positive value "n" to force the
166 use of fontcap database "n". Use a character-string font
167 name, as shown in table 2 in the programmer document for
168 PLOTCHAR, in a call to PCSETC; a call to PCGETC will
169 return one of these font names. The list of font names
170 is also reproduced later in this man page.
171 ´IH´ - Real - 13.
173 Digitized indexical height.
174 ´IS´ - Real - 7.
176 Offset to be used when subscripting or superscripting a
177 character of indexical size, in digitization units.
178 ´IV´ - Real - 20.
180 Digitized indexical vertical spacing.
181 ´IW´ - Real - 12.
183 Digitized indexical width.
184 ´MA´ - Integer - 0
186 The mapping flag. The value zero says that no mapping is
187 to occur; nonzero values say that PCMPXY is to be called
188 and select particular mappings.
189 ´OC´ - Integer - 1
191 The outline color specifier. The value "-1" says that
192 outline color is unspecified; a value of 0 or greater
193 selects a particular color index.
194 ´OF´ - Integer - 0
196 The outline flag. The value 0 says that outlines are not
197 to be drawn; a nonzero value says that outlines are to be
198 drawn.
199 ´OL´ - Real - 0.
201 The outline line width. A value less than or equal to
202 zero says that outline width is unspecified; a value
203 greater than zero is the desired line width, as a
204 fraction of "normal".
205 ´OR´ - Real - 0.
207 The out-of-range flag. The value 0. says that no values
208 returned by the routine PCMPXY are "out of range"; any
209 other value is the value to be used as an out-of-range
210 signal, indicating that a point to be mapped is invisible
211 under the current mapping.
212 ´PH´ - Real - 21.
214 Digitized principal height.
215 ´PS´ - Real - 10.
217 Offset to be used when subscripting or superscripting a
218 character of principal size, in digitization units.
219 ´PV´ - Real - 32.
221 Digitized principal vertical spacing.
222 ´PW´ - Real - 16.
224 Digitized principal width.
225 ´QU´ - Integer - 0
227 Quality flag. The value 0 means to use the high-quality
228 characters, 1 means to use the medium-quality characters
229 of PCMEQU, and 2 means to use the "low-quality"
230 characters of PCLOQU.
231 ´SA´ - Real - .88888888...
233 A multiplier for the sizes of all characters written
234 directly by PCHIQU, introduced in version 3.2 of NCAR
235 Graphics in order to make characters written by PCHIQU
236 the same size as those written by PCMEQU. The default
237 value is (16/21)(7/6). Those users who want PCHIQU to
238 produce the same size characters that it did before may
239 set ´SA´ to 1., but this is not recommended.
240 ´SC´ - Integer - 0
242 The shadow color specifier. The value "-1" says that
243 shadow color is unspecified; a value of 0 or greater
244 selects a particular color index.
245 ´SF´ - Integer - 0
247 The shadow flag. The value 0 says that shadows are not to
248 be drawn; a nonzero value says that shadows are to be
249 drawn.
250 ´SL´ - Real - 0.
252 The shadow line width. A value less than or equal to zero
253 says that shadow line width is unspecified; a value
254 greater than zero is the desired line width, as a
255 fraction of "normal".
256 ´SS´ - Real - 0.
258 Subtract-space flag. When this parameter is nonzero, it
259 reduces the space between characters. If a negative value
260 is used, it is interpreted in digitization units. If a
261 positive value is used, it is interpreted as a multiplier
262 of the nominal character width specified by the argument
263 SIZE (and, in the case of the PWRITX database, one of
264 ´PW´, ´IW´, or ´CW´, whichever is appropriate).
265 ´SX´ - Real - -.05
267 The X offset for character shadows, stated as a fraction
268 of principal character height. This is actually an offset
269 in the direction ANGD.
270 ´SY´ - Real - -.05
272 The Y offset for character shadows, stated as a fraction
273 of principal character height. This is actually an offset
274 in the direction ANGD+90.
275 ´TE´ - Integer - 0
277 The text-extent computation flag. Zero means do not
278 compute text-extent quantities, nonzero means do compute
279 them. If ´TE´ is nonzero and the value of the argument
280 ANGD, in a call to PCHIQU, is exactly 360. instead of 0.,
281 no characters are drawn, but the text-extent quantities
282 are still computed. This provides a way to get these
283 quantities prior to actually drawing a particular string.
284 ´UN´ - Integer - 3
286 This used to be the FORTRAN logical unit number to be
287 used in reading the data defining the various character
288 sets. It is no longer used for anything.
289 ´XB´ - Real - 0.
291 For retrieval only. The X position at the beginning of
292 the last string written by PCHIQU, in the fractional
293 system.
294 ´XC´ - Real - 0.
296 For retrieval only. The X position at the center of the
297 last character written by PCHIQU, in the fractional
298 system.
299 ´XE´ - Real - 0.
301 For retrieval only. The X position at the end of the last
302 string written by PCHIQU, in the fractional system.
303 ´YB´ - Real - 0.
305 For retrieval only. The Y position at the beginning of
306 the last string written by PCHIQU, in the fractional
307 system.
308 ´YC´ - Real - 0.
310 For retrieval only. The Y position at the center of the
311 last character written by PCHIQU, in the fractional
312 system.
313 ´YE´ - Real - 0.
315 For retrieval only. The Y position at the end of the last
316 string written by PCHIQU, in the fractional system.
317 Internal Parameters of PCMEQU
320 The internal parameter ´HW´ specifies the desired ratio of the
322 character height (the height of a capital) to the character
323 width (excluding white space). The default value of ´HW´ is
324 1.75, reflecting the fact that the capitals are digitized to be
325 7 units high and 4 units wide and 1.75 is therefore their
326 natural aspect ratio. Negative values of ´HW´ may be used. The
327 absolute value will be used as the ratio, but, in addition,
328 PCHIQU will be prohibited from changing ´HW´ (which it otherwise
329 does when the quality flag ´QU´ is set to 1).
330 PCMEQU reacts properly to nonzero values of ´MA´ and ´OR´, which
332 are used to request mapping of characters through the routine
333 PCMPXY, as described for PCHIQU, above. Characters that are
334 partly visible and partly invisible are clipped at the
335 visible/invisible boundary.
336 Internal Parameters of PCLOQU
339 PCLOQU reacts to nonzero values of ´MA´ and ´OR´, which are used
341 to request mapping of characters through the routine PCMPXY, as
342 described for PCHIQU, above. However, it doesn´t react in quite
343 the same way: Mapping will affect the position of the string
344 written by a call to PCLOQU, the angle at which it is written,
345 and the size of the characters used. The shape of the characters
346 will not be affected (and cannot be, since the characters are
347 drawn by calling the GKS routine GTX instead of GPL). If the
348 point (XPOS,YPOS) is visible under the mapping, the whole string
349 is considered to be visible; otherwise, the whole string is
350 considered to be invisible. The results can be pretty crude; for
351 that reason, mapping is not recommended.
352 A List of Font Names for Use in Calls to PCSETC That Set ´FN´
355 0 'PWRITX DATABASE '
357 1 'DEFAULT '
358 2 'CARTOGRAPHIC_ROMAN'
359 3 'CARTOGRAPHIC_GREEK'
360 4 'SIMPLEX_ROMAN '
361 5 'SIMPLEX_GREEK '
362 6 'SIMPLEX_SCRIPT '
363 7 'COMPLEX_ROMAN '
364 8 'COMPLEX_GREEK '
365 9 'COMPLEX_SCRIPT '
366 10 'COMPLEX_ITALIC '
367 11 'COMPLEX_CYRILLIC '
368 12 'DUPLEX_ROMAN '
369 13 'TRIPLEX_ROMAN '
370 14 'TRIPLEX_ITALIC '
371 15 'GOTHIC_GERMAN '
372 16 'GOTHIC_ENGLISH '
373 17 'GOTHIC_ITALIAN '
374 18 'MATH_SYMBOLS '
375 19 'SYMBOL_SET1 '
376 20 'SYMBOL_SET2 '
377 21 'HELVETICA '
378 22 'HELVETICA-BOLD '
379 25 'TIMES-ROMAN '
380 26 'TIMES-BOLD '
381 29 'COURIER '
382 30 'COURIER-BOLD '
383 33 'GREEK '
384 34 'MATH-SYMBOLS '
385 35 'TEXT-SYMBOLS '
386 36 'WEATHER1 '
387 37 'WEATHER2 '
388 121 'O_HELVETICA '
389 122 'O_HELVETICA-BOLD '
390 125 'O_TIMES-ROMAN '
391 126 'O_TIMES-BOLD '
392 129 'O_COURIER '
393 130 'O_COURIER-BOLD '
394 133 'O_GREEK '
395 134 'O_MATH-SYMBOLS '
396 135 'O_TEXT-SYMBOLS '
397 136 'O_WEATHER1 '
398 137 'O_WEATHER2 '
399
401 Online: pcdlsc, pcgetc, pcgeti, pcgetr, pcpnwi, pcrset, pcsetc, pcseti,
402 pcsetr, ncarg_cbind.
403 Hardcopy: NCAR Graphics Fundamentals, UNIX Version
405
407 Copyright (C) 1987-2007
408 University Corporation for Atmospheric Research
409 This documentation is free software; you can redistribute it and/or
411 modify it under the terms of the GNU General Public License as
412 published by the Free Software Foundation; either version 2 of the
413 License, or (at your option) any later version.
414 This software is distributed in the hope that it will be useful, but
416 WITHOUT ANY WARRANTY; without even the implied warranty of
417 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
418 General Public License for more details.
419 You should have received a copy of the GNU General Public License along
421 with this software; if not, write to the Free Software Foundation,
422 Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
423UNIX March 1993 Plotchar_params(3NCARG)