src/Main/viewer.cxx

   1 // viewer.cxx -- class for managing a viewer in the flightgear world.
   2 //
   3 // Written by Curtis Olson, started August 1997.
   4 //                          overhaul started October 2000.
   5 //
   6 // Copyright (C) 1997 - 2000  Curtis L. Olson  - curt@flightgear.org
   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 #include <simgear/compiler.h>
  26
  27 #ifdef HAVE_CONFIG_H
  28 #  include <config.h>
  29 #endif
  30
  31 #include <plib/ssg.h>           // plib include
  32
  33 #include <simgear/constants.h>
  34 #include <simgear/debug/logstream.hxx>
  35 #include <simgear/math/point3d.hxx>
  36 #include <simgear/math/polar3d.hxx>
  37 #include <simgear/math/vector.hxx>
  38
  39 #include <Aircraft/aircraft.hxx>
  40 #include <Cockpit/panel.hxx>
  41 #include <Scenery/scenery.hxx>
  42
  43 #include "globals.hxx"
  44 #include "viewer.hxx"
  45
  46
  47 // Constructor
  48 FGViewer::FGViewer( void )
  49 {
  50 }
  51
  52
  53 #define USE_FAST_VIEWROT
  54 #ifdef USE_FAST_VIEWROT
  55 // VIEW_ROT = LARC_TO_SSG * ( VIEWo * VIEW_OFFSET )
  56 // This takes advantage of the fact that VIEWo and VIEW_OFFSET
  57 // only have entries in the upper 3x3 block
  58 // and that LARC_TO_SSG is just a shift of rows   NHV
  59 inline static void fgMakeViewRot( sgMat4 dst, const sgMat4 m1, const sgMat4 m2 )
  60 {
  61     for ( int j = 0 ; j < 3 ; j++ ) {
  62         dst[2][j] = m2[0][0] * m1[0][j] +
  63             m2[0][1] * m1[1][j] +
  64             m2[0][2] * m1[2][j];
  65
  66         dst[0][j] = m2[1][0] * m1[0][j] +
  67             m2[1][1] * m1[1][j] +
  68             m2[1][2] * m1[2][j];
  69
  70         dst[1][j] = m2[2][0] * m1[0][j] +
  71             m2[2][1] * m1[1][j] +
  72             m2[2][2] * m1[2][j];
  73     }
  74     dst[0][3] =
  75         dst[1][3] =
  76         dst[2][3] =
  77         dst[3][0] =
  78         dst[3][1] =
  79         dst[3][2] = SG_ZERO;
  80     dst[3][3] = SG_ONE;
  81 }
  82 #endif
  83
  84
  85 // Initialize a view structure
  86 void FGViewer::init( void ) {
  87     dirty = true;
  88
  89     FG_LOG( FG_VIEW, FG_INFO, "Initializing View parameters" );
  90
  91     view_offset = goal_view_offset =
  92         globals->get_options()->get_default_view_offset();
  93     sgSetVec3( pilot_offset, 0.0, 0.0, 0.0 );
  94
  95     globals->get_options()->set_win_ratio( globals->get_options()->get_xsize() /
  96                                            globals->get_options()->get_ysize()
  97                                            );
  98
  99 #ifndef USE_FAST_VIEWROT
 100     // This never changes -- NHV
 101     LARC_TO_SSG[0][0] = 0.0;
 102     LARC_TO_SSG[0][1] = 1.0;
 103     LARC_TO_SSG[0][2] = -0.0;
 104     LARC_TO_SSG[0][3] = 0.0;
 105
 106     LARC_TO_SSG[1][0] = 0.0;
 107     LARC_TO_SSG[1][1] = 0.0;
 108     LARC_TO_SSG[1][2] = 1.0;
 109     LARC_TO_SSG[1][3] = 0.0;
 110
 111     LARC_TO_SSG[2][0] = 1.0;
 112     LARC_TO_SSG[2][1] = -0.0;
 113     LARC_TO_SSG[2][2] = 0.0;
 114     LARC_TO_SSG[2][3] = 0.0;
 115
 116     LARC_TO_SSG[3][0] = 0.0;
 117     LARC_TO_SSG[3][1] = 0.0;
 118     LARC_TO_SSG[3][2] = 0.0;
 119     LARC_TO_SSG[3][3] = 1.0;
 120 #endif // USE_FAST_VIEWROT
 121 }
 122
 123
 124 #define USE_FAST_LOCAL
 125 #ifdef USE_FAST_LOCAL
 126 inline static void fgMakeLOCAL( sgMat4 dst, const double Theta,
 127                                 const double Phi, const double Psi)
 128 {
 129     SGfloat cosTheta = (SGfloat) cos(Theta);
 130     SGfloat sinTheta = (SGfloat) sin(Theta);
 131     SGfloat cosPhi   = (SGfloat) cos(Phi);
 132     SGfloat sinPhi   = (SGfloat) sin(Phi);
 133     SGfloat sinPsi   = (SGfloat) sin(Psi) ;
 134     SGfloat cosPsi   = (SGfloat) cos(Psi) ;
 135
 136     dst[0][0] = cosPhi * cosTheta;
 137     dst[0][1] = sinPhi * cosPsi + cosPhi * -sinTheta * -sinPsi;
 138     dst[0][2] = sinPhi * sinPsi + cosPhi * -sinTheta * cosPsi;
 139     dst[0][3] = SG_ZERO;
 140
 141     dst[1][0] = -sinPhi * cosTheta;
 142     dst[1][1] = cosPhi * cosPsi + -sinPhi * -sinTheta * -sinPsi;
 143     dst[1][2] = cosPhi * sinPsi + -sinPhi * -sinTheta * cosPsi;
 144     dst[1][3] = SG_ZERO ;
 145
 146     dst[2][0] = sinTheta;
 147     dst[2][1] = cosTheta * -sinPsi;
 148     dst[2][2] = cosTheta * cosPsi;
 149     dst[2][3] = SG_ZERO;
 150
 151     dst[3][0] = SG_ZERO;
 152     dst[3][1] = SG_ZERO;
 153     dst[3][2] = SG_ZERO;
 154     dst[3][3] = SG_ONE ;
 155 }
 156 #endif
 157
 158
 159 // convert sgMat4 to MAT3 and print
 160 static void print_sgMat4( sgMat4 &in) {
 161     int i, j;
 162     for ( i = 0; i < 4; i++ ) {
 163         for ( j = 0; j < 4; j++ ) {
 164             printf("%10.4f ", in[i][j]);
 165         }
 166         cout << endl;
 167     }
 168 }
 169
 170
 171 // Update the view parameters
 172 void FGViewer::update() {
 173
 174     sgVec3 minus_z, forward;
 175     sgMat4 VIEWo;
 176
 177     // calculate the cartesion coords of the current lat/lon/0 elev
 178     Point3D p = Point3D( geod_view_pos[0],
 179                          geod_view_pos[1],
 180                          sea_level_radius );
 181
 182     cur_zero_elev = sgPolarToCart3d(p) - scenery.center;
 183
 184     // calculate view position in current FG view coordinate system
 185     // p.lon & p.lat are already defined earlier, p.radius was set to
 186     // the sea level radius, so now we add in our altitude.
 187     if ( geod_view_pos[2] > (scenery.cur_elev + 0.5 * METER_TO_FEET) ) {
 188         p.setz( p.radius() + geod_view_pos[2] );
 189     } else {
 190         p.setz( p.radius() + scenery.cur_elev + 0.5 * METER_TO_FEET );
 191     }
 192
 193     Point3D tmp = sgPolarToCart3d(p);
 194     sgdSetVec3( abs_view_pos, tmp[0], tmp[1], tmp[2] );
 195
 196     sgdVec3 sc;
 197     sgdSetVec3( sc, scenery.center.x(), scenery.center.y(), scenery.center.z());
 198     sgdVec3 vp;
 199     sgdSubVec3( vp, abs_view_pos, sc );
 200     sgSetVec3( view_pos, vp );
 201     // view_pos = abs_view_pos - scenery.center;
 202
 203     FG_LOG( FG_VIEW, FG_DEBUG, "sea level radius = " << sea_level_radius );
 204     FG_LOG( FG_VIEW, FG_DEBUG, "Polar view pos = " << p );
 205     FG_LOG( FG_VIEW, FG_DEBUG, "Absolute view pos = "
 206             << abs_view_pos[0] << ","
 207             << abs_view_pos[1] << ","
 208             << abs_view_pos[2] );
 209     FG_LOG( FG_VIEW, FG_DEBUG, "Relative view pos = "
 210             << view_pos[0] << "," << view_pos[1] << "," << view_pos[2] );
 211
 212     // code to calculate LOCAL matrix calculated from Phi, Theta, and
 213     // Psi (roll, pitch, yaw) in case we aren't running LaRCsim as our
 214     // flight model
 215
 216 #ifdef USE_FAST_LOCAL
 217
 218     fgMakeLOCAL( LOCAL, rph[1], rph[0], -rph[2] );
 219
 220 #else // USE_TEXT_BOOK_METHOD
 221
 222     sgVec3 rollvec;
 223     sgSetVec3( rollvec, 0.0, 0.0, 1.0 );
 224     sgMat4 PHI;         // roll
 225     sgMakeRotMat4( PHI, rph[0] * RAD_TO_DEG, rollvec );
 226
 227     sgVec3 pitchvec;
 228     sgSetVec3( pitchvec, 0.0, 1.0, 0.0 );
 229     sgMat4 THETA;               // pitch
 230     sgMakeRotMat4( THETA, rph[1] * RAD_TO_DEG, pitchvec );
 231
 232     // ROT = PHI * THETA
 233     sgMat4 ROT;
 234     // sgMultMat4( ROT, PHI, THETA );
 235     sgCopyMat4( ROT, PHI );
 236     sgPostMultMat4( ROT, THETA );
 237
 238     sgVec3 yawvec;
 239     sgSetVec3( yawvec, 1.0, 0.0, 0.0 );
 240     sgMat4 PSI;         // heading
 241     sgMakeRotMat4( PSI, -rph[2] * RAD_TO_DEG, yawvec );
 242
 243     // LOCAL = ROT * PSI
 244     // sgMultMat4( LOCAL, ROT, PSI );
 245     sgCopyMat4( LOCAL, ROT );
 246     sgPostMultMat4( LOCAL, PSI );
 247
 248 #endif // USE_FAST_LOCAL
 249
 250     // cout << "LOCAL matrix" << endl;
 251     // print_sgMat4( LOCAL );
 252
 253     sgMakeRotMat4( UP,
 254                    geod_view_pos[0] * RAD_TO_DEG,
 255                    0.0,
 256                    -geod_view_pos[1] * RAD_TO_DEG );
 257
 258     sgSetVec3( local_up, UP[0][0], UP[0][1], UP[0][2] );
 259     // sgXformVec3( local_up, UP );
 260     // cout << "Local Up = " << local_up[0] << "," << local_up[1] << ","
 261     //      << local_up[2] << endl;
 262
 263     // Alternative method to Derive local up vector based on
 264     // *geodetic* coordinates
 265     // alt_up = sgPolarToCart(FG_Longitude, FG_Latitude, 1.0);
 266     // printf( "    Alt Up = (%.4f, %.4f, %.4f)\n",
 267     //         alt_up.x, alt_up.y, alt_up.z);
 268
 269     // VIEWo = LOCAL * UP
 270     // sgMultMat4( VIEWo, LOCAL, UP );
 271     sgCopyMat4( VIEWo, LOCAL );
 272     sgPostMultMat4( VIEWo, UP );
 273     // cout << "VIEWo matrix" << endl;
 274     // print_sgMat4( VIEWo );
 275
 276     // generate the sg view up and forward vectors
 277     sgSetVec3( view_up, VIEWo[0][0], VIEWo[0][1], VIEWo[0][2] );
 278     // cout << "view = " << view[0] << ","
 279     //      << view[1] << "," << view[2] << endl;
 280     sgSetVec3( forward, VIEWo[2][0], VIEWo[2][1], VIEWo[2][2] );
 281     // cout << "forward = " << forward[0] << ","
 282     //      << forward[1] << "," << forward[2] << endl;
 283
 284     // generate the pilot offset vector in world coordinates
 285     sgVec3 pilot_offset_world;
 286     sgSetVec3( pilot_offset_world,
 287                pilot_offset[2], pilot_offset[1], -pilot_offset[0] );
 288     sgXformVec3( pilot_offset_world, pilot_offset_world, VIEWo );
 289
 290     // generate the view offset matrix
 291     sgMakeRotMat4( VIEW_OFFSET, view_offset * RAD_TO_DEG, view_up );
 292     // cout << "VIEW_OFFSET matrix" << endl;
 293     // print_sgMat4( VIEW_OFFSET );
 294     sgXformVec3( view_forward, forward, VIEW_OFFSET );
 295     // cout << "view_forward = " << view_forward[0] << ","
 296     //      << view_forward[1] << "," << view_forward[2] << endl;
 297
 298     // VIEW_ROT = LARC_TO_SSG * ( VIEWo * VIEW_OFFSET )
 299 #ifdef USE_FAST_VIEWROT
 300     fgMakeViewRot( VIEW_ROT, VIEW_OFFSET, VIEWo );
 301 #else
 302     // sgMultMat4( VIEW_ROT, VIEW_OFFSET, VIEWo );
 303     // sgPreMultMat4( VIEW_ROT, LARC_TO_SSG );
 304     sgCopyMat4( VIEW_ROT, VIEWo );
 305     sgPostMultMat4( VIEW_ROT, VIEW_OFFSET );
 306     sgPreMultMat4( VIEW_ROT, LARC_TO_SSG );
 307 #endif
 308     // cout << "VIEW_ROT matrix" << endl;
 309     // print_sgMat4( VIEW_ROT );
 310
 311     sgVec3 trans_vec;
 312     sgAddVec3( trans_vec, view_pos, pilot_offset_world );
 313
 314     // VIEW = VIEW_ROT * TRANS
 315     sgCopyMat4( VIEW, VIEW_ROT );
 316     sgPostMultMat4ByTransMat4( VIEW, trans_vec );
 317
 318     //!!!!!!!!!!!!!!!!!!!
 319     // THIS IS THE EXPERIMENTAL VIEWING ANGLE SHIFTER
 320     // THE MAJORITY OF THE WORK IS DONE IN GUI.CXX
 321     // this in gui.cxx for now just testing
 322     extern float quat_mat[4][4];
 323     sgPreMultMat4( VIEW, quat_mat);
 324     // !!!!!!!!!! testing
 325
 326     // Given a vector pointing straight down (-Z), map into onto the
 327     // local plane representing "horizontal".  This should give us the
 328     // local direction for moving "south".
 329     sgSetVec3( minus_z, 0.0, 0.0, -1.0 );
 330
 331     sgmap_vec_onto_cur_surface_plane(local_up, view_pos, minus_z,
 332                                      surface_south);
 333     sgNormalizeVec3(surface_south);
 334     // cout << "Surface direction directly south " << surface_south[0] << ","
 335     //      << surface_south[1] << "," << surface_south[2] << endl;
 336
 337     // now calculate the surface east vector
 338 #define USE_FAST_SURFACE_EAST
 339 #ifdef USE_FAST_SURFACE_EAST
 340     sgVec3 local_down;
 341     sgNegateVec3(local_down, local_up);
 342     sgVectorProductVec3(surface_east, surface_south, local_down);
 343 #else
 344 #define USE_LOCAL_UP
 345 #ifdef USE_LOCAL_UP
 346     sgMakeRotMat4( TMP, FG_PI_2 * RAD_TO_DEG, local_up );
 347 #else
 348     sgMakeRotMat4( TMP, FG_PI_2 * RAD_TO_DEG, view_up );
 349 #endif // USE_LOCAL_UP
 350     // cout << "sgMat4 TMP" << endl;
 351     // print_sgMat4( TMP );
 352     sgXformVec3(surface_east, surface_south, TMP);
 353 #endif //  USE_FAST_SURFACE_EAST
 354     // cout << "Surface direction directly east " << surface_east[0] << ","
 355     //      << surface_east[1] << "," << surface_east[2] << endl;
 356     // cout << "Should be close to zero = "
 357     //      << sgScalarProductVec3(surface_south, surface_east) << endl;
 358
 359     dirty = false;
 360 }
 361
 362
 363 void FGViewer::CurrentNormalInLocalPlane(sgVec3 dst, sgVec3 src) {
 364     sgVec3 tmp;
 365     sgSetVec3(tmp, src[0], src[1], src[2] );
 366     sgMat4 TMP;
 367     sgTransposeNegateMat4 ( TMP, UP ) ;
 368     sgXformVec3(tmp, tmp, TMP);
 369     sgSetVec3(dst, tmp[2], tmp[1], tmp[0] );
 370 }
 371
 372
 373 // Destructor
 374 FGViewer::~FGViewer( void ) {
 375 }