1FTITLE(3NCARG) NCAR GRAPHICS FTITLE(3NCARG)
2
6 FTITLE - Used for unscrolled movie or video titles. It reads, from
7 standard input, the information necessary to define the desired title
8 frames, and then calls STITLE to create those frames.
9
11 CALL FTITLE (MTST)
12
14 #include <ncarg/ncargC.h>
15 void c_ftitle (int mtst)
17
19 MTST (an input expression of type INTEGER) is a switch
20 indicating whether this is a "real" run or a "practice"
21 run:
22 0 means "real run".
24 1 means "practice run".
26 During real runs, each title frame is repeated as many
28 times as necessary to display it for a user-specified time
29 period (at ´NFS´ frames per second). Blank frames are
30 placed before the first title frame (´TM1´ seconds worth of
31 them), between consecutive title frames (´TM2´ seconds
32 worth of them), and after the last title frame (´TM2´ +
33 ´TM3´ seconds worth of them). Blank frames are to allow
34 for splicing.
35 If the user has turned on fade-in (by setting the internal
37 parameter ´FIN´ non-zero), and/or fade-out (by setting the
38 internal parameter ´FOU´ non-zero), the required fade-in
39 and fade-out frames will be generated, as well.
40 During practice runs, each title frame will occur from one
42 to three times (once for fade-in, once for the stationary
43 holding time, and once for fade-out); each of these frames
44 will have a legend indicating how many seconds the frame
45 represents in a real run. Each sequence of blank frames
46 will be replaced by a single frame with a message
47 indicating how many seconds worth of blank frames it
48 represents.
49
51 The C-binding argument description is the same as the FORTRAN argument
52 description.
53
55 FTITLE reads data from the unit specified by the internal parameter
56 ´ICU´, which has the default value 5, to specify standard input; this
57 parameter can be given a different value to specify that another unit
58 should be read instead.
59 The input data are read in groups. Each group represents one title
61 frame. There can be any number of groups. FTITLE keeps processing
62 groups until a group with NCDS = 0 is read or an end-of-file is
63 encountered. A group consists of the following:
64 · A header line from which variables NCDS, TIME, and SIZE are read,
66 using the FORTRAN format "(I5,2F5.1)".
67 NCDS is the number of text lines that follow. If NCDS = 0, FTITLE
69 quits (returns to the calling routine without doing anything else).
70 TIME is the time, in seconds, that the title frame should be
72 displayed (not including fade-in and fade-out, if any).
73 SIZE is the desired character size, given as a multiplier of the
75 default height specified by the value of the internal parameter
76 ´PSZ´, the default value of which is 21 (out of 1023). Values of
77 SIZE from .75 to 2.5 are recommended.
78 · Text lines, each containing one line of the title frame. PLOTCHAR
80 function codes may be used as specified in the documentation for
81 that package. Characters should not appear beyond column 80.
82 The internal parameters 'ALN', 'BGB', 'BGC', 'BGF', 'BGG', 'BGR',
84 'FGB', 'FGC', 'FGF', 'FGG', 'FGR', 'FIN', 'FOU', 'GSZ', 'ICO', 'ICU',
85 'LOG', 'LX1', 'LX2', 'LY1', 'LY2', 'MAP', 'NFS', 'NXE', 'NXS', 'ORV',
86 'PSZ', 'SBK', 'SFG', 'TM1', 'TM2', 'TM3', 'VPB', 'VPL', 'VPR', 'VPT',
87 and 'WID' all affect the behavior of FTITLE in one way or another.
88 Some of these have been mentioned above; all are described in the "man"
89 page for "scrolled_title_params".
90 Example: Suppose the input file contains the following three lines
92 3 3. 1.5
94 A
95 Frame
96 of Titles
97 The resulting title frame has three lines of text. It is displayed for
99 three seconds. Characters have a size of 1.5 times the default
100 character size.
101 FTITLE allows a maximum of 80 characters per line of text including
103 Plotchar function codes. No more than 120 lines of text can be
104 displayed on a single frame. Titles are centered horizontally unless
105 you have changed the value of the internal parameter 'ICO'. Vertical
106 spacing is automatically determined using the current value of the
107 internal parameter 'GSZ'.
108 For more detailed control of titles, use the routine STITLE, which can
110 be used to generate either fixed or scrolled titles.
111
113 Use the ncargex command to see the following relevant example: slex02.
114
116 To use FTITLE or c_ftitle, load the NCAR Graphics libraries ncarg,
117 ncarg_gks, ncarg_c, and ncarg_c, preferably in that order.
118
120 See the scrolled_title man page for a description of all Scrolled_title
121 error messages and/or informational messages.
122
124 Online: plotchar, scrolled_title, scrolled_title_params, slgeti,
125 slgetr, slogap, slrset, slseti, slsetr, stitle, ncarg_cbind.
126 Hardcopy: NCAR Graphics Fundamentals, UNIX Version; User's Guide for
128 NCAR GKS-0A Graphics
129
131 Copyright (C) 1987-2007
132 University Corporation for Atmospheric Research
133 This documentation is free software; you can redistribute it and/or
135 modify it under the terms of the GNU General Public License as
136 published by the Free Software Foundation; either version 2 of the
137 License, or (at your option) any later version.
138 This software is distributed in the hope that it will be useful, but
140 WITHOUT ANY WARRANTY; without even the implied warranty of
141 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
142 General Public License for more details.
143 You should have received a copy of the GNU General Public License along
145 with this software; if not, write to the Free Software Foundation,
146 Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
147UNIX July 1995 FTITLE(3NCARG)