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