From http://www.jwz.org/xscreensaver/xscreensaver-5.37.tar.gz
[xscreensaver] / hacks / glx / atlantis.c
1 /* atlantis --- Shows moving 3D sea animals */
2
3 #if 0
4 static const char sccsid[] = "@(#)atlantis.c    5.08 2003/04/09 xlockmore";
5 #endif
6
7 /* Copyright (c) E. Lassauge, 1998. */
8
9 /*
10  * Permission to use, copy, modify, and distribute this software and its
11  * documentation for any purpose and without fee is hereby granted,
12  * provided that the above copyright notice appear in all copies and that
13  * both that copyright notice and this permission notice appear in
14  * supporting documentation.
15  *
16  * This file is provided AS IS with no warranties of any kind.  The author
17  * shall have no liability with respect to the infringement of copyrights,
18  * trade secrets or any patents by this file or any part thereof.  In no
19  * event will the author be liable for any lost revenue or profits or
20  * other special, indirect and consequential damages.
21  *
22  * The original code for this mode was written by Mark J. Kilgard
23  * as a demo for openGL programming.
24  * 
25  * Porting it to xlock  was possible by comparing the original Mesa's morph3d 
26  * demo with it's ported version to xlock, so thanks for Marcelo F. Vianna 
27  * (look at morph3d.c) for his indirect help.
28  *
29  * Thanks goes also to Brian Paul for making it possible and inexpensive
30  * to use OpenGL at home.
31  *
32  * My e-mail address is lassauge@users.sourceforge.net
33  *
34  * Eric Lassauge  (May-13-1998)
35  *
36  * REVISION HISTORY:
37  * 
38  * Jamie Zawinski, 2-Apr-01:  - The fishies were inside out!  The back faces
39  *                              were being drawn, not the front faces.
40  *                            - Added a texture to simulate light from the
41  *                              surface, like in the SGI version.
42  *
43  * David A. Bagley - 98/06/17 : Add whalespeed option. Global options to
44  *                              initialize local variables are now:
45  *                              XLock.atlantis.cycles: 100      ! SharkSpeed
46  *                              XLock.atlantis.batchcount: 4    ! SharkNum
47  *                              XLock.atlantis.whalespeed: 250  ! WhaleSpeed
48  *                              XLock.atlantis.size: 6000       ! SharkSize
49  *                              Add random direction for whales/dolphins
50  * 
51  * E.Lassauge - 98/06/16: Use the following global options to initialize
52  *                        local variables :
53  *                              XLock.atlantis.delay: 100       ! SharkSpeed
54  *                              XLock.atlantis.batchcount: 4    ! SharkNum
55  *                              XLock.atlantis.cycles: 250      ! WhaleSpeed
56  *                              XLock.atlantis.size: 6000       ! SharkSize
57  *                        Add support for -/+ wireframe (t'was so easy to do!)
58  *
59  * TODO : 
60  *        - better handling of sizes and speeds
61  *        - test standalone and module modes
62  *        - purify it (!)
63  */
64
65 /* Copyright (c) Mark J. Kilgard, 1994. */
66
67 /**
68  * (c) Copyright 1993, 1994, Silicon Graphics, Inc.
69  * ALL RIGHTS RESERVED
70  * Permission to use, copy, modify, and distribute this software for
71  * any purpose and without fee is hereby granted, provided that the above
72  * copyright notice appear in all copies and that both the copyright notice
73  * and this permission notice appear in supporting documentation, and that
74  * the name of Silicon Graphics, Inc. not be used in advertising
75  * or publicity pertaining to distribution of the software without specific,
76  * written prior permission.
77  *
78  * THE MATERIAL EMBODIED ON THIS SOFTWARE IS PROVIDED TO YOU "AS-IS"
79  * AND WITHOUT WARRANTY OF ANY KIND, EXPRESS, IMPLIED OR OTHERWISE,
80  * INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY OR
81  * FITNESS FOR A PARTICULAR PURPOSE.  IN NO EVENT SHALL SILICON
82  * GRAPHICS, INC.  BE LIABLE TO YOU OR ANYONE ELSE FOR ANY DIRECT,
83  * SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY
84  * KIND, OR ANY DAMAGES WHATSOEVER, INCLUDING WITHOUT LIMITATION,
85  * LOSS OF PROFIT, LOSS OF USE, SAVINGS OR REVENUE, OR THE CLAIMS OF
86  * THIRD PARTIES, WHETHER OR NOT SILICON GRAPHICS, INC.  HAS BEEN
87  * ADVISED OF THE POSSIBILITY OF SUCH LOSS, HOWEVER CAUSED AND ON
88  * ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE
89  * POSSESSION, USE OR PERFORMANCE OF THIS SOFTWARE.
90  *
91  * US Government Users Restricted Rights
92  * Use, duplication, or disclosure by the Government is subject to
93  * restrictions set forth in FAR 52.227.19(c)(2) or subparagraph
94  * (c)(1)(ii) of the Rights in Technical Data and Computer Software
95  * clause at DFARS 252.227-7013 and/or in similar or successor
96  * clauses in the FAR or the DOD or NASA FAR Supplement.
97  * Unpublished-- rights reserved under the copyright laws of the
98  * United States.  Contractor/manufacturer is Silicon Graphics,
99  * Inc., 2011 N.  Shoreline Blvd., Mountain View, CA 94039-7311.
100  *
101  * OpenGL(TM) is a trademark of Silicon Graphics, Inc.
102  */
103
104 #define DEF_TEXTURE "True"
105 #define DEF_GRADIENT "True"
106 #define DEF_WHALESPEED  "250"
107
108 #ifdef STANDALONE
109 # define DEFAULTS       "*delay:       25000 \n" \
110                          "*count:          4 \n" \
111                          "*showFPS:    False \n" \
112                          "*cycles:       100 \n" \
113                          "*size:        6000 \n" \
114                          "*wireframe:  False \n"
115 # define release_atlantis 0
116 # define atlantis_handle_event 0
117 # include "xlockmore.h"         /* from the xscreensaver distribution */
118 #else  /* !STANDALONE */
119 # include "xlock.h"             /* from the xlockmore distribution */
120 # include "vis.h"
121 #endif /* !STANDALONE */
122
123 #ifdef USE_GL
124
125 #include "atlantis.h"
126
127
128 static int  whalespeed;
129 static int do_texture;
130 static int do_gradient;
131 static XrmOptionDescRec opts[] =
132 {
133      {"-whalespeed", ".atlantis.whalespeed", XrmoptionSepArg, 0},
134      {"-texture",    ".atlantis.texture",    XrmoptionNoArg, "true"},
135      {"+texture",    ".atlantis.texture",    XrmoptionNoArg, "false"},
136      {"-gradient",   ".atlantis.gradient",   XrmoptionNoArg, "true"},
137      {"+gradient",   ".atlantis.gradient",   XrmoptionNoArg, "false"},
138 };
139
140 static argtype vars[] =
141 {
142  {&whalespeed, "whalespeed", "WhaleSpeed", DEF_WHALESPEED, t_Int},
143  {&do_texture,  "texture",    "Texture",    DEF_TEXTURE,   t_Bool},
144  {&do_gradient, "gradient",   "Gradient",   DEF_GRADIENT,  t_Bool},
145 };
146
147 static OptionStruct desc[] =
148 {
149         {"-whalespeed num", "speed of whales and the dolphin"},
150         {"-texture",        "whether to introduce water-like distortion"},
151         {"-gradient",       "whether to introduce gradient-filled background"},
152 };
153
154 ENTRYPOINT ModeSpecOpt atlantis_opts =
155 {sizeof opts / sizeof opts[0], opts, sizeof vars / sizeof vars[0], vars, desc};
156
157 #ifdef USE_MODULES
158 ModStruct   atlantis_description =
159 {"atlantis", "init_atlantis", "draw_atlantis", NULL,
160  "refresh_atlantis", "change_atlantis", NULL, &atlantis_opts,
161  1000, NUM_SHARKS, SHARKSPEED, SHARKSIZE, 64, 1.0, "",
162  "Shows moving sharks/whales/dolphin", 0, NULL};
163
164 #endif
165
166 static atlantisstruct *atlantis = NULL;
167
168 #include "xpm-ximage.h"
169
170 #include "../images/sea-texture.xpm"
171
172
173 static void
174 parse_image_data(ModeInfo *mi)
175 {
176   atlantisstruct *ap = &atlantis[MI_SCREEN(mi)];
177   ap->texture = xpm_to_ximage (mi->dpy,
178                                mi->xgwa.visual,
179                                mi->xgwa.colormap,
180                                sea_texture);
181 }
182
183 static void
184 InitFishs(atlantisstruct * ap)
185 {
186         int         i;
187
188         for (i = 0; i < ap->num_sharks; i++) {
189                 ap->sharks[i].x = 70000.0 + NRAND(ap->sharksize);
190                 ap->sharks[i].y = NRAND(ap->sharksize);
191                 ap->sharks[i].z = NRAND(ap->sharksize);
192                 ap->sharks[i].psi = NRAND(360) - 180.0;
193                 ap->sharks[i].v = 1.0;
194         }
195
196         /* Random whale direction */
197         ap->whaledir = LRAND() & 1;
198
199         ap->dolph.x = 30000.0;
200         ap->dolph.y = 0.0;
201         ap->dolph.z = (float) (ap->sharksize);
202         ap->dolph.psi = (ap->whaledir) ? 90.0 : -90.0;
203         ap->dolph.theta = 0.0;
204         ap->dolph.v = 6.0;
205
206         ap->momWhale.x = 70000.0;
207         ap->momWhale.y = 0.0;
208         ap->momWhale.z = 0.0;
209         ap->momWhale.psi = (ap->whaledir) ? 90.0 : -90.0;
210         ap->momWhale.theta = 0.0;
211         ap->momWhale.v = 3.0;
212
213         ap->babyWhale.x = 60000.0;
214         ap->babyWhale.y = -2000.0;
215         ap->babyWhale.z = -2000.0;
216         ap->babyWhale.psi = (ap->whaledir) ? 90.0 : -90.0;
217         ap->babyWhale.theta = 0.0;
218         ap->babyWhale.v = 3.0;
219 }
220
221 static void
222 Init(ModeInfo *mi)
223 {
224         atlantisstruct *ap = &atlantis[MI_SCREEN(mi)];
225
226         static const float ambient[]        = {0.1, 0.1, 0.1, 1.0};
227         static const float diffuse[]        = {1.0, 1.0, 1.0, 1.0};
228         static const float position[]       = {0.0, 1.0, 0.0, 0.0};
229         static const float mat_shininess[]  = {90.0};
230         static const float mat_specular[]   = {0.8, 0.8, 0.8, 1.0};
231         static const float mat_diffuse[]    = {0.46, 0.66, 0.795, 1.0};
232         static const float mat_ambient[]    = {0.0, 0.1, 0.2, 1.0};
233         static const float lmodel_ambient[] = {0.4, 0.4, 0.4, 1.0};
234         static const float lmodel_localviewer[] = {0.0};
235
236         float        fblue = 0.0, fgreen;
237
238         glFrontFace(GL_CCW);
239
240         if (ap->wire)
241           {
242             glDisable(GL_DEPTH_TEST);
243             glDisable(GL_CULL_FACE);
244             glDisable(GL_LIGHTING);
245             glDisable(GL_NORMALIZE);
246           }
247         else
248           {
249             glDepthFunc(GL_LEQUAL);
250             glEnable(GL_DEPTH_TEST);
251             glEnable(GL_CULL_FACE);
252             glEnable(GL_NORMALIZE);
253             glShadeModel(GL_SMOOTH);
254
255             glLightfv(GL_LIGHT0, GL_AMBIENT, ambient);
256             glLightfv(GL_LIGHT0, GL_DIFFUSE, diffuse);
257             glLightfv(GL_LIGHT0, GL_POSITION, position);
258             glLightModelfv(GL_LIGHT_MODEL_AMBIENT, lmodel_ambient);
259             glLightModelfv(GL_LIGHT_MODEL_LOCAL_VIEWER, lmodel_localviewer);
260             glEnable(GL_LIGHTING);
261             glEnable(GL_LIGHT0);
262
263             glMaterialfv(GL_FRONT_AND_BACK, GL_SHININESS, mat_shininess);
264             glMaterialfv(GL_FRONT_AND_BACK, GL_SPECULAR, mat_specular);
265             glMaterialfv(GL_FRONT_AND_BACK, GL_DIFFUSE, mat_diffuse);
266             glMaterialfv(GL_FRONT_AND_BACK, GL_AMBIENT, mat_ambient);
267           }
268
269         if (ap->wire || !do_texture)
270           {
271             glDisable(GL_TEXTURE_2D);
272           }
273         else
274           {
275             GLfloat scale = 0.0005;
276
277             if (!ap->texture)
278               parse_image_data (mi);
279
280             clear_gl_error();
281             glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA,
282                          ap->texture->width, ap->texture->height, 0,
283                          GL_RGBA, GL_UNSIGNED_BYTE,
284                          ap->texture->data);
285             check_gl_error("texture");
286
287             glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_REPEAT);
288             glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_REPEAT);
289             glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
290             glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
291
292             glTexEnvf(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
293
294 # ifndef HAVE_JWZGLES
295             {
296               GLfloat s_plane[] = { 1, 0, 0, 0 };
297               GLfloat t_plane[] = { 0, 0, 1, 0 };
298               glTexGeni (GL_S, GL_TEXTURE_GEN_MODE, GL_EYE_LINEAR);
299               glTexGeni (GL_T, GL_TEXTURE_GEN_MODE, GL_EYE_LINEAR);
300               glTexGenfv(GL_S, GL_EYE_PLANE, s_plane);
301               glTexGenfv(GL_T, GL_EYE_PLANE, t_plane);
302               glEnable(GL_TEXTURE_GEN_S);
303               glEnable(GL_TEXTURE_GEN_T);
304             }
305 # endif
306             glEnable(GL_TEXTURE_2D);
307
308             glMatrixMode(GL_TEXTURE);
309             glLoadIdentity();
310             glScalef(scale, scale, 1);
311             glMatrixMode(GL_MODELVIEW);
312           }
313
314         InitFishs(ap);
315
316         /* Add a little randomness */
317         fblue = ((float) (NRAND(30)) / 100.0) + 0.70;
318         fgreen = fblue * 0.56;
319         glClearColor(0.0, fgreen, fblue, 1.0);
320 }
321
322 ENTRYPOINT void
323 reshape_atlantis(ModeInfo * mi, int width, int height)
324 {
325         atlantisstruct *ap = &atlantis[MI_SCREEN(mi)];
326
327         glViewport(0, 0, ap->WinW = (GLint) width, ap->WinH = (GLint) height);
328
329         glMatrixMode(GL_PROJECTION);
330         glLoadIdentity();
331         gluPerspective(400.0, (GLdouble) width / (GLdouble) height, 1.0, 2000000.0);
332         glMatrixMode(GL_MODELVIEW);
333 }
334
335
336 /* Fill the background with a gradient -- thanks to 
337    Phil Carrig <pod@internode.on.net> for figuring out
338    how to do this more efficiently!
339  */
340 static void
341 clear_tank (atlantisstruct * ap)
342 {
343   glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
344
345   if (do_gradient && !ap->wire)
346     {
347       GLfloat top[4] = { 0.00, 0.40, 0.70, };
348       GLfloat bot[4] = { 0.00, 0.05, 0.18, };
349
350       glMatrixMode(GL_PROJECTION);
351       glPushMatrix();
352       {
353         glLoadIdentity();
354         glMatrixMode(GL_MODELVIEW);
355         glPushMatrix();
356         {
357           glLoadIdentity();
358           /* glRotatef(current_device_rotation(), 0, 0, 1); */
359
360 # ifndef HAVE_JWZGLES
361           glShadeModel (GL_SMOOTH);
362 # endif
363           glDisable (GL_LIGHTING);
364           glBegin (GL_QUADS);
365           glColor3fv (bot);
366           glVertex3f (-1, -1, 1); glVertex3f ( 1, -1, 1);
367           glColor3fv (top);
368           glVertex3f ( 1,  1, 1); glVertex3f (-1,  1, 1);
369           glEnd();
370           glEnable (GL_LIGHTING);
371         }
372         glPopMatrix();
373       }
374       glMatrixMode(GL_PROJECTION);
375       glPopMatrix();
376
377       glMatrixMode(GL_MODELVIEW);
378     }
379 }
380
381
382 static void
383 Animate(atlantisstruct * ap)
384 {
385         int         i;
386
387         for (i = 0; i < ap->num_sharks; i++) {
388                 SharkPilot(&(ap->sharks[i]), ap->sharkspeed);
389                 SharkMiss(ap, i);
390         }
391         WhalePilot(&(ap->dolph), ap->whalespeed, ap->whaledir);
392         ap->dolph.phi++;
393         WhalePilot(&(ap->momWhale), ap->whalespeed, ap->whaledir);
394         ap->momWhale.phi++;
395         WhalePilot(&(ap->babyWhale), ap->whalespeed, ap->whaledir);
396         ap->babyWhale.phi++;
397 }
398
399 static void
400 AllDisplay(atlantisstruct * ap)
401 {
402         int         i;
403
404         clear_tank(ap);
405
406         for (i = 0; i < ap->num_sharks; i++) {
407                 glPushMatrix();
408                 FishTransform(&(ap->sharks[i]));
409                 DrawShark(&(ap->sharks[i]), ap->wire);
410                 glPopMatrix();
411         }
412
413         glPushMatrix();
414         FishTransform(&(ap->dolph));
415         DrawDolphin(&(ap->dolph), ap->wire);
416         glPopMatrix();
417
418         glPushMatrix();
419         FishTransform(&(ap->momWhale));
420         DrawWhale(&(ap->momWhale), ap->wire);
421         glPopMatrix();
422
423         glPushMatrix();
424         FishTransform(&(ap->babyWhale));
425         glScalef(0.45, 0.45, 0.3);
426         DrawWhale(&(ap->babyWhale), ap->wire);
427         glPopMatrix();
428 }
429
430 /*
431  *-----------------------------------------------------------------------------
432  *-----------------------------------------------------------------------------
433  *    Xlock hooks.
434  *-----------------------------------------------------------------------------
435  *-----------------------------------------------------------------------------
436  */
437
438 static void free_atlantis(ModeInfo * mi);
439
440 /*
441  *-----------------------------------------------------------------------------
442  *    Initialize atlantis.  Called each time the window changes.
443  *-----------------------------------------------------------------------------
444  */
445
446 ENTRYPOINT void
447 init_atlantis(ModeInfo * mi)
448 {
449         int         screen = MI_SCREEN(mi);
450         atlantisstruct *ap;
451         Display    *display = MI_DISPLAY(mi);
452         Window      window = MI_WINDOW(mi);
453
454         MI_INIT(mi, atlantis, free_atlantis);
455         ap = &atlantis[screen];
456         ap->num_sharks = MI_COUNT(mi);
457         if (ap->sharks == NULL) {
458                 if ((ap->sharks = (fishRec *) calloc(ap->num_sharks,
459                                                 sizeof (fishRec))) == NULL) {
460                         /* free everything up to now */
461                         (void) free((void *) atlantis);
462                         atlantis = NULL;
463                         return;
464                 }
465         }
466         ap->sharkspeed = MI_CYCLES(mi);         /* has influence on the "width"
467                                                    of the movement */
468         ap->sharksize = MI_SIZE(mi);    /* has influence on the "distance"
469                                            of the sharks */
470         ap->whalespeed = whalespeed;
471         ap->wire = MI_IS_WIREFRAME(mi);
472
473         if (MI_IS_DEBUG(mi)) {
474                 (void) fprintf(stderr,
475                                "%s:\n\tnum_sharks=%d\n\tsharkspeed=%.1f\n\tsharksize=%d\n\twhalespeed=%.1f\n\twireframe=%s\n",
476                                MI_NAME(mi),
477                                ap->num_sharks,
478                                ap->sharkspeed,
479                                ap->sharksize,
480                                ap->whalespeed,
481                                ap->wire ? "yes" : "no"
482                         );
483         }
484         if ((ap->glx_context = init_GL(mi)) != NULL) {
485
486                 reshape_atlantis(mi, MI_WIDTH(mi), MI_HEIGHT(mi));
487                 glDrawBuffer(GL_BACK);
488                 Init(mi);
489                 AllDisplay(ap);
490                 glXSwapBuffers(display, window);
491
492         } else {
493                 MI_CLEARWINDOW(mi);
494         }
495 }
496
497 /*
498  *-----------------------------------------------------------------------------
499  *    Called by the mainline code periodically to update the display.
500  *-----------------------------------------------------------------------------
501  */
502 ENTRYPOINT void
503 draw_atlantis(ModeInfo * mi)
504 {
505         atlantisstruct *ap = &atlantis[MI_SCREEN(mi)];
506
507         Display    *display = MI_DISPLAY(mi);
508         Window      window = MI_WINDOW(mi);
509
510         MI_IS_DRAWN(mi) = True;
511
512         if (!ap->glx_context)
513                 return;
514
515         glXMakeCurrent(display, window, *(ap->glx_context));
516
517         glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
518
519         glPushMatrix();
520         glRotatef(current_device_rotation(), 0, 0, 1);
521         AllDisplay(ap);
522         Animate(ap);
523         glPopMatrix();
524
525         if (mi->fps_p) do_fps (mi);
526         glXSwapBuffers(display, window);
527 }
528
529
530 /*
531  *-----------------------------------------------------------------------------
532  *    The display is being taken away from us.  Free up malloc'ed 
533  *      memory and X resources that we've alloc'ed.
534  *-----------------------------------------------------------------------------
535  */
536
537 static void
538 free_atlantis(ModeInfo * mi)
539 {
540 #if 0
541         atlantisstruct *ap = &atlantis[screen];
542
543         if (ap->sharks)
544                 (void) free((void *) ap->sharks);
545 #endif
546 }
547
548 ENTRYPOINT void
549 refresh_atlantis(ModeInfo * mi)
550 {
551 }
552
553 #ifndef STANDALONE
554 ENTRYPOINT void
555 change_atlantis(ModeInfo * mi)
556 {
557         atlantisstruct *ap = &atlantis[MI_SCREEN(mi)];
558
559         if (!ap->glx_context)
560                 return;
561
562         glXMakeCurrent(MI_DISPLAY(mi), MI_WINDOW(mi), *(ap->glx_context));
563         Init(mi);
564 }
565 #endif /* !STANDALONE */
566
567 XSCREENSAVER_MODULE ("Atlantis", atlantis)
568
569 #endif /* USE_GL */