1glschool(6x)                  XScreenSaver manual                 glschool(6x)
2
3
4

NAME

6       glschool - a 3D schooling simulation
7

SYNOPSIS

9       glschool  [-display  host:display.screen]  [-visual  visual]  [-window]
10       [-root] [-wireframe] [-fps] [-delay number]  [-nfish  number]  [-maxvel
11       number]   [-minvel   number]  [-acclimit  number]  [-avoidfact  number]
12       [-matchfact number] [-centerfact number] [-targetfact number]  [-minra‐
13       dius  number]  [-momentum  number] [-distexp number] [-goalchgf number]
14       [-fog] [-drawgoal] [-drawbbox]
15

DESCRIPTION

17       Uses the Craig Reynolds Boids algorithm to  simulate  a  3D  school  of
18       fish.   This  is  a lightly modified version of the algorithm that sup‐
19       ports goal attraction.
20
21       Many different behaviors are possible by tweaking the  parameters.   No
22       sanity checking is performed on the command line params, so if you want
23       to use negative accelerations or minimum velocity that is  larger  than
24       maximum  velocity or that sort of thing, the simulation will try to di‐
25       gest it.
26
27       It looks best with the highest number of fish that will give you an FPS
28       of > 25 or so.
29

OPTIONS

31       -visual visual
32               Specify  which  visual  to use.  Legal values are the name of a
33               visual class, or the id number (decimal or hex) of  a  specific
34               visual.
35
36       -window Draw on a newly-created window.  This is the default.
37
38       -root   Draw on the root window.
39
40       -delay number
41               Per-frame  delay,  in microseconds.  Default: 20000 (0.020 sec‐
42               onds.).
43
44       -wireframe | -no-wireframe
45               Render in wireframe instead of solid.
46
47       -fps    Display the current frame rate, CPU load, and polygon count.
48
49       -fog | -no-fog
50                Whether to show foggy (cloudy) water.
51
52       -drawgoal | -no-drawgoal
53                Whether to show the school's attraction goal.
54
55       -drawbbox | -no-drawbbox
56                Whether to show the bounding box.
57
58       -fog | -no-fog
59                Whether to show foggy (cloudy) water.
60
61       -nfish number
62               Number of fish.  Defaults to 100
63
64       -acclimit number
65               Acceleration limit.  Defaults to 8.0
66
67       -minvel number
68               Minimum velocity.  Defaults to 1.0
69
70       -maxvel number
71               Minimum velocity.  Defaults to 7.0
72
73       -goalchgf number
74               Goal change frequency.  Defaults to 50 (frames)
75
76       -avoidfact number
77               Avoidance acceleration factor.  Defaults to 1.5
78
79       -matchfact number
80               Match avg velocity acceleration factor.  Defaults to 0.15
81
82       -centerfact number
83               School centering acceleration factor.  Defaults to 0.1
84
85       -targetfact number
86               Target attraction acceleration factor.  Defaults to 80
87
88       -distexp number
89               Distance weighting exponent.  Defaults to 2.2
90
91       -momentum number
92               Momentum.  Defaults to 0.9
93

ENVIRONMENT

95       DISPLAY to get the default host and display number.
96
97       XENVIRONMENT
98               to get the name of a resource file that  overrides  the  global
99               resources stored in the RESOURCE_MANAGER property.
100

SEE ALSO

102       X(1), xscreensaver(1),
103       https://www.red3d.com/cwr/boids
104

106       Copyright  ©  2005-2006  by David C. Lambert.  Permission to use, copy,
107       modify, distribute, and sell this software and  its  documentation  for
108       any  purpose  is  hereby  granted  without fee, provided that the above
109       copyright notice appear in all copies and that both that copyright  no‐
110       tice and this permission notice appear in supporting documentation.  No
111       representations are made about the suitability of this software for any
112       purpose.  It is provided "as is" without express or implied warranty.
113

AUTHOR

115       David C. Lambert
116
117
118
119X Version 11               6.04-1.fc36 (06-Jun-2022)              glschool(6x)
Impressum