Main/views.hxx

   1 //
   2 // views.hxx -- data structures and routines for managing and view 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 // (Log is kept at end of this file)
  24
  25
  26 #ifndef _VIEWS_HXX
  27 #define _VIEWS_HXX
  28
  29
  30 #ifndef __cplusplus
  31 # error This library requires C++
  32 #endif
  33
  34
  35 #include <Include/fg_types.h>
  36 #include <Flight/flight.h>
  37 #include <Math/mat3.h>
  38 #include <Time/fg_time.hxx>
  39 #include <Time/light.hxx>
  40
  41
  42 // Define a structure containing view information
  43 class fgVIEW {
  44
  45 public:
  46
  47     // the current offset from forward for viewing
  48     double view_offset;
  49
  50     // the goal view offset for viewing (used for smooth view changes)
  51     double goal_view_offset;
  52
  53     // fov of view is specified in the y direction, win_ratio is used to
  54     // calculate the fov in the X direction = width/height
  55     double win_ratio;
  56
  57     // width & height of window
  58     int winWidth, winHeight;
  59
  60     // sin and cos of (fov / 2) in Y axis
  61     double sin_fov_y, cos_fov_y;
  62
  63     // slope of view frustum edge in eye space Y axis
  64     double slope_y;
  65
  66     // sin and cos of (fov / 2) in X axis
  67     double sin_fov_x, cos_fov_x;
  68
  69     // slope of view frustum edge in eye space X axis
  70     double slope_x;
  71
  72     // View frustum cull ratio (% of tiles culled ... used for
  73     // reporting purposes)
  74     double vfc_ratio;
  75
  76     // absolute view position
  77     fgCartesianPoint3d abs_view_pos;
  78
  79     // view position translated to scenery.center
  80     fgCartesianPoint3d view_pos;
  81
  82     // cartesion coordinates of current lon/lat if at sea level
  83     // translated to scenery.center*/
  84     fgCartesianPoint3d cur_zero_elev;
  85
  86     // vector in cartesian coordinates from current position to the
  87     // postion on the earth's surface the sun is directly over
  88     MAT3vec to_sun;
  89
  90     // surface direction to go to head towards sun
  91     MAT3vec surface_to_sun;
  92
  93     // surface vector heading south
  94     MAT3vec surface_south;
  95
  96     // surface vector heading east (used to unambiguously align sky
  97     // with sun)
  98     MAT3vec surface_east;
  99
 100     // local up vector (normal to the plane tangent to the earth's
 101     // surface at the spot we are directly above
 102     MAT3vec local_up;
 103
 104     // up vector for the view (usually point straight up through the
 105     // top of the aircraft
 106     MAT3vec view_up;
 107
 108     // the vector pointing straight out the nose of the aircraft
 109     MAT3vec view_forward;
 110
 111     // Transformation matrix for eye coordinates to aircraft coordinates
 112     MAT3mat AIRCRAFT;
 113
 114     // Transformation matrix for aircraft coordinates to world
 115     // coordinates
 116     MAT3mat WORLD;
 117
 118     // Combined transformation from eye coordinates to world coordinates
 119     MAT3mat EYE_TO_WORLD;
 120
 121     // Inverse of EYE_TO_WORLD which is a transformation from world
 122     // coordinates to eye coordinates
 123     MAT3mat WORLD_TO_EYE;
 124
 125     // Constructor
 126     fgVIEW( void );
 127
 128     // Initialize a view class
 129     void Init( void );
 130
 131     // Update the view parameters
 132     void Update( fgFLIGHT *f );
 133
 134     // Update the "World to Eye" transformation matrix
 135     void UpdateWorldToEye(  fgFLIGHT *f );
 136
 137     // Destructor
 138     ~fgVIEW( void );
 139 };
 140
 141
 142 extern fgVIEW current_view;
 143
 144
 145 #endif // _VIEWS_HXX
 146
 147
 148 // $Log$
 149 // Revision 1.7  1998/05/17 16:59:04  curt
 150 // First pass at view frustum culling now operational.
 151 //
 152 // Revision 1.6  1998/05/16 13:08:37  curt
 153 // C++ - ified views.[ch]xx
 154 // Shuffled some additional view parameters into the fgVIEW class.
 155 // Changed tile-radius to tile-diameter because it is a much better
 156 //   name.
 157 // Added a WORLD_TO_EYE transformation to views.cxx.  This allows us
 158 //  to transform world space to eye space for view frustum culling.
 159 //
 160 // Revision 1.5  1998/05/02 01:51:02  curt
 161 // Updated polartocart conversion routine.
 162 //
 163 // Revision 1.4  1998/04/28 01:20:24  curt
 164 // Type-ified fgTIME and fgVIEW.
 165 // Added a command line option to disable textures.
 166 //
 167 // Revision 1.3  1998/04/25 22:06:31  curt
 168 // Edited cvs log messages in source files ... bad bad bad!
 169 //
 170 // Revision 1.2  1998/04/24 00:49:22  curt
 171 // Wrapped "#include <config.h>" in "#ifdef HAVE_CONFIG_H"
 172 // Trying out some different option parsing code.
 173 // Some code reorganization.
 174 //
 175 // Revision 1.1  1998/04/22 13:25:46  curt
 176 // C++ - ifing the code.
 177 // Starting a bit of reorganization of lighting code.
 178 //
 179 // Revision 1.11  1998/04/21 17:02:42  curt
 180 // Prepairing for C++ integration.
 181 //
 182 // Revision 1.10  1998/02/07 15:29:45  curt
 183 // Incorporated HUD changes and struct/typedef changes from Charlie Hotchkiss
 184 // <chotchkiss@namg.us.anritsu.com>
 185 //
 186 // Revision 1.9  1998/01/29 00:50:29  curt
 187 // Added a view record field for absolute x, y, z position.
 188 //
 189 // Revision 1.8  1998/01/27 00:47:58  curt
 190 // Incorporated Paul Bleisch's <pbleisch@acm.org> new debug message
 191 // system and commandline/config file processing code.
 192 //
 193 // Revision 1.7  1998/01/22 02:59:38  curt
 194 // Changed #ifdef FILE_H to #ifdef _FILE_H
 195 //
 196 // Revision 1.6  1998/01/19 19:27:10  curt
 197 // Merged in make system changes from Bob Kuehne <rpk@sgi.com>
 198 // This should simplify things tremendously.
 199 //
 200 // Revision 1.5  1997/12/22 04:14:32  curt
 201 // Aligned sky with sun so dusk/dawn effects can be correct relative to the sun.
 202 //
 203 // Revision 1.4  1997/12/17 23:13:36  curt
 204 // Began working on rendering a sky.
 205 //
 206 // Revision 1.3  1997/12/15 23:54:51  curt
 207 // Add xgl wrappers for debugging.
 208 // Generate terrain normals on the fly.
 209 //
 210 // Revision 1.2  1997/12/10 22:37:48  curt
 211 // Prepended "fg" on the name of all global structures that didn't have it yet.
 212 // i.e. "struct WEATHER {}" became "struct fgWEATHER {}"
 213 //
 214 // Revision 1.1  1997/08/27 21:31:18  curt
 215 // Initial revision.
 216 //