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

   1 .TH XScreenSaver 1 "" "X Version 11"
   2 .SH NAME
   3 hypertorus - Draws a hypertorus that rotates in 4d
   4 .SH SYNOPSIS
   5 .B hypertorus
   6 [\-display \fIhost:display.screen\fP]
   7 [\-install]
   8 [\-visual \fIvisual\fP]
   9 [\-window]
  10 [\-root]
  11 [\-delay \fIusecs\fP]
  12 [\-fps]
  13 [\-mesh]
  14 [\-surface]
  15 [\-transparent]
  16 [\-solid]
  17 [\-bands]
  18 [\-twosided]
  19 [\-colorwheel]
  20 [\-perspective-3d]
  21 [\-orthographic-3d]
  22 [\-perspective-4d]
  23 [\-orthographic-4d]
  24 [\-speed-wx \fIfloat\fP]
  25 [\-speed-wy \fIfloat\fP]
  26 [\-speed-wz \fIfloat\fP]
  27 [\-speed-xy \fIfloat\fP]
  28 [\-speed-xz \fIfloat\fP]
  29 [\-speed-yz \fIfloat\fP]
  30 .SH DESCRIPTION
  31 The \fIhypertorus\fP program shows the Clifford torus as it rotates in
  32 4d.  The Clifford torus is a torus lies on the "surface" of the
  33 hypersphere in 4d.  The program projects the 4d torus to 3d using
  34 either a perspective or an orthographic projection.  Of the two
  35 alternatives, the perspective projection looks much more appealing.
  36 In orthographic projections the torus degenerates into a doubly
  37 covered cylinder for some angles.  The projected 3d torus can then be
  38 projected to the screen either perspectively or orthographically.
  39 There are three display modes for the torus: mesh (wireframe), solid,
  40 or transparent.  Furthermore, the appearance of the torus can be as a
  41 solid object or as a set of see-through bands.  Finally, the colors
  42 with with the torus is drawn can be set to either two-sided or to a
  43 color wheel.  In the first case, the torus is drawn with red on the
  44 outside and green on the inside.  This mode enables you to see that
  45 the torus turns inside-out as it rotates in 4d.  The second mode draws
  46 the torus with a fully saturated color wheel.  This gives a very nice
  47 effect when combined with the see-through bands mode.  The rotation
  48 speed for each of the six planes around which the torus rotates can be
  49 chosen.  This program is very much inspired by Thomas Banchoff's book
  50 "Beyond the Third Dimension: Geometry, Computer Graphics, and Higher
  51 Dimensions", Scientific American Library, 1990.
  52 .SH OPTIONS
  53 .I hypertorus
  54 accepts the following options:
  55 .TP 8
  56 .B \-window
  57 Draw on a newly-created window.  This is the default.
  58 .TP 8
  59 .B \-root
  60 Draw on the root window.
  61 .TP 8
  62 .B \-install
  63 Install a private colormap for the window.
  64 .TP 8
  65 .B \-visual \fIvisual\fP
  66 Specify which visual to use.  Legal values are the name of a visual
  67 class, or the id number (decimal or hex) of a specific visual.
  68 .TP 8
  69 .B \-delay \fImicroseconds\fP
  70 How much of a delay should be introduced between steps of the
  71 animation.  Default 25000, or 1/40th second.
  72 .PP
  73 The following three options are mutually exclusive.  They determine
  74 how the torus is displayed.
  75 .TP 8
  76 .B \-mesh
  77 Display the torus as a wireframe mesh.
  78 .TP 8
  79 .B \-surface
  80 Display the torus as a solid surface (default).
  81 .TP 8
  82 .B \-transparent
  83 Display the torus as a transparent surface.
  84 .PP
  85 The following two options are mutually exclusive.  They determine the
  86 appearance of the torus.
  87 .TP 8
  88 .B \-solid
  89 Display the torus as a solid object.
  90 .TP 8
  91 .B \-bands
  92 Display the torus as see-through bands (default).
  93 .PP
  94 The following two options are mutually exclusive.  They determine how
  95 to color the torus.
  96 .TP 8
  97 .B \-twosided
  98 Display the torus with two colors: red on the outside and green on
  99 the inside.
 100 .TP 8
 101 .B \-colorwheel
 102 Display the torus with a fully saturated color wheel (default).
 103 .PP
 104 The following two options are mutually exclusive.  They determine how
 105 the torus is projected from 3d to 2d (i.e., to the screen).
 106 .TP 8
 107 .B \-perspective-3d
 108 Project the torus from 3d to 2d using a perspective projection
 109 (default).
 110 .TP 8
 111 .B \-orthographic-3d
 112 Project the torus from 3d to 2d using an orthographic projection.
 113 .PP
 114 The following two options are mutually exclusive.  They determine how
 115 the torus is projected from 4d to 3d.
 116 .TP 8
 117 .B \-perspective-4d
 118 Project the torus from 4d to 3d using a perspective projection
 119 (default).
 120 .TP 8
 121 .B \-orthographic-4d
 122 Project the torus from 4d to 3d using an orthographic projection.
 123 .PP
 124 The following six options determine the rotation speed of the torus
 125 around the six possible hyperplanes.  The rotation speed is measured
 126 in degrees per frame.  The speeds should be set to relatively small
 127 values, e.g., less than 4 in magnitude.
 128 .TP 8
 129 .B \-speed-xw \fIfloat\fP
 130 Rotation speed around the wx plane (default: 1.1).
 131 .TP 8
 132 .B \-speed-xy \fIfloat\fP
 133 Rotation speed around the wy plane (default: 1.3).
 134 .TP 8
 135 .B \-speed-wz \fIfloat\fP
 136 Rotation speed around the wz plane (default: 1.5).
 137 .TP 8
 138 .B \-speed-xy \fIfloat\fP
 139 Rotation speed around the xy plane (default: 1.7).
 140 .TP 8
 141 .B \-speed-xz \fIfloat\fP
 142 Rotation speed around the xz plane (default: 1.9).
 143 .TP 8
 144 .B \-speed-yz \fIfloat\fP
 145 Rotation speed around the yz plane (default: 2.1).
 146 .SH ENVIRONMENT
 147 .PP
 148 .TP 8
 149 .B DISPLAY
 150 to get the default host and display number.
 151 .TP 8
 152 .B XENVIRONMENT
 153 to get the name of a resource file that overrides the global resources
 154 stored in the RESOURCE_MANAGER property.
 155 .SH SEE ALSO
 156 .BR X (1),
 157 .BR xscreensaver (1)
 158 .SH COPYRIGHT
 159 Copyright \(co 2003 by Carsten Steger.  Permission to use, copy, modify,
 160 distribute, and sell this software and its documentation for any purpose is
 161 hereby granted without fee, provided that the above copyright notice appear
 162 in all copies and that both that copyright notice and this permission notice
 163 appear in supporting documentation.  No representations are made about the
 164 suitability of this software for any purpose.  It is provided "as is" without
 165 express or implied warranty.
 166 .SH AUTHOR
 167 Carsten Steger <carsten@mirsanmir.org>, 27-may-2003.