//
// Written by Curtis Olson, started August 1997.
// overhaul started October 2000.
+// partially rewritten by Jim Wilson jim@kelcomaine.com using interface
+// by David Megginson March 2002
//
-// Copyright (C) 1997 - 2000 Curtis L. Olson - curt@flightgear.org
+// Copyright (C) 1997 - 2000 Curtis L. Olson - http://www.flightgear.org/~curt
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
-// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// $Id$
#ifndef _VIEWER_HXX
-#define _VIEWER_HXX
+#define _VIEWER_HXX
+namespace flightgear
+{
+class CameraGroup;
+}
-#ifndef __cplusplus
-# error This library requires C++
-#endif
+#include <osg/ref_ptr>
#include <simgear/compiler.h>
-#include <simgear/math/point3d.hxx>
-#include <simgear/timing/sg_time.hxx>
-
-#include <list>
-
-#include <plib/sg.h> // plib include
-
-#include <FDM/flight.hxx>
-#include <Time/light.hxx>
-
-
-FG_USING_STD(list);
-
+#include <simgear/constants.h>
+#include <simgear/structure/subsystem_mgr.hxx>
+#include <simgear/math/SGMath.hxx>
#define FG_FOV_MIN 0.1
#define FG_FOV_MAX 179.9
+enum fgViewType {
+ FG_LOOKFROM = 0,
+ FG_LOOKAT = 1
+};
// Define a structure containing view information
-class FGViewer {
-
-private:
+class FGViewer : public SGSubsystem {
- // the current view offset angle from forward (rotated about the
- // view_up vector)
- double view_offset;
-
- // the goal view offset angle (used for smooth view changes)
- double goal_view_offset;
-
- // flag forcing update of fov related stuff
- bool update_fov;
-
- // fov of view is specified in the X direction, win_ratio is used to
- // calculate the fov in the Y direction. fov(y) = fov(x) * win_ratio
- double win_ratio;
-
- // width & height of window
- // int winWidth, winHeight;
-
- // absolute view position in earth coordinates
- Point3D abs_view_pos;
-
- // view position in opengl world coordinates (this is the
- // abs_view_pos translated to scenery.center)
- Point3D view_pos;
+public:
- // pilot offset from center of gravity. The X axis is positive
- // out the tail, Y is out the right wing, and Z is positive up.
- // Distances in meters of course.
- sgVec3 pilot_offset;
+ enum fgScalingType { // nominal Field Of View actually applies to ...
+ FG_SCALING_WIDTH, // window width
+ FG_SCALING_MAX // max(width, height)
+ // FG_SCALING_G_MEAN, // geometric_mean(width, height)
+ // FG_SCALING_INDEPENDENT // whole screen
+ };
- // cartesion coordinates of current lon/lat if at sea level
- // translated to scenery.center
- Point3D cur_zero_elev;
+ // Constructor
+ FGViewer( fgViewType Type, bool from_model, int from_model_index,
+ bool at_model, int at_model_index,
+ double damp_roll, double damp_pitch, double damp_heading,
+ double x_offset_m, double y_offset_m, double z_offset_m,
+ double heading_offset_deg, double pitch_offset_deg,
+ double roll_offset_deg,
+ double fov_deg, double aspect_ratio_multiplier,
+ double target_x_offset_m, double target_y_offset_m,
+ double target_z_offset_m, double near_m, bool internal );
- // vector in cartesian coordinates from current position to the
- // postion on the earth's surface the sun is directly over
- sgVec3 to_sun;
+ // Destructor
+ virtual ~FGViewer( void );
+
+ //////////////////////////////////////////////////////////////////////
+ // Part 1: standard SGSubsystem implementation.
+ //////////////////////////////////////////////////////////////////////
+
+ virtual void init ();
+ virtual void bind ();
+ virtual void unbind ();
+ void update (double dt);
+
+
+ //////////////////////////////////////////////////////////////////////
+ // Part 2: user settings.
+ //////////////////////////////////////////////////////////////////////
+
+ virtual fgViewType getType() const { return _type; }
+ virtual void setType( int type );
+
+ virtual bool getInternal() const { return _internal; }
+ virtual void setInternal( bool internal );
+
+ // Reference geodetic position of view from position...
+ // These are the actual aircraft position (pilot in
+ // pilot view, model in model view).
+ // FIXME: the model view position (ie target positions)
+ // should be in the model class.
+ virtual void setPosition (double lon_deg, double lat_deg, double alt_ft);
+ const SGGeod& getPosition() const { return _position; }
+
+ // Reference geodetic target position...
+ virtual void setTargetPosition (double lon_deg, double lat_deg, double alt_ft);
+ const SGGeod& getTargetPosition() const { return _target; }
+
+
+
+ // Position offsets from reference
+ // These offsets position they "eye" in the scene according to a given
+ // location. For example in pilot view they are used to position the
+ // head inside the aircraft.
+ // Note that in pilot view these are applied "before" the orientation
+ // rotations (see below) so that the orientation rotations have the
+ // effect of the pilot staying in his seat and "looking out" in
+ // different directions.
+ // In chase view these are applied "after" the application of the
+ // orientation rotations listed below. This has the effect of the
+ // eye moving around and "looking at" the object (model) from
+ // different angles.
+ virtual SGVec3d getOffset_m () const { return _offset_m; }
+ virtual double getXOffset_m () const { return _offset_m.x(); }
+ virtual double getYOffset_m () const { return _offset_m.y(); }
+ virtual double getZOffset_m () const { return _offset_m.z(); }
+ virtual double getTargetXOffset_m () const { return _target_offset_m.x(); }
+ virtual double getTargetYOffset_m () const { return _target_offset_m.y(); }
+ virtual double getTargetZOffset_m () const { return _target_offset_m.z(); }
+ virtual void setXOffset_m (double x_offset_m);
+ virtual void setYOffset_m (double y_offset_m);
+ virtual void setZOffset_m (double z_offset_m);
+ virtual void setTargetXOffset_m (double x_offset_m);
+ virtual void setTargetYOffset_m (double y_offset_m);
+ virtual void setTargetZOffset_m (double z_offset_m);
+ virtual void setPositionOffsets (double x_offset_m,
+ double y_offset_m,
+ double z_offset_m);
+
+
+
+
+ // Reference orientation rotations...
+ // These are rotations that represent the plane attitude effect on
+ // the view (in Pilot view). IE The view frustrum rotates as the plane
+ // turns, pitches, and rolls.
+ // In model view (lookat/chaseview) these end up changing the angle that
+ // the eye is looking at the ojbect (ie the model).
+ // FIXME: the FGModel class should have its own version of these so that
+ // it can generate it's own model rotations.
+ virtual double getRoll_deg () const { return _roll_deg; }
+ virtual double getPitch_deg () const {return _pitch_deg; }
+ virtual double getHeading_deg () const {return _heading_deg; }
+ virtual void setRoll_deg (double roll_deg);
+ virtual void setPitch_deg (double pitch_deg);
+ virtual void setHeading_deg (double heading_deg);
+ virtual void setOrientation (double roll_deg, double pitch_deg, double heading_deg);
+ virtual double getTargetRoll_deg () const { return _target_roll_deg; }
+ virtual double getTargetPitch_deg () const {return _target_pitch_deg; }
+ virtual double getTargetHeading_deg () const {return _target_heading_deg; }
+ virtual void setTargetRoll_deg (double roll_deg);
+ virtual void setTargetPitch_deg (double pitch_deg);
+ virtual void setTargetHeading_deg (double heading_deg);
+ virtual void setTargetOrientation (double roll_deg, double pitch_deg, double heading_deg);
+
+
+
+
+ // Orientation offsets rotations from reference orientation.
+ // Goal settings are for smooth transition from prior
+ // offset when changing view direction.
+ // These offsets are in ADDITION to the orientation rotations listed
+ // above.
+ // In pilot view they are applied after the position offsets in order to
+ // give the effect of the pilot looking around.
+ // In lookat view they are applied before the position offsets so that
+ // the effect is the eye moving around looking at the object (ie the model)
+ // from different angles.
+ virtual double getRollOffset_deg () const { return _roll_offset_deg; }
+ virtual double getPitchOffset_deg () const { return _pitch_offset_deg; }
+ virtual double getHeadingOffset_deg () const { return _heading_offset_deg; }
+ virtual double getGoalRollOffset_deg () const { return _goal_roll_offset_deg; }
+ virtual double getGoalPitchOffset_deg () const { return _goal_pitch_offset_deg; }
+ virtual double getGoalHeadingOffset_deg () const {return _goal_heading_offset_deg; }
+ virtual void setRollOffset_deg (double roll_offset_deg);
+ virtual void setPitchOffset_deg (double pitch_offset_deg);
+ virtual void setHeadingOffset_deg (double heading_offset_deg);
+ virtual void setGoalRollOffset_deg (double goal_roll_offset_deg);
+ virtual void setGoalPitchOffset_deg (double goal_pitch_offset_deg);
+ virtual void setGoalHeadingOffset_deg (double goal_heading_offset_deg);
+ virtual void setOrientationOffsets (double roll_offset_deg,
+ double heading_offset_deg,
+ double pitch_offset_deg);
+
+
+
+ //////////////////////////////////////////////////////////////////////
+ // Part 3: output vectors and matrices in FlightGear coordinates.
+ //////////////////////////////////////////////////////////////////////
+
+ // Vectors and positions...
+
+ const SGVec3d& get_view_pos() { if ( _dirty ) { recalc(); } return _absolute_view_pos; }
+ const SGVec3d& getViewPosition() { if ( _dirty ) { recalc(); } return _absolute_view_pos; }
+ const SGQuatd& getViewOrientation() { if ( _dirty ) { recalc(); } return mViewOrientation; }
+ const SGQuatd& getViewOrientationOffset() { if ( _dirty ) { recalc(); } return mViewOffsetOr; }
+
+ //////////////////////////////////////////////////////////////////////
+ // Part 4: View and frustrum data setters and getters
+ //////////////////////////////////////////////////////////////////////
+
+ virtual void set_fov( double fov_deg ) {
+ _fov_deg = fov_deg;
+ }
+ virtual double get_fov() const { return _fov_deg; }
+ virtual double get_h_fov(); // Get horizontal fov, in degrees.
+ virtual double get_v_fov(); // Get vertical fov, in degrees.
- // surface direction to go to head towards sun
- sgVec3 surface_to_sun;
+ virtual void set_aspect_ratio( double r ) {
+ _aspect_ratio = r;
+ }
+ virtual double get_aspect_ratio() const { return _aspect_ratio; }
- // vector in cartesian coordinates from current position to the
- // postion on the earth's surface the moon is directly over
- sgVec3 to_moon;
-
- // surface direction to go to head towards moon
- sgVec3 surface_to_moon;
+ virtual void set_aspect_ratio_multiplier( double m ) {
+ _aspect_ratio_multiplier = m;
+ }
+ virtual double get_aspect_ratio_multiplier() const {
+ return _aspect_ratio_multiplier;
+ }
- // surface vector heading south
- sgVec3 surface_south;
+ virtual double getNear_m () const { return _ground_level_nearplane_m; }
+ inline void setNear_m (double near_m) {
+ _ground_level_nearplane_m = near_m;
+ }
- // surface vector heading east (used to unambiguously align sky
- // with sun)
- sgVec3 surface_east;
+ //////////////////////////////////////////////////////////////////////
+ // Part 5: misc setters and getters
+ //////////////////////////////////////////////////////////////////////
- // local up vector (normal to the plane tangent to the earth's
- // surface at the spot we are directly above
- sgVec3 local_up;
+ inline void set_dirty() { _dirty = true; }
+ inline void set_clean() { _dirty = false; }
+
+private:
- // up vector for the view (usually point straight up through the
- // top of the aircraft
- sgVec3 view_up;
+ //////////////////////////////////////////////////////////////////
+ // private data //
+ //////////////////////////////////////////////////////////////////
- // the vector pointing straight out the nose of the aircraft
- sgVec3 view_forward;
+ // flag forcing a recalc of derived view parameters
+ bool _dirty;
- // Transformation matrix for eye coordinates to aircraft coordinates
- // sgMat4 AIRCRAFT;
+ SGQuatd mViewOrientation;
+ SGQuatd mViewOffsetOr;
+ SGVec3d _absolute_view_pos;
- // Transformation matrix for the view direction offset relative to
- // the AIRCRAFT matrix
- sgMat4 VIEW_OFFSET;
+ SGGeod _position;
+ SGGeod _target;
- // sg versions of our friendly matrices
- sgMat4 LOCAL, UP, VIEW_ROT, TRANS, VIEW, LARC_TO_SSG;
+ double _roll_deg;
+ double _pitch_deg;
+ double _heading_deg;
+ double _target_roll_deg;
+ double _target_pitch_deg;
+ double _target_heading_deg;
-public:
+ double _damp_sync;
+ double _damp_roll;
+ double _damp_pitch;
+ double _damp_heading;
- // Constructor
- FGViewer( void );
+ double _damped_roll_deg;
+ double _damped_pitch_deg;
+ double _damped_heading_deg;
- // Destructor
- ~FGViewer( void );
-
- // Initialize a view class
- void Init( void );
-
- // Update the view volume, position, and orientation
- void UpdateViewParams( const FGInterface& f );
-
- // Flag to request that UpdateFOV() be called next time
- // UpdateViewMath() is run.
- inline void force_update_fov_math() { update_fov = true; }
-
- // Update the view parameters
- void UpdateViewMath( const FGInterface& f );
-
- // Update the field of view coefficients
- void UpdateFOV( const FGOptions *o );
-
- // Transform a vector from world coordinates to the local plane
- void CurrentNormalInLocalPlane(sgVec3 dst, sgVec3 src);
-
- // accessor functions
- inline double get_view_offset() const { return view_offset; }
- inline void set_view_offset( double a ) { view_offset = a; }
- inline void inc_view_offset( double amt ) { view_offset += amt; }
- inline double get_goal_view_offset() const { return goal_view_offset; }
- inline void set_goal_view_offset( double a) { goal_view_offset = a; }
- inline double get_win_ratio() const { return win_ratio; }
- inline void set_win_ratio( double r ) { win_ratio = r; }
- // inline int get_winWidth() const { return winWidth; }
- // inline void set_winWidth( int w ) { winWidth = w; }
- // inline int get_winHeight() const { return winHeight; }
- // inline void set_winHeight( int h ) { winHeight = h; }
- inline Point3D get_abs_view_pos() const { return abs_view_pos; }
- inline Point3D get_view_pos() const { return view_pos; }
- inline float *get_pilot_offset() { return pilot_offset; }
- inline void set_pilot_offset( float x, float y, float z ) {
- sgSetVec3( pilot_offset, x, y, z );
- }
- inline Point3D get_cur_zero_elev() const { return cur_zero_elev; }
- inline float *get_to_sun() { return to_sun; }
- inline void set_to_sun( float x, float y, float z ) {
- sgSetVec3( to_sun, x, y, z );
- }
- inline float *get_surface_to_sun() { return surface_to_sun; }
- inline void set_surface_to_sun( float x, float y, float z) {
- sgSetVec3( surface_to_sun, x, y, z );
+ // Position offsets from FDM origin. The X axis is positive
+ // out the tail, Y is out the right wing, and Z is positive up.
+ // distance in meters
+ SGVec3d _offset_m;
+
+ // Target offsets from FDM origin (for "lookat" targets) The X
+ // axis is positive out the tail, Y is out the right wing, and Z
+ // is positive up. distance in meters
+ SGVec3d _target_offset_m;
+
+
+ // orientation offsets from reference (_goal* are for smoothed transitions)
+ double _roll_offset_deg;
+ double _pitch_offset_deg;
+ double _heading_offset_deg;
+ double _goal_roll_offset_deg;
+ double _goal_pitch_offset_deg;
+ double _goal_heading_offset_deg;
+
+ // used to set nearplane when at ground level for this view
+ double _ground_level_nearplane_m;
+
+ fgViewType _type;
+ fgScalingType _scaling_type;
+
+ // internal view (e.g. cockpit) flag
+ bool _internal;
+
+ // view is looking from a model
+ bool _from_model;
+ int _from_model_index; // number of model (for multi model)
+
+ // view is looking at a model
+ bool _at_model;
+ int _at_model_index; // number of model (for multi model)
+
+ // the nominal field of view (angle, in degrees)
+ double _fov_deg;
+
+ // Ratio of window width and height; height = width *
+ // aspect_ratio. This value is automatically calculated based on
+ // window dimentions.
+ double _aspect_ratio;
+
+ // default = 1.0, this value is user configurable and is
+ // multiplied into the aspect_ratio to get the actual vertical fov
+ double _aspect_ratio_multiplier;
+
+ // camera group controled by this view
+ osg::ref_ptr<flightgear::CameraGroup> _cameraGroup;
+ //////////////////////////////////////////////////////////////////
+ // private functions //
+ //////////////////////////////////////////////////////////////////
+
+ void recalc ();
+ void recalcLookFrom();
+ void recalcLookAt();
+ void dampEyeData(double &roll_deg, double &pitch_deg, double &heading_deg);
+
+ // add to _heading_offset_deg
+ inline void incHeadingOffset_deg( double amt ) {
+ set_dirty();
+ _heading_offset_deg += amt;
}
- inline float *get_to_moon() { return to_moon; }
- inline void set_to_moon( float x, float y, float z) {
- sgSetVec3( to_moon, x, y, z );
+
+ // add to _pitch_offset_deg
+ inline void incPitchOffset_deg( double amt ) {
+ set_dirty();
+ _pitch_offset_deg += amt;
}
- inline float *get_surface_to_moon() { return surface_to_moon; }
- inline void set_surface_to_moon( float x, float y, float z) {
- sgSetVec3( surface_to_moon, x, y, z );
+
+ // add to _roll_offset_deg
+ inline void incRollOffset_deg( double amt ) {
+ set_dirty();
+ _roll_offset_deg += amt;
}
- inline float *get_surface_south() { return surface_south; }
- inline float *get_surface_east() { return surface_east; }
- inline float *get_local_up() { return local_up; }
- inline float *get_view_forward() { return view_forward; }
- inline const sgVec4 *get_VIEW() { return VIEW; }
- inline const sgVec4 *get_VIEW_ROT() { return VIEW_ROT; }
};
-#endif // _VIEWER_HXX
-
+#endif // _VIEWER_HXX
projects / flightgear.git / blobdiff