]> git.mxchange.org Git - flightgear.git/blob - src/Main/views.cxx
418b6dcf4e4d8af6d9d1568d2330cd044bfc6aec
[flightgear.git] / src / Main / views.cxx
1 // views.cxx -- data structures and routines for managing and view
2 //               parameters.
3 //
4 // Written by Curtis Olson, started August 1997.
5 //
6 // Copyright (C) 1997  Curtis L. Olson  - curt@infoplane.com
7 //
8 // This program is free software; you can redistribute it and/or
9 // modify it under the terms of the GNU General Public License as
10 // published by the Free Software Foundation; either version 2 of the
11 // License, or (at your option) any later version.
12 //
13 // This program is distributed in the hope that it will be useful, but
14 // WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16 // General Public License for more details.
17 //
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 //
22 // $Id$
23
24
25 #ifdef HAVE_CONFIG_H
26 #  include <config.h>
27 #endif
28
29 #include <ssg.h>                // plib include
30
31 #include <Aircraft/aircraft.hxx>
32 #include <Cockpit/panel.hxx>
33 #include <Debug/logstream.hxx>
34 #include <Include/fg_constants.h>
35 #include <Math/mat3.h>
36 #include <Math/point3d.hxx>
37 #include <Math/polar3d.hxx>
38 #include <Math/vector.hxx>
39 #include <Scenery/scenery.hxx>
40 #include <Time/fg_time.hxx>
41
42 #include "options.hxx"
43 #include "views.hxx"
44
45
46 // Define following to extract various vectors directly
47 // from matrices we have allready computed
48 // rather then performing 'textbook algebra' to rederive them
49 // Norman Vine -- nhv@yahoo.com
50 // #define FG_VIEW_INLINE_OPTIMIZATIONS
51
52 // temporary (hopefully) hack
53 static int panel_hist = 0;
54
55
56 // specify code paths ... these are done as variable rather than
57 // #define's because down the road we may want to choose between them
58 // on the fly for different flight models ... this way magic carpet
59 // and external modes wouldn't need to recreate the LaRCsim matrices
60 // themselves.
61
62 static const bool use_larcsim_local_to_body = false;
63
64
65 // This is a record containing current view parameters
66 FGView current_view;
67
68
69 // Constructor
70 FGView::FGView( void ) {
71     MAT3identity(WORLD);
72 }
73
74
75 // Initialize a view structure
76 void FGView::Init( void ) {
77     FG_LOG( FG_VIEW, FG_INFO, "Initializing View parameters" );
78
79     view_offset = 0.0;
80     goal_view_offset = 0.0;
81
82     winWidth = current_options.get_xsize();
83     winHeight = current_options.get_ysize();
84
85     if ( ! current_options.get_panel_status() ) {
86         current_view.set_win_ratio( (GLfloat) winWidth / (GLfloat) winHeight );
87     } else {
88         current_view.set_win_ratio( (GLfloat) winWidth / 
89                                     ((GLfloat) (winHeight)*0.4232) );
90     }
91
92     force_update_fov_math();
93 }
94
95
96 // Update the field of view coefficients
97 void FGView::UpdateFOV( const fgOPTIONS& o ) {
98     ssgSetFOV( o.get_fov(), 0.0 );
99
100     double fov, theta_x, theta_y;
101
102     fov = o.get_fov();
103         
104     // printf("win_ratio = %.2f\n", win_ratio);
105     // calculate sin() and cos() of fov / 2 in X direction;
106     theta_x = (fov * win_ratio * DEG_TO_RAD) / 2.0;
107     // printf("theta_x = %.2f\n", theta_x);
108     sin_fov_x = sin(theta_x);
109     cos_fov_x = cos(theta_x);
110     slope_x =  -cos_fov_x / sin_fov_x;
111     // printf("slope_x = %.2f\n", slope_x);
112
113     // fov_x_clip and fov_y_clip convoluted algebraic simplification
114     // see code executed in tilemgr.cxx when USE_FAST_FOV_CLIP not
115     // defined Norman Vine -- nhv@yahoo.com
116 #if defined( USE_FAST_FOV_CLIP )
117     fov_x_clip = slope_x*cos_fov_x - sin_fov_x;
118 #endif // defined( USE_FAST_FOV_CLIP )
119
120     // calculate sin() and cos() of fov / 2 in Y direction;
121     theta_y = (fov * DEG_TO_RAD) / 2.0;
122     // printf("theta_y = %.2f\n", theta_y);
123     sin_fov_y = sin(theta_y);
124     cos_fov_y = cos(theta_y);
125     slope_y = cos_fov_y / sin_fov_y;
126     // printf("slope_y = %.2f\n", slope_y);
127
128 #if defined( USE_FAST_FOV_CLIP )
129     fov_y_clip = -(slope_y*cos_fov_y + sin_fov_y);      
130 #endif // defined( USE_FAST_FOV_CLIP )
131 }
132
133
134 // Basically, this is a modified version of the Mesa gluLookAt()
135 // function that's been modified slightly so we can capture the
136 // result before sending it off to OpenGL land.
137 void FGView::LookAt( GLdouble eyex, GLdouble eyey, GLdouble eyez,
138                      GLdouble centerx, GLdouble centery, GLdouble centerz,
139                      GLdouble upx, GLdouble upy, GLdouble upz ) {
140     GLfloat *m;
141     GLdouble x[3], y[3], z[3];
142     GLdouble mag;
143
144     m = current_view.MODEL_VIEW;
145
146     /* Make rotation matrix */
147
148     /* Z vector */
149     z[0] = eyex - centerx;
150     z[1] = eyey - centery;
151     z[2] = eyez - centerz;
152     mag = sqrt( z[0]*z[0] + z[1]*z[1] + z[2]*z[2] );
153     if (mag) {  /* mpichler, 19950515 */
154         z[0] /= mag;
155         z[1] /= mag;
156         z[2] /= mag;
157     }
158
159     /* Y vector */
160     y[0] = upx;
161     y[1] = upy;
162     y[2] = upz;
163
164     /* X vector = Y cross Z */
165     x[0] =  y[1]*z[2] - y[2]*z[1];
166     x[1] = -y[0]*z[2] + y[2]*z[0];
167     x[2] =  y[0]*z[1] - y[1]*z[0];
168     
169     /* Recompute Y = Z cross X */
170     y[0] =  z[1]*x[2] - z[2]*x[1];
171     y[1] = -z[0]*x[2] + z[2]*x[0];
172     y[2] =  z[0]*x[1] - z[1]*x[0];
173
174     /* mpichler, 19950515 */
175     /* cross product gives area of parallelogram, which is < 1.0 for
176      * non-perpendicular unit-length vectors; so normalize x, y here
177      */
178
179     mag = sqrt( x[0]*x[0] + x[1]*x[1] + x[2]*x[2] );
180     if (mag) {
181         x[0] /= mag;
182         x[1] /= mag;
183         x[2] /= mag;
184     }
185
186     mag = sqrt( y[0]*y[0] + y[1]*y[1] + y[2]*y[2] );
187     if (mag) {
188         y[0] /= mag;
189         y[1] /= mag;
190         y[2] /= mag;
191     }
192
193 #define M(row,col)  m[col*4+row]
194     M(0,0) = x[0];  M(0,1) = x[1];  M(0,2) = x[2];  M(0,3) = 0.0;
195     M(1,0) = y[0];  M(1,1) = y[1];  M(1,2) = y[2];  M(1,3) = 0.0;
196     M(2,0) = z[0];  M(2,1) = z[1];  M(2,2) = z[2];  M(2,3) = 0.0;
197     // the following is part of the original gluLookAt(), but we are
198     // commenting it out because we know we are going to be doing a
199     // translation below which will set these values anyways
200     // M(3,0) = 0.0;   M(3,1) = 0.0;   M(3,2) = 0.0;   M(3,3) = 1.0;
201 #undef M
202
203     // Translate Eye to Origin
204     // replaces: glTranslated( -eyex, -eyey, -eyez );
205
206     // this has been slightly modified from the original glTranslate()
207     // code because we know that coming into this m[12] = m[13] =
208     // m[14] = 0.0, and m[15] = 1.0;
209     m[12] = m[0] * -eyex + m[4] * -eyey + m[8]  * -eyez /* + m[12] */;
210     m[13] = m[1] * -eyex + m[5] * -eyey + m[9]  * -eyez /* + m[13] */;
211     m[14] = m[2] * -eyex + m[6] * -eyey + m[10] * -eyez /* + m[14] */;
212     m[15] = 1.0 /* m[3] * -eyex + m[7] * -eyey + m[11] * -eyez + m[15] */;
213
214     // xglMultMatrixd( m );
215     xglLoadMatrixf( m );
216 }
217
218
219 // Update the view volume, position, and orientation
220 void FGView::UpdateViewParams( void ) {
221     FGInterface *f = current_aircraft.fdm_state;
222
223     UpdateViewMath(f);
224     UpdateWorldToEye(f);
225     
226     if ((current_options.get_panel_status() != panel_hist) &&                          (current_options.get_panel_status()))
227     {
228         FGPanel::OurPanel->ReInit( 0, 0, 1024, 768);
229     }
230
231     if ( ! current_options.get_panel_status() ) {
232         xglViewport(0, 0 , (GLint)(winWidth), (GLint)(winHeight) );
233     } else {
234         xglViewport(0, (GLint)((winHeight)*0.5768), (GLint)(winWidth), 
235                     (GLint)((winHeight)*0.4232) );
236     }
237
238     // Tell GL we are about to modify the projection parameters
239     xglMatrixMode(GL_PROJECTION);
240     xglLoadIdentity();
241     if ( f->get_Altitude() * FEET_TO_METER - scenery.cur_elev > 10.0 ) {
242         ssgSetNearFar( 10.0, 100000.0 );
243         gluPerspective(current_options.get_fov(), win_ratio, 10.0, 100000.0);
244     } else {
245         ssgSetNearFar( 0.5, 100000.0 );
246         gluPerspective(current_options.get_fov(), win_ratio, 0.5, 100000.0);
247         // printf("Near ground, minimizing near clip plane\n");
248     }
249     // }
250
251     xglMatrixMode(GL_MODELVIEW);
252     xglLoadIdentity();
253
254     // set up our view volume (default)
255 #if !defined(FG_VIEW_INLINE_OPTIMIZATIONS)
256     LookAt(view_pos.x(), view_pos.y(), view_pos.z(),
257            view_pos.x() + view_forward[0], 
258            view_pos.y() + view_forward[1], 
259            view_pos.z() + view_forward[2],
260            view_up[0], view_up[1], view_up[2]);
261
262     // look almost straight up (testing and eclipse watching)
263     /* LookAt(view_pos.x(), view_pos.y(), view_pos.z(),
264        view_pos.x() + view_up[0] + .001, 
265        view_pos.y() + view_up[1] + .001, 
266        view_pos.z() + view_up[2] + .001,
267        view_up[0], view_up[1], view_up[2]); */
268
269     // lock view horizontally towards sun (testing)
270     /* LookAt(view_pos.x(), view_pos.y(), view_pos.z(),
271        view_pos.x() + surface_to_sun[0], 
272        view_pos.y() + surface_to_sun[1], 
273        view_pos.z() + surface_to_sun[2],
274        view_up[0], view_up[1], view_up[2]); */
275
276     // lock view horizontally towards south (testing)
277     /* LookAt(view_pos.x(), view_pos.y(), view_pos.z(),
278        view_pos.x() + surface_south[0], 
279        view_pos.y() + surface_south[1], 
280        view_pos.z() + surface_south[2],
281        view_up[0], view_up[1], view_up[2]); */
282
283 #else // defined(FG_VIEW_INLINE_OPTIMIZATIONS)
284     //void FGView::LookAt( GLdouble eyex, GLdouble eyey, GLdouble eyez,
285     //               GLdouble centerx, GLdouble centery, GLdouble centerz,
286     //               GLdouble upx, GLdouble upy, GLdouble upz )
287     {
288         GLfloat *m;
289         GLdouble x[3], y[3], z[3];
290         //    GLdouble mag;
291
292         m = current_view.MODEL_VIEW;
293
294         /* Make rotation matrix */
295
296         /* Z vector */
297         z[0] = -view_forward[0]; //eyex - centerx;
298         z[1] = -view_forward[1]; //eyey - centery;
299         z[2] = -view_forward[2]; //eyez - centerz;
300         
301         // In our case this is a unit vector  NHV
302         
303         //    mag = sqrt( z[0]*z[0] + z[1]*z[1] + z[2]*z[2] );
304         //    if (mag) {  /* mpichler, 19950515 */
305         //              mag = 1.0/mag;
306         //              printf("mag(%f)  ", mag);
307         //      z[0] *= mag;
308         //      z[1] *= mag;
309         //      z[2] *= mag;
310         //    }
311
312         /* Y vector */
313         y[0] = view_up[0]; //upx;
314         y[1] = view_up[1]; //upy;
315         y[2] = view_up[2]; //upz;
316
317         /* X vector = Y cross Z */
318         x[0] =  y[1]*z[2] - y[2]*z[1];
319         x[1] = -y[0]*z[2] + y[2]*z[0];
320         x[2] =  y[0]*z[1] - y[1]*z[0];
321
322         //      printf(" %f %f %f  ", y[0], y[1], y[2]);
323     
324         /* Recompute Y = Z cross X */
325         //    y[0] =  z[1]*x[2] - z[2]*x[1];
326         //    y[1] = -z[0]*x[2] + z[2]*x[0];
327         //    y[2] =  z[0]*x[1] - z[1]*x[0];
328
329         //      printf(" %f %f %f\n", y[0], y[1], y[2]);
330         
331         // In our case these are unit vectors  NHV
332
333         /* mpichler, 19950515 */
334         /* cross product gives area of parallelogram, which is < 1.0 for
335          * non-perpendicular unit-length vectors; so normalize x, y here
336          */
337
338         //    mag = sqrt( x[0]*x[0] + x[1]*x[1] + x[2]*x[2] );
339         //    if (mag) {
340         //              mag = 1.0/mag;
341         //              printf("mag2(%f) ", mag);
342         //      x[0] *= mag;
343         //      x[1] *= mag;
344         //      x[2] *= mag;
345         //    }
346
347         //    mag = sqrt( y[0]*y[0] + y[1]*y[1] + y[2]*y[2] );
348         //    if (mag) {
349         //              mag = 1.0/mag;
350         //              printf("mag3(%f)\n", mag);
351         //      y[0] *= mag;
352         //      y[1] *= mag;
353         //      y[2] *= mag;
354         //    }
355
356 #define M(row,col)  m[col*4+row]
357         M(0,0) = x[0];  M(0,1) = x[1];  M(0,2) = x[2];  M(0,3) = 0.0;
358         M(1,0) = y[0];  M(1,1) = y[1];  M(1,2) = y[2];  M(1,3) = 0.0;
359         M(2,0) = z[0];  M(2,1) = z[1];  M(2,2) = z[2];  M(2,3) = 0.0;
360         // the following is part of the original gluLookAt(), but we are
361         // commenting it out because we know we are going to be doing a
362         // translation below which will set these values anyways
363         // M(3,0) = 0.0;   M(3,1) = 0.0;   M(3,2) = 0.0;   M(3,3) = 1.0;
364 #undef M
365
366         // Translate Eye to Origin
367         // replaces: glTranslated( -eyex, -eyey, -eyez );
368
369         // this has been slightly modified from the original glTranslate()
370         // code because we know that coming into this m[12] = m[13] =
371         // m[14] = 0.0, and m[15] = 1.0;
372         m[12] = m[0] * -view_pos.x() + m[4] * -view_pos.y() + m[8]  * -view_pos.z() /* + m[12] */;
373         m[13] = m[1] * -view_pos.x() + m[5] * -view_pos.y() + m[9]  * -view_pos.z() /* + m[13] */;
374         m[14] = m[2] * -view_pos.x() + m[6] * -view_pos.y() + m[10] * -view_pos.z() /* + m[14] */;
375         m[15] = 1.0 /* m[3] * -view_pos.x() + m[7] * -view_pos.y() + m[11] * -view_pos.z() + m[15] */;
376
377         // xglMultMatrixd( m );
378         xglLoadMatrixf( m );
379     }
380 #endif // FG_VIEW_INLINE_OPTIMIZATIONS
381         
382
383     panel_hist = current_options.get_panel_status();
384 }
385
386
387 void getRotMatrix(double* out, MAT3vec vec, double radians)
388 {
389     /* This function contributed by Erich Boleyn (erich@uruk.org) */
390     /* This function used from the Mesa OpenGL code (matrix.c)  */
391     double s, c; // mag,
392     double vx, vy, vz, xy, yz, zx, xs, ys, zs, one_c; //, xx, yy, zz
393   
394     MAT3identity(out);
395     s = sin(radians);
396     c = cos(radians);
397   
398     //  mag = getMagnitude();
399   
400     vx = vec[0];
401     vy = vec[1];
402     vz = vec[2];
403   
404 #define M(row,col)  out[row*4 + col]
405   
406     /*
407      *     Arbitrary axis rotation matrix.
408      *
409      *  This is composed of 5 matrices, Rz, Ry, T, Ry', Rz', multiplied
410      *  like so:  Rz * Ry * T * Ry' * Rz'.  T is the final rotation
411      *  (which is about the X-axis), and the two composite transforms
412      *  Ry' * Rz' and Rz * Ry are (respectively) the rotations necessary
413      *  from the arbitrary axis to the X-axis then back.  They are
414      *  all elementary rotations.
415      *
416      *  Rz' is a rotation about the Z-axis, to bring the axis vector
417      *  into the x-z plane.  Then Ry' is applied, rotating about the
418      *  Y-axis to bring the axis vector parallel with the X-axis.  The
419      *  rotation about the X-axis is then performed.  Ry and Rz are
420      *  simply the respective inverse transforms to bring the arbitrary
421      *  axis back to it's original orientation.  The first transforms
422      *  Rz' and Ry' are considered inverses, since the data from the
423      *  arbitrary axis gives you info on how to get to it, not how
424      *  to get away from it, and an inverse must be applied.
425      *
426      *  The basic calculation used is to recognize that the arbitrary
427      *  axis vector (x, y, z), since it is of unit length, actually
428      *  represents the sines and cosines of the angles to rotate the
429      *  X-axis to the same orientation, with theta being the angle about
430      *  Z and phi the angle about Y (in the order described above)
431      *  as follows:
432      *
433      *  cos ( theta ) = x / sqrt ( 1 - z^2 )
434      *  sin ( theta ) = y / sqrt ( 1 - z^2 )
435      *
436      *  cos ( phi ) = sqrt ( 1 - z^2 )
437      *  sin ( phi ) = z
438      *
439      *  Note that cos ( phi ) can further be inserted to the above
440      *  formulas:
441      *
442      *  cos ( theta ) = x / cos ( phi )
443      *  sin ( theta ) = y / cos ( phi )
444      *
445      *  ...etc.  Because of those relations and the standard trigonometric
446      *  relations, it is pssible to reduce the transforms down to what
447      *  is used below.  It may be that any primary axis chosen will give the
448      *  same results (modulo a sign convention) using thie method.
449      *
450      *  Particularly nice is to notice that all divisions that might
451      *  have caused trouble when parallel to certain planes or
452      *  axis go away with care paid to reducing the expressions.
453      *  After checking, it does perform correctly under all cases, since
454      *  in all the cases of division where the denominator would have
455      *  been zero, the numerator would have been zero as well, giving
456      *  the expected result.
457      */
458     
459     one_c = 1.0F - c;
460     
461     //  xx = vx * vx;
462     //  yy = vy * vy;
463     //  zz = vz * vz;
464   
465     //  xy = vx * vy;
466     //  yz = vy * vz;
467     //  zx = vz * vx;
468   
469   
470     M(0,0) = (one_c * vx * vx) + c;  
471     xs = vx * s;
472     yz = vy * vz * one_c;
473     M(1,2) = yz + xs;
474     M(2,1) = yz - xs;
475
476     M(1,1) = (one_c * vy * vy) + c;
477     ys = vy * s;
478     zx = vz * vx * one_c;
479     M(0,2) = zx - ys;
480     M(2,0) = zx + ys;
481   
482     M(2,2) = (one_c * vz *vz) + c;
483     zs = vz * s;
484     xy = vx * vy * one_c;
485     M(0,1) = xy + zs;
486     M(1,0) = xy - zs;
487   
488     //  M(0,0) = (one_c * xx) + c;
489     //  M(1,0) = (one_c * xy) - zs;
490     //  M(2,0) = (one_c * zx) + ys;
491   
492     //  M(0,1) = (one_c * xy) + zs;
493     //  M(1,1) = (one_c * yy) + c;
494     //  M(2,1) = (one_c * yz) - xs;
495   
496     //  M(0,2) = (one_c * zx) - ys;
497     //  M(1,2) = (one_c * yz) + xs;
498     //  M(2,2) = (one_c * zz) + c;
499   
500 #undef M
501 }
502
503
504 // Update the view parameters
505 void FGView::UpdateViewMath( FGInterface *f ) {
506     Point3D p;
507     MAT3vec vec, forward, v0, minus_z;
508     MAT3mat R, TMP, UP, LOCAL, VIEW;
509     double ntmp;
510
511     if ( update_fov ) {
512         // printf("Updating fov\n");
513         UpdateFOV( current_options );
514         update_fov = false;
515     }
516                 
517     scenery.center = scenery.next_center;
518
519 #if !defined(FG_VIEW_INLINE_OPTIMIZATIONS)
520     // printf("scenery center = %.2f %.2f %.2f\n", scenery.center.x,
521     //        scenery.center.y, scenery.center.z);
522
523     // calculate the cartesion coords of the current lat/lon/0 elev
524     p = Point3D( f->get_Longitude(), 
525                  f->get_Lat_geocentric(), 
526                  f->get_Sea_level_radius() * FEET_TO_METER );
527
528     cur_zero_elev = fgPolarToCart3d(p) - scenery.center;
529
530     // calculate view position in current FG view coordinate system
531     // p.lon & p.lat are already defined earlier, p.radius was set to
532     // the sea level radius, so now we add in our altitude.
533     if ( f->get_Altitude() * FEET_TO_METER > 
534          (scenery.cur_elev + 0.5 * METER_TO_FEET) ) {
535         p.setz( p.radius() + f->get_Altitude() * FEET_TO_METER );
536     } else {
537         p.setz( p.radius() + scenery.cur_elev + 0.5 * METER_TO_FEET );
538     }
539
540     abs_view_pos = fgPolarToCart3d(p);
541         
542 #else // FG_VIEW_INLINE_OPTIMIZATIONS
543         
544     double tmp_radius = f->get_Sea_level_radius() * FEET_TO_METER;
545     double tmp = f->get_cos_lat_geocentric() * tmp_radius;
546         
547     cur_zero_elev.setx(f->get_cos_longitude()*tmp - scenery.center.x());
548     cur_zero_elev.sety(f->get_sin_longitude()*tmp - scenery.center.y());
549     cur_zero_elev.setz(f->get_sin_lat_geocentric()*tmp_radius - scenery.center.z());
550
551     // calculate view position in current FG view coordinate system
552     // p.lon & p.lat are already defined earlier, p.radius was set to
553     // the sea level radius, so now we add in our altitude.
554     if ( f->get_Altitude() * FEET_TO_METER > 
555          (scenery.cur_elev + 0.5 * METER_TO_FEET) ) {
556         tmp_radius += f->get_Altitude() * FEET_TO_METER;
557     } else {
558         tmp_radius += scenery.cur_elev + 0.5 * METER_TO_FEET ;
559     }
560     tmp = f->get_cos_lat_geocentric() * tmp_radius;
561     abs_view_pos.setx(f->get_cos_longitude()*tmp);
562     abs_view_pos.sety(f->get_sin_longitude()*tmp);
563     abs_view_pos.setz(f->get_sin_lat_geocentric()*tmp_radius);
564         
565 #endif // FG_VIEW_INLINE_OPTIMIZATIONS
566         
567     view_pos = abs_view_pos - scenery.center;
568
569     FG_LOG( FG_VIEW, FG_DEBUG, "Polar view pos = " << p );
570     FG_LOG( FG_VIEW, FG_DEBUG, "Absolute view pos = " << abs_view_pos );
571     FG_LOG( FG_VIEW, FG_DEBUG, "Relative view pos = " << view_pos );
572
573     // Derive the LOCAL aircraft rotation matrix (roll, pitch, yaw)
574     // from FG_T_local_to_body[3][3]
575
576     if ( use_larcsim_local_to_body ) {
577
578         // Question: Why is the LaRCsim matrix arranged so differently
579         // than the one we need???
580
581         // Answer (I think): The LaRCsim matrix is generated in a
582         // different reference frame than we've set up for our world
583
584         LOCAL[0][0] = f->get_T_local_to_body_33();
585         LOCAL[0][1] = -f->get_T_local_to_body_32();
586         LOCAL[0][2] = -f->get_T_local_to_body_31();
587         LOCAL[0][3] = 0.0;
588         LOCAL[1][0] = -f->get_T_local_to_body_23();
589         LOCAL[1][1] = f->get_T_local_to_body_22();
590         LOCAL[1][2] = f->get_T_local_to_body_21();
591         LOCAL[1][3] = 0.0;
592         LOCAL[2][0] = -f->get_T_local_to_body_13();
593         LOCAL[2][1] = f->get_T_local_to_body_12();
594         LOCAL[2][2] = f->get_T_local_to_body_11();
595         LOCAL[2][3] = 0.0;
596         LOCAL[3][0] = LOCAL[3][1] = LOCAL[3][2] = LOCAL[3][3] = 0.0;
597         LOCAL[3][3] = 1.0;
598
599         // printf("LaRCsim LOCAL matrix\n");
600         // MAT3print(LOCAL, stdout);
601
602     } else {
603
604         // code to calculate LOCAL matrix calculated from Phi, Theta, and
605         // Psi (roll, pitch, yaw) in case we aren't running LaRCsim as our
606         // flight model
607
608         MAT3_SET_VEC(vec, 0.0, 0.0, 1.0);
609         MAT3rotate(R, vec, f->get_Phi());
610         /* printf("Roll matrix\n"); */
611         /* MAT3print(R, stdout); */
612
613         MAT3_SET_VEC(vec, 0.0, 1.0, 0.0);
614         /* MAT3mult_vec(vec, vec, R); */
615         MAT3rotate(TMP, vec, f->get_Theta());
616         /* printf("Pitch matrix\n"); */
617         /* MAT3print(TMP, stdout); */
618         MAT3mult(R, R, TMP);
619
620         MAT3_SET_VEC(vec, 1.0, 0.0, 0.0);
621         /* MAT3mult_vec(vec, vec, R); */
622         /* MAT3rotate(TMP, vec, FG_Psi - FG_PI_2); */
623         MAT3rotate(TMP, vec, -f->get_Psi());
624         /* printf("Yaw matrix\n");
625            MAT3print(TMP, stdout); */
626         MAT3mult(LOCAL, R, TMP);
627         // printf("FG derived LOCAL matrix\n");
628         // MAT3print(LOCAL, stdout);
629
630     } // if ( use_larcsim_local_to_body ) 
631
632 #if !defined(FG_VIEW_INLINE_OPTIMIZATIONS)
633         
634     // Derive the local UP transformation matrix based on *geodetic*
635     // coordinates
636     MAT3_SET_VEC(vec, 0.0, 0.0, 1.0);
637     MAT3rotate(R, vec, f->get_Longitude());     // R = rotate about Z axis
638     // printf("Longitude matrix\n");
639     // MAT3print(R, stdout);
640
641     MAT3_SET_VEC(vec, 0.0, 1.0, 0.0);
642     MAT3mult_vec(vec, vec, R);
643     MAT3rotate(TMP, vec, -f->get_Latitude());  // TMP = rotate about X axis
644     // printf("Latitude matrix\n");
645     // MAT3print(TMP, stdout);
646
647     MAT3mult(UP, R, TMP);
648     // printf("Local up matrix\n");
649     // MAT3print(UP, stdout);
650
651     MAT3_SET_VEC(local_up, 1.0, 0.0, 0.0);
652     MAT3mult_vec(local_up, local_up, UP);
653
654     // printf( "Local Up = (%.4f, %.4f, %.4f)\n",
655     //         local_up[0], local_up[1], local_up[2]);
656     
657     // Alternative method to Derive local up vector based on
658     // *geodetic* coordinates
659     // alt_up = fgPolarToCart(FG_Longitude, FG_Latitude, 1.0);
660     // printf( "    Alt Up = (%.4f, %.4f, %.4f)\n", 
661     //         alt_up.x, alt_up.y, alt_up.z);
662
663     // Calculate the VIEW matrix
664     MAT3mult(VIEW, LOCAL, UP);
665     // printf("VIEW matrix\n");
666     // MAT3print(VIEW, stdout);
667
668     // generate the current up, forward, and fwrd-view vectors
669     MAT3_SET_VEC(vec, 1.0, 0.0, 0.0);
670     MAT3mult_vec(view_up, vec, VIEW);
671
672     MAT3_SET_VEC(vec, 0.0, 0.0, 1.0);
673     MAT3mult_vec(forward, vec, VIEW);
674     // printf( "Forward vector is (%.2f,%.2f,%.2f)\n", forward[0], forward[1], 
675     //         forward[2]);
676
677     MAT3rotate(TMP, view_up, view_offset);
678     MAT3mult_vec(view_forward, forward, TMP);
679
680     // make a vector to the current view position
681     MAT3_SET_VEC(v0, view_pos.x(), view_pos.y(), view_pos.z());
682
683     // Given a vector pointing straight down (-Z), map into onto the
684     // local plane representing "horizontal".  This should give us the
685     // local direction for moving "south".
686     MAT3_SET_VEC(minus_z, 0.0, 0.0, -1.0);
687     map_vec_onto_cur_surface_plane(local_up, v0, minus_z, surface_south);
688     MAT3_NORMALIZE_VEC(surface_south, ntmp);
689     // printf( "Surface direction directly south %.2f %.2f %.2f\n",
690     //         surface_south[0], surface_south[1], surface_south[2]);
691
692     // now calculate the surface east vector
693     MAT3rotate(TMP, view_up, FG_PI_2);
694     MAT3mult_vec(surface_east, surface_south, TMP);
695     // printf( "Surface direction directly east %.2f %.2f %.2f\n",
696     //         surface_east[0], surface_east[1], surface_east[2]);
697     // printf( "Should be close to zero = %.2f\n", 
698     //         MAT3_DOT_PRODUCT(surface_south, surface_east));
699         
700 #else // FG_VIEW_INLINE_OPTIMIZATIONS
701          
702     //  // Build spherical to cartesian transform matrix directly
703     double cos_lat = f->get_cos_latitude(); // cos(-f->get_Latitude());
704     double sin_lat = -f->get_sin_latitude(); // sin(-f->get_Latitude());
705     double cos_lon = f->get_cos_longitude(); //cos(f->get_Longitude());
706     double sin_lon = f->get_sin_longitude(); //sin(f->get_Longitude());
707
708     double *mat = (double *)UP;
709         
710     mat[0] =  cos_lat*cos_lon;
711     mat[1] =  cos_lat*sin_lon;
712     mat[2] = -sin_lat;
713     mat[3] =  0.0;
714     mat[4] =  -sin_lon;
715     mat[5] =  cos_lon;
716     mat[6] =  0.0;
717     mat[7] =  0.0;
718     mat[8]  =  sin_lat*cos_lon;
719     mat[9]  =  sin_lat*sin_lon;
720     mat[10] =  cos_lat;
721     mat[11] =  mat[12] = mat[13] = mat[14] = 0.0;
722     mat[15] =  1.0;
723
724     MAT3mult(VIEW, LOCAL, UP);
725         
726     // THESE COULD JUST BE POINTERS !!!
727     MAT3_SET_VEC(local_up, mat[0],     mat[1],     mat[2]);
728     MAT3_SET_VEC(view_up,  VIEW[0][0], VIEW[0][1], VIEW[0][2]);
729     MAT3_SET_VEC(forward,  VIEW[2][0], VIEW[2][1], VIEW[2][2]);
730
731     getRotMatrix((double *)TMP, view_up, view_offset);
732     MAT3mult_vec(view_forward, forward, TMP);
733
734     // make a vector to the current view position
735     MAT3_SET_VEC(v0, view_pos.x(), view_pos.y(), view_pos.z());
736
737     // Given a vector pointing straight down (-Z), map into onto the
738     // local plane representing "horizontal".  This should give us the
739     // local direction for moving "south".
740     MAT3_SET_VEC(minus_z, 0.0, 0.0, -1.0);
741     map_vec_onto_cur_surface_plane(local_up, v0, minus_z, surface_south);
742
743     MAT3_NORMALIZE_VEC(surface_south, ntmp);
744     // printf( "Surface direction directly south %.6f %.6f %.6f\n",
745     //         surface_south[0], surface_south[1], surface_south[2]);
746
747     // now calculate the surface east vector
748     getRotMatrix((double *)TMP, view_up, FG_PI_2);
749     MAT3mult_vec(surface_east, surface_south, TMP);
750     // printf( "Surface direction directly east %.6f %.6f %.6f\n",
751     //         surface_east[0], surface_east[1], surface_east[2]);
752     // printf( "Should be close to zero = %.6f\n", 
753     //         MAT3_DOT_PRODUCT(surface_south, surface_east));
754 #endif // !defined(FG_VIEW_INLINE_OPTIMIZATIONS)
755 }
756
757
758 // Update the "World to Eye" transformation matrix
759 // This is most useful for view frustum culling
760 void FGView::UpdateWorldToEye( FGInterface *f ) {
761     MAT3mat R_Phi, R_Theta, R_Psi, R_Lat, R_Lon, T_view;
762     MAT3mat TMP;
763     MAT3hvec vec;
764
765     if ( use_larcsim_local_to_body ) {
766
767         // Question: hey this is even different then LOCAL[][] above??
768         // Answer: yet another coordinate system, this time the
769         // coordinate system in which we do our view frustum culling.
770
771         AIRCRAFT[0][0] = -f->get_T_local_to_body_22();
772         AIRCRAFT[0][1] = -f->get_T_local_to_body_23();
773         AIRCRAFT[0][2] = f->get_T_local_to_body_21();
774         AIRCRAFT[0][3] = 0.0;
775         AIRCRAFT[1][0] = f->get_T_local_to_body_32();
776         AIRCRAFT[1][1] = f->get_T_local_to_body_33();
777         AIRCRAFT[1][2] = -f->get_T_local_to_body_31();
778         AIRCRAFT[1][3] = 0.0;
779         AIRCRAFT[2][0] = f->get_T_local_to_body_12();
780         AIRCRAFT[2][1] = f->get_T_local_to_body_13();
781         AIRCRAFT[2][2] = -f->get_T_local_to_body_11();
782         AIRCRAFT[2][3] = 0.0;
783         AIRCRAFT[3][0] = AIRCRAFT[3][1] = AIRCRAFT[3][2] = AIRCRAFT[3][3] = 0.0;
784         AIRCRAFT[3][3] = 1.0;
785
786     } else {
787
788         // Roll Matrix
789         MAT3_SET_HVEC(vec, 0.0, 0.0, -1.0, 1.0);
790         MAT3rotate(R_Phi, vec, f->get_Phi());
791         // printf("Roll matrix (Phi)\n");
792         // MAT3print(R_Phi, stdout);
793
794         // Pitch Matrix
795         MAT3_SET_HVEC(vec, 1.0, 0.0, 0.0, 1.0);
796         MAT3rotate(R_Theta, vec, f->get_Theta());
797         // printf("\nPitch matrix (Theta)\n");
798         // MAT3print(R_Theta, stdout);
799
800         // Yaw Matrix
801         MAT3_SET_HVEC(vec, 0.0, -1.0, 0.0, 1.0);
802         MAT3rotate(R_Psi, vec, f->get_Psi() + FG_PI /* - view_offset */ );
803         // MAT3rotate(R_Psi, vec, f->get_Psi() + FG_PI - view_offset );
804         // printf("\nYaw matrix (Psi)\n");
805         // MAT3print(R_Psi, stdout);
806
807         // aircraft roll/pitch/yaw
808         MAT3mult(TMP, R_Phi, R_Theta);
809         MAT3mult(AIRCRAFT, TMP, R_Psi);
810
811     } // if ( use_larcsim_local_to_body )
812
813 #if !defined(FG_VIEW_INLINE_OPTIMIZATIONS)
814         
815     // printf("AIRCRAFT matrix\n");
816     // MAT3print(AIRCRAFT, stdout);
817
818     // View rotation matrix relative to current aircraft orientation
819     MAT3_SET_HVEC(vec, 0.0, -1.0, 0.0, 1.0);
820     MAT3mult_vec(vec, vec, AIRCRAFT);
821     // printf("aircraft up vector = %.2f %.2f %.2f\n", 
822     //        vec[0], vec[1], vec[2]);
823     MAT3rotate(TMP, vec, -view_offset );
824     MAT3mult(VIEW_OFFSET, AIRCRAFT, TMP);
825     // printf("VIEW_OFFSET matrix\n");
826     // MAT3print(VIEW_OFFSET, stdout);
827
828     // View position in scenery centered coordinates
829     MAT3_SET_HVEC(vec, view_pos.x(), view_pos.y(), view_pos.z(), 1.0);
830     MAT3translate(T_view, vec);
831     // printf("\nTranslation matrix\n");
832     // MAT3print(T_view, stdout);
833
834     // Latitude
835     MAT3_SET_HVEC(vec, 1.0, 0.0, 0.0, 1.0);
836     // R_Lat = rotate about X axis
837     MAT3rotate(R_Lat, vec, f->get_Latitude());
838     // printf("\nLatitude matrix\n");
839     // MAT3print(R_Lat, stdout);
840
841     // Longitude
842     MAT3_SET_HVEC(vec, 0.0, 0.0, 1.0, 1.0);
843     // R_Lon = rotate about Z axis
844     MAT3rotate(R_Lon, vec, f->get_Longitude() - FG_PI_2 );
845     // printf("\nLongitude matrix\n");
846     // MAT3print(R_Lon, stdout);
847
848     // lon/lat
849     MAT3mult(WORLD, R_Lat, R_Lon);
850     // printf("\nworld\n");
851     // MAT3print(WORLD, stdout);
852
853     MAT3mult(EYE_TO_WORLD, VIEW_OFFSET, WORLD);
854     MAT3mult(EYE_TO_WORLD, EYE_TO_WORLD, T_view);
855     // printf("\nEye to world\n");
856     // MAT3print(EYE_TO_WORLD, stdout);
857
858     MAT3invert(WORLD_TO_EYE, EYE_TO_WORLD);
859     // printf("\nWorld to eye\n");
860     // MAT3print(WORLD_TO_EYE, stdout);
861
862     // printf( "\nview_pos = %.2f %.2f %.2f\n", 
863     //         view_pos.x, view_pos.y, view_pos.z );
864
865     // MAT3_SET_HVEC(eye, 0.0, 0.0, 0.0, 1.0);
866     // MAT3mult_vec(vec, eye, EYE_TO_WORLD);
867     // printf("\neye -> world = %.2f %.2f %.2f\n", vec[0], vec[1], vec[2]);
868
869     // MAT3_SET_HVEC(vec1, view_pos.x, view_pos.y, view_pos.z, 1.0);
870     // MAT3mult_vec(vec, vec1, WORLD_TO_EYE);
871     // printf( "\nabs_view_pos -> eye = %.2f %.2f %.2f\n", 
872     //         vec[0], vec[1], vec[2]);
873 #else  // FG_VIEW_INLINE_OPTIMIZATIONS
874         
875     MAT3_SET_HVEC(vec, -AIRCRAFT[1][0], -AIRCRAFT[1][1], -AIRCRAFT[1][2], -AIRCRAFT[1][3]);
876     getRotMatrix((double *)TMP, vec, -view_offset );
877     MAT3mult(VIEW_OFFSET, AIRCRAFT, TMP);
878     // MAT3print_formatted(VIEW_OFFSET, stdout, "VIEW_OFFSET matrix:\n",
879     //                                   NULL, "%#8.6f  ", "\n");
880
881     // Build spherical to cartesian transform matrix directly
882     double *mat = (double *)WORLD; //T_view; //WORLD;
883     double cos_lat = f->get_cos_latitude(); //cos(f->get_Latitude());
884     double sin_lat = f->get_sin_latitude(); //sin(f->get_Latitude());
885     // using trig identities  this:
886     //  mat[0]  =  cos(f->get_Longitude() - FG_PI_2);//cos_lon;
887     //  mat[1]  =  sin(f->get_Longitude() - FG_PI_2);//sin_lon;
888     // becomes this: :-)
889     mat[0]  =  f->get_sin_longitude(); //cos_lon;
890     mat[1]  = -f->get_cos_longitude(); //sin_lon;
891     mat[4]  = -cos_lat*mat[1]; //mat[1]=sin_lon;
892     mat[5]  =  cos_lat*mat[0]; //mat[0]=cos_lon;
893     mat[6]  =  sin_lat;
894     mat[8]  =  sin_lat*mat[1]; //mat[1]=sin_lon;
895     mat[9]  = -sin_lat*mat[0]; //mat[0]=cos_lon;
896     mat[10] =  cos_lat;
897
898     // BUILD EYE_TO_WORLD = AIRCRAFT * WORLD
899     // and WORLD_TO_EYE = Inverse( EYE_TO_WORLD) concurrently
900     // by Transposing the 3x3 rotation sub-matrix
901     WORLD_TO_EYE[0][0] = EYE_TO_WORLD[0][0] =
902         VIEW_OFFSET[0][0]*mat[0] + VIEW_OFFSET[0][1]*mat[4] + VIEW_OFFSET[0][2]*mat[8];
903         
904     WORLD_TO_EYE[1][0] = EYE_TO_WORLD[0][1] =
905         VIEW_OFFSET[0][0]*mat[1] + VIEW_OFFSET[0][1]*mat[5] + VIEW_OFFSET[0][2]*mat[9];
906         
907     WORLD_TO_EYE[2][0] = EYE_TO_WORLD[0][2] =
908         VIEW_OFFSET[0][1]*mat[6] + VIEW_OFFSET[0][2]*mat[10];
909         
910     WORLD_TO_EYE[0][1] = EYE_TO_WORLD[1][0] =
911         VIEW_OFFSET[1][0]*mat[0] + VIEW_OFFSET[1][1]*mat[4] + VIEW_OFFSET[1][2]*mat[8];
912         
913     WORLD_TO_EYE[1][1] = EYE_TO_WORLD[1][1] =
914         VIEW_OFFSET[1][0]*mat[1] + VIEW_OFFSET[1][1]*mat[5] + VIEW_OFFSET[1][2]*mat[9];
915         
916     WORLD_TO_EYE[2][1] = EYE_TO_WORLD[1][2] =
917         VIEW_OFFSET[1][1]*mat[6] + VIEW_OFFSET[1][2]*mat[10];
918         
919     WORLD_TO_EYE[0][2] = EYE_TO_WORLD[2][0] =
920         VIEW_OFFSET[2][0]*mat[0] + VIEW_OFFSET[2][1]*mat[4] + VIEW_OFFSET[2][2]*mat[8];
921         
922     WORLD_TO_EYE[1][2] = EYE_TO_WORLD[2][1] =
923         VIEW_OFFSET[2][0]*mat[1] + VIEW_OFFSET[2][1]*mat[5] + VIEW_OFFSET[2][2]*mat[9];
924         
925     WORLD_TO_EYE[2][2] = EYE_TO_WORLD[2][2] =
926         VIEW_OFFSET[2][1]*mat[6] + VIEW_OFFSET[2][2]*mat[10];
927         
928     // TRANSLATE TO VIEW POSITION
929     EYE_TO_WORLD[3][0] = view_pos.x();
930     EYE_TO_WORLD[3][1] = view_pos.y();
931     EYE_TO_WORLD[3][2] = view_pos.z();
932         
933     // FILL 0 ENTRIES
934     WORLD_TO_EYE[0][3] = WORLD_TO_EYE[1][3] = WORLD_TO_EYE[2][3] = 
935         EYE_TO_WORLD[0][3] = EYE_TO_WORLD[1][3] = EYE_TO_WORLD[2][3] = 0.0;
936
937     // FILL UNITY ENTRIES
938     WORLD_TO_EYE[3][3] = EYE_TO_WORLD[3][3] = 1.0;
939         
940     /* MAKE THE INVERTED TRANSLATIONS */
941     mat = (double *)EYE_TO_WORLD;
942     WORLD_TO_EYE[3][0] = -mat[12]*mat[0]
943         -mat[13]*mat[1]
944         -mat[14]*mat[2];
945         
946     WORLD_TO_EYE[3][1] = -mat[12]*mat[4]
947         -mat[13]*mat[5]
948         -mat[14]*mat[6];
949         
950     WORLD_TO_EYE[3][2] = -mat[12]*mat[8]
951         -mat[13]*mat[9]
952         -mat[14]*mat[10];
953         
954     // MAT3print_formatted(EYE_TO_WORLD, stdout, "EYE_TO_WORLD matrix:\n",
955     //                                   NULL, "%#8.6f  ", "\n");
956
957     // MAT3print_formatted(WORLD_TO_EYE, stdout, "WORLD_TO_EYE matrix:\n",
958     //                                   NULL, "%#8.6f  ", "\n");
959
960 #endif // defined(FG_VIEW_INLINE_OPTIMIZATIONS)
961 }
962
963
964 #if 0
965 // Reject non viewable spheres from current View Frustrum by Curt
966 // Olson curt@me.umn.edu and Norman Vine nhv@yahoo.com with 'gentle
967 // guidance' from Steve Baker sbaker@link.com
968 int
969 FGView::SphereClip( const Point3D& cp, const double radius )
970 {
971     double x1, y1;
972
973     MAT3vec eye;        
974     double *mat;
975     double x, y, z;
976
977     x = cp->x;
978     y = cp->y;
979     z = cp->z;
980         
981     mat = (double *)(WORLD_TO_EYE);
982         
983     eye[2] =  x*mat[2] + y*mat[6] + z*mat[10] + mat[14];
984         
985     // Check near and far clip plane
986     if( ( eye[2] > radius ) ||
987         ( eye[2] + radius + current_weather.visibility < 0) )
988         // ( eye[2] + radius + far_plane < 0) )
989     {
990         return 1;
991     }
992         
993     // check right and left clip plane (from eye perspective)
994     x1 = radius * fov_x_clip;
995     eye[0] = (x*mat[0] + y*mat[4] + z*mat[8] + mat[12]) * slope_x;
996     if( (eye[2] > -(eye[0]+x1)) || (eye[2] > (eye[0]-x1)) ) {
997         return(1);
998     }
999         
1000     // check bottom and top clip plane (from eye perspective)
1001     y1 = radius * fov_y_clip;
1002     eye[1] = (x*mat[1] + y*mat[5] + z*mat[9] + mat[13]) * slope_y; 
1003     if( (eye[2] > -(eye[1]+y1)) || (eye[2] > (eye[1]-y1)) ) {
1004         return 1;
1005     }
1006
1007     return 0;
1008 }
1009 #endif
1010
1011
1012 // Destructor
1013 FGView::~FGView( void ) {
1014 }