src/Viewer/viewmgr.hxx

   1 // viewmgr.hxx -- class for managing all the views in the flightgear world.
   2 //
   3 // Written by Curtis Olson, started October 2000.
   4 //
   5 // Copyright (C) 2000  Curtis L. Olson  - http://www.flightgear.org/~curt
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _VIEWMGR_HXX
  25 #define _VIEWMGR_HXX
  26
  27 #include <vector>
  28
  29 #include <simgear/compiler.h>
  30 #include <simgear/structure/subsystem_mgr.hxx>
  31 #include <simgear/props/props.hxx>
  32 #include <simgear/props/tiedpropertylist.hxx>
  33 #include <simgear/math/SGMath.hxx>
  34
  35 // forward decls
  36 class FGViewer;
  37 typedef SGSharedPtr<FGViewer> FGViewerPtr;
  38
  39 // Define a structure containing view information
  40 class FGViewMgr : public SGSubsystem
  41 {
  42
  43 public:
  44
  45     // Constructor
  46     FGViewMgr( void );
  47
  48     // Destructor
  49     ~FGViewMgr( void );
  50
  51     virtual void init ();
  52     virtual void bind ();
  53     virtual void unbind ();
  54     virtual void update (double dt);
  55     virtual void reinit ();
  56     virtual void shutdown();
  57
  58     // getters
  59     inline int size() const { return views.size(); }
  60     inline int get_current() const { return current; }
  61
  62     FGViewer *get_current_view();
  63     const FGViewer *get_current_view() const;
  64
  65     FGViewer *get_view( int i );
  66     const FGViewer *get_view( int i ) const;
  67
  68     FGViewer *next_view();
  69     FGViewer *prev_view();
  70
  71     // setters
  72     void clear();
  73
  74     void add_view( FGViewer * v );
  75
  76 private:
  77     void do_bind();
  78
  79     simgear::TiedPropertyList _tiedProperties;
  80
  81     double axis_long;
  82     double axis_lat;
  83
  84     void do_axes ();
  85
  86     //  callbacks in manager to access viewer methods
  87     double getViewHeadingOffset_deg () const;
  88     void setViewHeadingOffset_deg (double offset);
  89     double getViewGoalHeadingOffset_deg () const;
  90     void setViewGoalHeadingOffset_deg (double offset);
  91     double getViewPitchOffset_deg () const;
  92     void setViewPitchOffset_deg (double tilt);
  93     double getGoalViewPitchOffset_deg () const;
  94     void setGoalViewRollOffset_deg (double tilt);
  95     double getViewRollOffset_deg () const;
  96     void setViewRollOffset_deg (double tilt);
  97     double getGoalViewRollOffset_deg () const;
  98     void setGoalViewPitchOffset_deg (double tilt);
  99     double getViewXOffset_m () const;
 100     void setViewXOffset_m (double x);
 101     double getViewYOffset_m () const;
 102     void setViewYOffset_m (double y);
 103     double getViewZOffset_m () const;
 104     void setViewZOffset_m (double z);
 105     double getViewTargetXOffset_m () const;
 106     void setViewTargetXOffset_m (double x);
 107     double getViewTargetYOffset_m () const;
 108     void setViewTargetYOffset_m (double y);
 109     double getViewTargetZOffset_m () const;
 110     void setViewTargetZOffset_m (double z);
 111     double getFOV_deg () const;
 112     void setFOV_deg (double fov);
 113     double getARM_deg () const; // Aspect Ratio Multiplier
 114     void setARM_deg (double fov);
 115     double getNear_m () const;
 116     void setNear_m (double near_m);
 117     void setViewAxisLong (double axis);
 118     void setViewAxisLat (double axis);
 119     int getView () const;
 120     void setView (int newview);
 121
 122     double getViewLon_deg() const;
 123     double getViewLat_deg() const;
 124     double getViewElev_ft() const;
 125
 126 // quaternion accessors, for debugging:
 127     double getCurrentViewOrientation_w() const;
 128     double getCurrentViewOrientation_x() const;
 129     double getCurrentViewOrientation_y() const;
 130     double getCurrentViewOrientation_z() const;
 131     double getCurrentViewOrOffset_w() const;
 132     double getCurrentViewOrOffset_x() const;
 133     double getCurrentViewOrOffset_y() const;
 134     double getCurrentViewOrOffset_z() const;
 135     double getCurrentViewFrame_w() const;
 136     double getCurrentViewFrame_x() const;
 137     double getCurrentViewFrame_y() const;
 138     double getCurrentViewFrame_z() const;
 139
 140     // copies current offset settings to current-view path...
 141     void copyToCurrent ();
 142
 143     bool inited;
 144     SGPropertyNode_ptr view_number;
 145     std::vector<SGPropertyNode_ptr> config_list;
 146     typedef std::vector<FGViewerPtr> viewer_list;
 147     viewer_list views;
 148     SGVec3d abs_viewer_position;
 149
 150     int current;
 151     SGQuatd current_view_orientation, current_view_or_offset;
 152
 153     SGPropertyNode_ptr current_x_offs, current_y_offs, current_z_offs;
 154     SGPropertyNode_ptr target_x_offs, target_y_offs, target_z_offs;
 155 };
 156
 157 // This takes the conventional aviation XYZ body system
 158 // i.e.  x=forward, y=starboard, z=bottom
 159 // which is widely used in FGFS
 160 // and rotates it into the OpenGL camera system
 161 // i.e. Xprime=starboard, Yprime=top, Zprime=aft.
 162 inline const SGQuatd fsb2sta()
 163 {
 164     return SGQuatd(-0.5, -0.5, 0.5, 0.5);
 165 }
 166
 167 #endif // _VIEWMGR_HXX