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 namespace flightgear
  37 {
  38     class View;
  39     typedef SGSharedPtr<flightgear::View> ViewPtr;
  40 }
  41
  42 // Define a structure containing view information
  43 class FGViewMgr : public SGSubsystem
  44 {
  45
  46 public:
  47
  48     // Constructor
  49     FGViewMgr( void );
  50
  51     // Destructor
  52     ~FGViewMgr( void );
  53
  54     virtual void init ();
  55     virtual void postinit();
  56     virtual void bind ();
  57     virtual void unbind ();
  58     virtual void update (double dt);
  59     virtual void reinit ();
  60     virtual void shutdown();
  61
  62     // getters
  63     inline int size() const { return views.size(); }
  64     inline int get_current() const { return current; }
  65
  66     flightgear::View* get_current_view();
  67     const flightgear::View* get_current_view() const;
  68
  69     flightgear::View* get_view( int i );
  70     const flightgear::View* get_view( int i ) const;
  71
  72     flightgear::View* next_view();
  73     flightgear::View* prev_view();
  74
  75     // setters
  76     void clear();
  77
  78     void add_view( flightgear::View * v );
  79
  80     static const char* subsystemName() { return "view-manager"; }
  81 private:
  82     void do_bind();
  83
  84     simgear::TiedPropertyList _tiedProperties;
  85
  86     double axis_long;
  87     double axis_lat;
  88
  89     void do_axes ();
  90
  91     //  callbacks in manager to access viewer methods
  92     double getViewHeadingOffset_deg () const;
  93     void setViewHeadingOffset_deg (double offset);
  94     double getViewGoalHeadingOffset_deg () const;
  95     void setViewGoalHeadingOffset_deg (double offset);
  96     double getViewPitchOffset_deg () const;
  97     void setViewPitchOffset_deg (double tilt);
  98     double getGoalViewPitchOffset_deg () const;
  99     void setGoalViewRollOffset_deg (double tilt);
 100     double getViewRollOffset_deg () const;
 101     void setViewRollOffset_deg (double tilt);
 102     double getGoalViewRollOffset_deg () const;
 103     void setGoalViewPitchOffset_deg (double tilt);
 104     double getViewXOffset_m () const;
 105     void setViewXOffset_m (double x);
 106     double getViewYOffset_m () const;
 107     void setViewYOffset_m (double y);
 108     double getViewZOffset_m () const;
 109     void setViewZOffset_m (double z);
 110     double getViewTargetXOffset_m () const;
 111     void setViewTargetXOffset_m (double x);
 112     double getViewTargetYOffset_m () const;
 113     void setViewTargetYOffset_m (double y);
 114     double getViewTargetZOffset_m () const;
 115     void setViewTargetZOffset_m (double z);
 116     double getFOV_deg () const;
 117     void setFOV_deg (double fov);
 118     double getARM_deg () const; // Aspect Ratio Multiplier
 119     void setARM_deg (double fov);
 120     double getNear_m () const;
 121     void setNear_m (double near_m);
 122     void setViewAxisLong (double axis);
 123     void setViewAxisLat (double axis);
 124     int getView () const;
 125     void setView (int newview);
 126
 127     double getViewLon_deg() const;
 128     double getViewLat_deg() const;
 129     double getViewElev_ft() const;
 130
 131 // quaternion accessors, for debugging:
 132     double getCurrentViewOrientation_w() const;
 133     double getCurrentViewOrientation_x() const;
 134     double getCurrentViewOrientation_y() const;
 135     double getCurrentViewOrientation_z() const;
 136     double getCurrentViewOrOffset_w() const;
 137     double getCurrentViewOrOffset_x() const;
 138     double getCurrentViewOrOffset_y() const;
 139     double getCurrentViewOrOffset_z() const;
 140     double getCurrentViewFrame_w() const;
 141     double getCurrentViewFrame_x() const;
 142     double getCurrentViewFrame_y() const;
 143     double getCurrentViewFrame_z() const;
 144
 145     // copies current offset settings to current-view path...
 146     void copyToCurrent ();
 147
 148     bool inited;
 149     SGPropertyNode_ptr view_number;
 150     std::vector<SGPropertyNode_ptr> config_list;
 151     typedef std::vector<flightgear::ViewPtr> viewer_list;
 152     viewer_list views;
 153     SGVec3d abs_viewer_position;
 154
 155     int current;
 156     SGQuatd current_view_orientation, current_view_or_offset;
 157
 158     SGPropertyNode_ptr current_x_offs, current_y_offs, current_z_offs;
 159     SGPropertyNode_ptr target_x_offs, target_y_offs, target_z_offs;
 160 };
 161
 162 // This takes the conventional aviation XYZ body system
 163 // i.e.  x=forward, y=starboard, z=bottom
 164 // which is widely used in FGFS
 165 // and rotates it into the OpenGL camera system
 166 // i.e. Xprime=starboard, Yprime=top, Zprime=aft.
 167 inline const SGQuatd fsb2sta()
 168 {
 169     return SGQuatd(-0.5, -0.5, 0.5, 0.5);
 170 }
 171
 172 #endif // _VIEWMGR_HXX