http://ftp.ksu.edu.tw/FTP/FreeBSD/distfiles/xscreensaver-4.23.tar.gz

[xscreensaver] / hacks / glx / hypertorus.man

diff --git a/hacks/glx/hypertorus.man b/hacks/glx/hypertorus.man
index 8342f6dcd90481f15076c43e96340508d00e9981..2d0b64703d6b9cde26f94098a53dc79d2f4fe91a 100644 (file)
--- a/hacks/glx/hypertorus.man
+++ b/hacks/glx/hypertorus.man
@@ -15,6 +15,7 @@ hypertorus - Draws a hypertorus that rotates in 4d
 [\-transparent]
 [\-solid]
 [\-bands]
+[\-spirals-{1,2,4,8,16}]
 [\-twosided]
 [\-colorwheel]
 [\-perspective-3d]
@@ -38,17 +39,18 @@ covered cylinder for some angles.  The projected 3d torus can then be
 projected to the screen either perspectively or orthographically.
 There are three display modes for the torus: mesh (wireframe), solid,
 or transparent.  Furthermore, the appearance of the torus can be as a
-solid object or as a set of see-through bands.  Finally, the colors
-with with the torus is drawn can be set to either two-sided or to a
-color wheel.  In the first case, the torus is drawn with red on the
-outside and green on the inside.  This mode enables you to see that
-the torus turns inside-out as it rotates in 4d.  The second mode draws
-the torus with a fully saturated color wheel.  This gives a very nice
-effect when combined with the see-through bands mode.  The rotation
-speed for each of the six planes around which the torus rotates can be
-chosen.  This program is very much inspired by Thomas Banchoff's book
-"Beyond the Third Dimension: Geometry, Computer Graphics, and Higher
-Dimensions", Scientific American Library, 1990.
+solid object or as a set of see-through bands or see-through spirals.
+Finally, the colors with with the torus is drawn can be set to either
+two-sided or to a color wheel.  In the first case, the torus is drawn
+with red on the outside and green on the inside.  This mode enables
+you to see that the torus turns inside-out as it rotates in 4d.  The
+second mode draws the torus with a fully saturated color wheel.  This
+gives a very nice effect when combined with the see-through bands or
+see-through spirals mode.  The rotation speed for each of the six
+planes around which the torus rotates can be chosen.  This program is
+very much inspired by Thomas Banchoff's book "Beyond the Third
+Dimension: Geometry, Computer Graphics, and Higher Dimensions",
+Scientific American Library, 1990.
 .SH OPTIONS
 .I hypertorus
 accepts the following options:
@@ -82,7 +84,7 @@ Display the torus as a solid surface (default).
 .B \-transparent
 Display the torus as a transparent surface.
 .PP
-The following two options are mutually exclusive.  They determine the
+The following seven options are mutually exclusive.  They determine the
 appearance of the torus.
 .TP 8
 .B \-solid
@@ -90,6 +92,10 @@ Display the torus as a solid object.
 .TP 8
 .B \-bands
 Display the torus as see-through bands (default).
+.TP 8
+.B \-spirals-1, \-spirals-2, \-spirals-4, \-spirals-8, \-spirals-16
+Display the torus as see-through spirals with the indicated number of
+spirals.
 .PP
 The following two options are mutually exclusive.  They determine how
 to color the torus.
@@ -99,7 +105,10 @@ Display the torus with two colors: red on the outside and green on
 the inside.
 .TP 8
 .B \-colorwheel
-Display the torus with a fully saturated color wheel (default).
+Display the torus with a fully saturated color wheel (default).  If
+the torus is displayed as see-through bands each band will be
+displayed with a different color.  Likewise, if the torus is displayed
+as see-through spirals each spiral will receive a different color.
 .PP
 The following two options are mutually exclusive.  They determine how
 the torus is projected from 3d to 2d (i.e., to the screen).
@@ -143,6 +152,15 @@ Rotation speed around the xz plane (default: 1.9).
 .TP 8
 .B \-speed-yz \fIfloat\fP
 Rotation speed around the yz plane (default: 2.1).
+.SH INTERACTION
+If you run this program in standalone mode you can rotate the
+hypertorus by dragging the mouse while pressing the left mouse button.
+This rotates the hypertorus in 3D, i.e., around the wx, wy, and wz
+planes.  If you press the shift key while dragging the mouse with the
+left button pressed the hypertorus is rotated in 4D, i.e., around the
+xy, xz, and yz planes.  To examine the hypertorus at your leisure, it
+is best to set all speeds to 0.  Otherwise, the hypertorus will rotate
+while the left mouse button is not pressed.
 .SH ENVIRONMENT
 .PP
 .TP 8
@@ -156,7 +174,7 @@ stored in the RESOURCE_MANAGER property.
 .BR X (1),
 .BR xscreensaver (1)
 .SH COPYRIGHT
-Copyright \(co 2003 by Carsten Steger.  Permission to use, copy, modify, 
+Copyright \(co 2003-2005 by Carsten Steger.  Permission to use, copy, modify, 
 distribute, and sell this software and its documentation for any purpose is 
 hereby granted without fee, provided that the above copyright notice appear 
 in all copies and that both that copyright notice and this permission notice
@@ -164,4 +182,4 @@ appear in supporting documentation.  No representations are made about the
 suitability of this software for any purpose.  It is provided "as is" without
 express or implied warranty.
 .SH AUTHOR
-Carsten Steger <carsten@mirsanmir.org>, 27-may-2003.
+Carsten Steger <carsten@mirsanmir.org>, 28-sep-2005.