git.hungrycats.org Git - xscreensaver/blob - hacks/glx/glschool.man

   1 .TH XScreenSaver 1 "" "X Version 11"
   2 .SH NAME
   3 glschool - a 3D schooling simulation
   4 .SH SYNOPSIS
   5 .B glschool
   6 [\-display \fIhost:display.screen\fP]
   7 [\-visual \fIvisual\fP]
   8 [\-window]
   9 [\-root]
  10 [\-wireframe]
  11 [\-fps]
  12 [\-delay \fInumber\fP]
  13 [\-nfish \fInumber\fP]
  14 [\-maxvel \fInumber\fP]
  15 [\-minvel \fInumber\fP]
  16 [\-acclimit \fInumber\fP]
  17 [\-avoidfact \fInumber\fP]
  18 [\-matchfact \fInumber\fP]
  19 [\-centerfact \fInumber\fP]
  20 [\-targetfact \fInumber\fP]
  21 [\-minradius \fInumber\fP]
  22 [\-momentum \fInumber\fP]
  23 [\-distexp \fInumber\fP]
  24 [\-goalchgf \fInumber\fP]
  25 [\-fog]
  26 [\-drawgoal]
  27 [\-drawbbox]
  28 .SH DESCRIPTION
  29 Uses Craig Reynolds Boids algorithm to simulate a 3d school of
  30 fish.  See <http://www.red3d.com/cwr/boids> for a description
  31 of the algorithm and the original paper.  This is a lightly modified
  32 version of the algorithm that supports goal attraction.
  33
  34 Many different behaviors are possible by tweaking the parameters.  No sanity checking is performed
  35 on the command line params, so if you want to use negative accelerations or minimum velocity that is
  36 larger than maximum velocity or that sort of thing, the simulation will try to digest it.
  37
  38 It looks best with the highest number of fish that will give you an FPS of > 25 or so.
  39
  40 .SH OPTIONS
  41 .TP 8
  42 .B \-visual \fIvisual\fP
  43 Specify which visual to use.  Legal values are the name of a visual class,
  44 or the id number (decimal or hex) of a specific visual.
  45 .TP 8
  46 .B \-window
  47 Draw on a newly-created window.  This is the default.
  48 .TP 8
  49 .B \-root
  50 Draw on the root window.
  51 .TP 8
  52 .B \-delay \fInumber\fP
  53 Per-frame delay, in microseconds.  Default: 20000 (0.020 seconds.).
  54 .TP 8
  55 .B \-wireframe | \-no-wireframe
  56 Render in wireframe instead of solid.
  57 .TP 8
  58 .B \-fps
  59 Display the current frame rate, CPU load, and polygon count.
  60 .TP 8
  61 .B \-fog | \-no-fog
  62  Whether to show foggy (cloudy) water.
  63 .TP 8
  64 .B \-drawgoal | \-no-drawgoal
  65  Whether to show the school's attraction goal.
  66 .TP 8
  67 .B \-drawbbox | \-no-drawbbox
  68  Whether to show the bounding box.
  69 .TP 8
  70 .B \-fog | \-no-fog
  71  Whether to show foggy (cloudy) water.
  72 .TP 8
  73 .B \-nfish \fInumber\fP
  74 Number of fish.  Defaults to 100
  75 .TP 8
  76 .B \-acclimit \fInumber\fP
  77 Acceleration limit.  Defaults to 8.0
  78 .TP 8
  79 .B \-minvel \fInumber\fP
  80 Minimum velocity.  Defaults to 1.0
  81 .TP 8
  82 .B \-maxvel \fInumber\fP
  83 Minimum velocity.  Defaults to 7.0
  84 .TP 8
  85 .B \-goalchgf \fInumber\fP
  86 Goal change frequency.  Defaults to 50 (frames)
  87 .TP 8
  88 .B \-avoidfact \fInumber\fP
  89 Avoidance acceleration factor.  Defaults to 1.5
  90 .TP 8
  91 .B \-matchfact \fInumber\fP
  92 Match avg velocity acceleration factor.  Defaults to 0.15
  93 .TP 8
  94 .B \-centerfact \fInumber\fP
  95 School centering acceleration factor.  Defaults to 0.1
  96 .TP 8
  97 .B \-targetfact \fInumber\fP
  98 Target attraction acceleration factor.  Defaults to 80
  99 .TP 8
 100 .B \-distexp \fInumber\fP
 101 Distance weighting exponent.  Defaults to 2.2
 102 .TP 8
 103 .B \-momentum \fInumber\fP
 104 Momentum.  Defaults to 0.9
 105 .SH ENVIRONMENT
 106 .PP
 107 .TP 8
 108 .B DISPLAY
 109 to get the default host and display number.
 110 .TP 8
 111 .B XENVIRONMENT
 112 to get the name of a resource file that overrides the global resources
 113 stored in the RESOURCE_MANAGER property.
 114 .SH SEE ALSO
 115 .BR X (1),
 116 .BR xscreensaver (1)
 117 .SH COPYRIGHT
 118 Copyright \(co 2005-2006 by David C. Lambert.  Permission to use, copy, modify,
 119 distribute, and sell this software and its documentation for any purpose is
 120 hereby granted without fee, provided that the above copyright notice appear
 121 in all copies and that both that copyright notice and this permission notice
 122 appear in supporting documentation.  No representations are made about the
 123 suitability of this software for any purpose.  It is provided "as is" without
 124 express or implied warranty.
 125 .SH AUTHOR
 126 David C. Lambert