1STITLE(3NCARG) NCAR GRAPHICS STITLE(3NCARG)
2
6 STITLE - Creates scrolled movie or video titles. It receives all input
7 through the argument list.
8
10 This routine is part of the Scrolled_title utility in NCAR Graphics.
11 To see the overview man page for this utility, type "man
12 scrolled_title".
13
15 CALL STITLE (CRDS,NCDS,IYST,IYND,TMST,TMMV,TMND,MTST)
16
18 #include <ncarg/ncargC.h>
19 void c_stitle (char *crds[], int ncds, int iyst,
21 int iynd, float tmst, float tmmv, float tmnd, int mtst)
22
24 CRDS (an input array, dimensioned NCDS, of type CHARACTER*n,
25 where "n" is greater than or equal to 21) is the "card
26 input buffer". This array must be filled, prior to calling
27 STITLE, either by internal manipulations or by reading n-
28 character "cards". Each element of the array CRDS
29 represents one line on the scroll (or, sometimes, a
30 continuation of a previous line) and contains the
31 following:
32 · Columns 1-5: MX, the X coordinate of the line of
34 text on the scroll. This is normally a value between
35 1 and 1024, inclusive. Exactly how the line of text
36 is positioned relative to the specified X coordinate
37 depends on the value of ICNT (in columns 14-15).
38 If the value -9999 is used for MX, it indicates a
40 continuation line: characters from columns 21
41 through "n" are just appended to the characters from
42 the previous card to form the line of text. Any
43 number of continuation cards may be used, but the
44 total number of characters in a line of text must
45 not be greater than 512.
46 Trailing blanks are omitted from each card,
48 including those that are followed by a continuation
49 card; thus, if there are to be blanks between the
50 characters from one card and the characters from a
51 continuation card, those blanks must be placed in
52 columns 21 and following of the continuation card.
53 On a continuation card, columns 6-20 are ignored.
55 · Columns 6-10: MY, the Y coordinate of the line of
57 text on the scroll. MY may range from -9999 to
58 99999.
59 · Columns 11-13: ICLR, the index of the color to be
61 used for the line of text. If this field is blank,
62 the default foreground color specified by the value
63 of the internal parameter ´FGC´ will be used.
64 · Columns 14-15: ICNT, the centering option:
66 0 means "start the text at MX".
68 1 means "center the text about MX".
70 2 means "end the text at MX".
72 · Columns 16-20: SIZE, the desired size of the
74 characters to be used in writing the line. SIZE is
75 given as a multiplier of a default height specified
76 by the value of the internal parameter ´PSZ´, the
77 default value of which is 21 (out of 1024). Values
78 of SIZE from .75 to 2.5 are recommended.
79 · Columns 21-n: Text for this line (or for
81 continuation of a line when MX = -9999).
82 NCDS (an input expression of type INTEGER) is the dimension of
84 the array CRDS (i.e., the number of card images in it).
85 IYST (an input expression of type INTEGER) is the Y coordinate
87 that will be at the center of the screen when the text is
88 first displayed.
89 IYND (an input expression of type INTEGER) is the Y coordinate
91 that will be at the center of the screen when the text is
92 last displayed.
93 TMST (an input expression of type REAL) is the time in seconds
95 that the scroll will be stationary at IYST. One second is
96 recommended.
97 TMMV (an input expression of type REAL) is the time to move the
99 scroll from IYST to IYND. This should be the time required
100 to read the text aloud at slow to normal speed.
101 TMND (an input expression of type REAL) is the time that the
103 scroll will be stationary at IYND. One second is
104 recommended.
105 MTST (an input expression of type INTEGER) is a switch to
107 indicate whether this is a "real" run or a "practice" run.
108 0 means "real run".
110 1 means "practice run".
112 During real runs, frames are created for the fade-in
114 sequence (if the user has turned on fade-in by setting the
115 internal parameter ´FIN´ non-zero), the stationary sequence
116 at the start (if TMST is non-zero), the scrolling time (if
117 TMMV is non-zero), the stationary sequence at the end (if
118 TMND is non-zero), and the fade-out sequence (if the user
119 has turned on fade-out by setting the internal parameter
120 ´FOU´ non-zero).
121 During practice runs, only selected frames are created: a
123 frame for the fade-in sequence (if fade-in is turned on), a
124 frame for the stationary time at the start, a set of frames
125 representing the scrolling sequence, a frame for the
126 stationary time at the end, and a frame for the fade-out
127 sequence (if fade-out is turned on). Each has a legend
128 indicating either for how many seconds the frame will be
129 shown or, if it is part of a scroll sequence, how many
130 seconds into the scroll time it occurs; during real runs,
131 these legends are omitted, of course.
132 Fade-in and fade-out are also affected by the values of the
134 internal parameters ´BGF´, which selects the type of fade-
135 in/fade-out to be used for the background color, and ´FGF´,
136 which serves the same function for the foreground color.
137 (The older parameters ´SBK´ and ´SFG´ may still be
138 referenced, but their use is no longer recommended; setting
139 ´SBK´ has the effect of giving ´BGF´ an appropriate value
140 and setting ´SFG´ has the effect of giving ´FGF´ an
141 apprpriate value.)
142
144 The C-binding argument descriptions are the same as the FORTRAN
145 argument descriptions.
146
148 STITLE takes input through its argument list and generates graphic
149 output that moves a body of text up through the viewing window. This is
150 done by outputting the appropriate number of frames required to
151 generate a movie sequence of a duration specified by you.
152 At each frame STITLE skips plotting lines of text that are completely
154 outside of the viewing window and clips those that are partially
155 outside the window.
156
158 Use the ncargex command to see the following relevant examples:
159 fslfont, slex01, slex02, tstitl.
160
162 To use STITLE or c_stitle, load the NCAR Graphics libraries ncarg,
163 ncarg_gks, ncarg_c, and ncarg_c, preferably in that order.
164
166 See the scrolled_title man page for a description of all Scrolled_title
167 error messages and/or informational messages.
168
170 Online: ftitle, scrolled_title, scrolled_title_params, slgeti, slgetr,
171 slogap, slrset, slseti, slsetr, ncarg_cbind.
172 Hardcopy: NCAR Graphics Fundamentals, UNIX Version; User's Guide for
174 NCAR GKS-0A Graphics
175
177 Copyright (C) 1987-2007
178 University Corporation for Atmospheric Research
179 This documentation is free software; you can redistribute it and/or
181 modify it under the terms of the GNU General Public License as
182 published by the Free Software Foundation; either version 2 of the
183 License, or (at your option) any later version.
184 This software is distributed in the hope that it will be useful, but
186 WITHOUT ANY WARRANTY; without even the implied warranty of
187 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
188 General Public License for more details.
189 You should have received a copy of the GNU General Public License along
191 with this software; if not, write to the Free Software Foundation,
192 Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
193UNIX July 1995 STITLE(3NCARG)