git.hungrycats.org Git - xscreensaver/blob - hacks/glx/trackball.c

   1 /*
   2  * (c) Copyright 1993, 1994, Silicon Graphics, Inc.
   3  * ALL RIGHTS RESERVED
   4  * Permission to use, copy, modify, and distribute this software for
   5  * any purpose and without fee is hereby granted, provided that the above
   6  * copyright notice appear in all copies and that both the copyright notice
   7  * and this permission notice appear in supporting documentation, and that
   8  * the name of Silicon Graphics, Inc. not be used in advertising
   9  * or publicity pertaining to distribution of the software without specific,
  10  * written prior permission.
  11  *
  12  * THE MATERIAL EMBODIED ON THIS SOFTWARE IS PROVIDED TO YOU "AS-IS"
  13  * AND WITHOUT WARRANTY OF ANY KIND, EXPRESS, IMPLIED OR OTHERWISE,
  14  * INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY OR
  15  * FITNESS FOR A PARTICULAR PURPOSE.  IN NO EVENT SHALL SILICON
  16  * GRAPHICS, INC.  BE LIABLE TO YOU OR ANYONE ELSE FOR ANY DIRECT,
  17  * SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY
  18  * KIND, OR ANY DAMAGES WHATSOEVER, INCLUDING WITHOUT LIMITATION,
  19  * LOSS OF PROFIT, LOSS OF USE, SAVINGS OR REVENUE, OR THE CLAIMS OF
  20  * THIRD PARTIES, WHETHER OR NOT SILICON GRAPHICS, INC.  HAS BEEN
  21  * ADVISED OF THE POSSIBILITY OF SUCH LOSS, HOWEVER CAUSED AND ON
  22  * ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE
  23  * POSSESSION, USE OR PERFORMANCE OF THIS SOFTWARE.
  24  *
  25  * US Government Users Restricted Rights
  26  * Use, duplication, or disclosure by the Government is subject to
  27  * restrictions set forth in FAR 52.227.19(c)(2) or subparagraph
  28  * (c)(1)(ii) of the Rights in Technical Data and Computer Software
  29  * clause at DFARS 252.227-7013 and/or in similar or successor
  30  * clauses in the FAR or the DOD or NASA FAR Supplement.
  31  * Unpublished-- rights reserved under the copyright laws of the
  32  * United States.  Contractor/manufacturer is Silicon Graphics,
  33  * Inc., 2011 N.  Shoreline Blvd., Mountain View, CA 94039-7311.
  34  *
  35  * OpenGL(TM) is a trademark of Silicon Graphics, Inc.
  36  */
  37 /*
  38  * Trackball code:
  39  *
  40  * Implementation of a virtual trackball.
  41  * Implemented by Gavin Bell, lots of ideas from Thant Tessman and
  42  *   the August '88 issue of Siggraph's "Computer Graphics," pp. 121-129.
  43  *
  44  * Vector manip code:
  45  *
  46  * Original code from:
  47  * David M. Ciemiewicz, Mark Grossman, Henry Moreton, and Paul Haeberli
  48  *
  49  * Much mucking with by:
  50  * Gavin Bell
  51  */
  52
  53 #include <math.h>
  54
  55 #ifdef HAVE_CONFIG_H
  56 # include "config.h"
  57 #endif
  58
  59 #include "trackball.h"
  60
  61 /*
  62  * This size should really be based on the distance from the center of
  63  * rotation to the point on the object underneath the mouse.  That
  64  * point would then track the mouse as closely as possible.  This is a
  65  * simple example, though, so that is left as an Exercise for the
  66  * Programmer.
  67  */
  68 #define TRACKBALLSIZE  (0.8)
  69
  70 /*
  71  * Local function prototypes (not defined in trackball.h)
  72  */
  73 static float tb_project_to_sphere(float, float, float);
  74 static void normalize_quat(float [4]);
  75 static void axis_to_quat(float a[3], float phi, float q[4]);
  76
  77 static void
  78 vzero(float *v)
  79 {
  80     v[0] = 0.0;
  81     v[1] = 0.0;
  82     v[2] = 0.0;
  83 }
  84
  85 static void
  86 vset(float *v, float x, float y, float z)
  87 {
  88     v[0] = x;
  89     v[1] = y;
  90     v[2] = z;
  91 }
  92
  93 static void
  94 vsub(const float *src1, const float *src2, float *dst)
  95 {
  96     dst[0] = src1[0] - src2[0];
  97     dst[1] = src1[1] - src2[1];
  98     dst[2] = src1[2] - src2[2];
  99 }
 100
 101 static void
 102 vcopy(const float *v1, float *v2)
 103 {
 104     register int i;
 105     for (i = 0 ; i < 3 ; i++)
 106         v2[i] = v1[i];
 107 }
 108
 109 static void
 110 vcross(const float *v1, const float *v2, float *cross)
 111 {
 112     float temp[3];
 113
 114     temp[0] = (v1[1] * v2[2]) - (v1[2] * v2[1]);
 115     temp[1] = (v1[2] * v2[0]) - (v1[0] * v2[2]);
 116     temp[2] = (v1[0] * v2[1]) - (v1[1] * v2[0]);
 117     vcopy(temp, cross);
 118 }
 119
 120 static float
 121 vlength(const float *v)
 122 {
 123     return sqrt(v[0] * v[0] + v[1] * v[1] + v[2] * v[2]);
 124 }
 125
 126 static void
 127 vscale(float *v, float div)
 128 {
 129     v[0] *= div;
 130     v[1] *= div;
 131     v[2] *= div;
 132 }
 133
 134 static void
 135 vnormal(float *v)
 136 {
 137     vscale(v,1.0/vlength(v));
 138 }
 139
 140 static float
 141 vdot(const float *v1, const float *v2)
 142 {
 143     return v1[0]*v2[0] + v1[1]*v2[1] + v1[2]*v2[2];
 144 }
 145
 146 static void
 147 vadd(const float *src1, const float *src2, float *dst)
 148 {
 149     dst[0] = src1[0] + src2[0];
 150     dst[1] = src1[1] + src2[1];
 151     dst[2] = src1[2] + src2[2];
 152 }
 153
 154 /*
 155  * Ok, simulate a track-ball.  Project the points onto the virtual
 156  * trackball, then figure out the axis of rotation, which is the cross
 157  * product of P1 P2 and O P1 (O is the center of the ball, 0,0,0)
 158  * Note:  This is a deformed trackball-- is a trackball in the center,
 159  * but is deformed into a hyperbolic sheet of rotation away from the
 160  * center.  This particular function was chosen after trying out
 161  * several variations.
 162  *
 163  * It is assumed that the arguments to this routine are in the range
 164  * (-1.0 ... 1.0)
 165  */
 166 void
 167 trackball(float q[4], float p1x, float p1y, float p2x, float p2y)
 168 {
 169     float a[3]; /* Axis of rotation */
 170     float phi;  /* how much to rotate about axis */
 171     float p1[3], p2[3], d[3];
 172     float t;
 173
 174     if (p1x == p2x && p1y == p2y) {
 175         /* Zero rotation */
 176         vzero(q);
 177         q[3] = 1.0;
 178         return;
 179     }
 180
 181     /*
 182      * First, figure out z-coordinates for projection of P1 and P2 to
 183      * deformed sphere
 184      */
 185     vset(p1,p1x,p1y,tb_project_to_sphere(TRACKBALLSIZE,p1x,p1y));
 186     vset(p2,p2x,p2y,tb_project_to_sphere(TRACKBALLSIZE,p2x,p2y));
 187
 188     /*
 189      *  Now, we want the cross product of P1 and P2
 190      */
 191     vcross(p2,p1,a);
 192
 193     /*
 194      *  Figure out how much to rotate around that axis.
 195      */
 196     vsub(p1,p2,d);
 197     t = vlength(d) / (2.0*TRACKBALLSIZE);
 198
 199     /*
 200      * Avoid problems with out-of-control values...
 201      */
 202     if (t > 1.0) t = 1.0;
 203     if (t < -1.0) t = -1.0;
 204     phi = 2.0 * asin(t);
 205
 206     axis_to_quat(a,phi,q);
 207 }
 208
 209 /*
 210  *  Given an axis and angle, compute quaternion.
 211  */
 212 void
 213 axis_to_quat(float a[3], float phi, float q[4])
 214 {
 215     vnormal(a);
 216     vcopy(a,q);
 217     vscale(q,sin(phi/2.0));
 218     q[3] = cos(phi/2.0);
 219 }
 220
 221 /*
 222  * Project an x,y pair onto a sphere of radius r OR a hyperbolic sheet
 223  * if we are away from the center of the sphere.
 224  */
 225 static float
 226 tb_project_to_sphere(float r, float x, float y)
 227 {
 228     float d, t, z;
 229
 230     d = sqrt(x*x + y*y);
 231     if (d < r * 0.70710678118654752440) {    /* Inside sphere */
 232         z = sqrt(r*r - d*d);
 233     } else {           /* On hyperbola */
 234         t = r / 1.41421356237309504880;
 235         z = t*t / d;
 236     }
 237     return z;
 238 }
 239
 240 /*
 241  * Given two rotations, e1 and e2, expressed as quaternion rotations,
 242  * figure out the equivalent single rotation and stuff it into dest.
 243  *
 244  * This routine also normalizes the result every RENORMCOUNT times it is
 245  * called, to keep error from creeping in.
 246  *
 247  * NOTE: This routine is written so that q1 or q2 may be the same
 248  * as dest (or each other).
 249  */
 250
 251 #define RENORMCOUNT 97
 252
 253 void
 254 add_quats(float q1[4], float q2[4], float dest[4])
 255 {
 256     static int count=0;
 257     float t1[4], t2[4], t3[4];
 258     float tf[4];
 259
 260     vcopy(q1,t1);
 261     vscale(t1,q2[3]);
 262
 263     vcopy(q2,t2);
 264     vscale(t2,q1[3]);
 265
 266     vcross(q2,q1,t3);
 267     vadd(t1,t2,tf);
 268     vadd(t3,tf,tf);
 269     tf[3] = q1[3] * q2[3] - vdot(q1,q2);
 270
 271     dest[0] = tf[0];
 272     dest[1] = tf[1];
 273     dest[2] = tf[2];
 274     dest[3] = tf[3];
 275
 276     if (++count > RENORMCOUNT) {
 277         count = 0;
 278         normalize_quat(dest);
 279     }
 280 }
 281
 282 /*
 283  * Quaternions always obey:  a^2 + b^2 + c^2 + d^2 = 1.0
 284  * If they don't add up to 1.0, dividing by their magnitued will
 285  * renormalize them.
 286  *
 287  * Note: See the following for more information on quaternions:
 288  *
 289  * - Shoemake, K., Animating rotation with quaternion curves, Computer
 290  *   Graphics 19, No 3 (Proc. SIGGRAPH'85), 245-254, 1985.
 291  * - Pletinckx, D., Quaternion calculus as a basic tool in computer
 292  *   graphics, The Visual Computer 5, 2-13, 1989.
 293  */
 294 static void
 295 normalize_quat(float q[4])
 296 {
 297     int i;
 298     float mag;
 299
 300     mag = (q[0]*q[0] + q[1]*q[1] + q[2]*q[2] + q[3]*q[3]);
 301     for (i = 0; i < 4; i++) q[i] /= mag;
 302 }
 303
 304 /*
 305  * Build a rotation matrix, given a quaternion rotation.
 306  *
 307  */
 308 void
 309 build_rotmatrix(float m[4][4], float q[4])
 310 {
 311     m[0][0] = 1.0 - 2.0 * (q[1] * q[1] + q[2] * q[2]);
 312     m[0][1] = 2.0 * (q[0] * q[1] - q[2] * q[3]);
 313     m[0][2] = 2.0 * (q[2] * q[0] + q[1] * q[3]);
 314     m[0][3] = 0.0;
 315
 316     m[1][0] = 2.0 * (q[0] * q[1] + q[2] * q[3]);
 317     m[1][1]= 1.0 - 2.0 * (q[2] * q[2] + q[0] * q[0]);
 318     m[1][2] = 2.0 * (q[1] * q[2] - q[0] * q[3]);
 319     m[1][3] = 0.0;
 320
 321     m[2][0] = 2.0 * (q[2] * q[0] - q[1] * q[3]);
 322     m[2][1] = 2.0 * (q[1] * q[2] + q[0] * q[3]);
 323     m[2][2] = 1.0 - 2.0 * (q[1] * q[1] + q[0] * q[0]);
 324     m[2][3] = 0.0;
 325
 326     m[3][0] = 0.0;
 327     m[3][1] = 0.0;
 328     m[3][2] = 0.0;
 329     m[3][3] = 1.0;
 330 }
 331