src/Main/CameraGroup.hxx

   1 // Copyright (C) 2008  Tim Moore
   2 //
   3 // This program is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU General Public License as
   5 // published by the Free Software Foundation; either version 2 of the
   6 // License, or (at your option) any later version.
   7 //
   8 // This program is distributed in the hope that it will be useful, but
   9 // WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU General Public License
  14 // along with this program; if not, write to the Free Software
  15 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  16
  17 #ifndef CAMERAGROUP_HXX
  18 #define CAMERAGROUP_HXX 1
  19
  20 #include <map>
  21 #include <string>
  22 #include <vector>
  23
  24 #include <osg/Matrix>
  25 #include <osg/ref_ptr>
  26 #include <osg/Referenced>
  27 #include <osg/Node>
  28 #include <osg/TextureRectangle>
  29
  30 // For osgUtil::LineSegmentIntersector::Intersections, which is a typedef.
  31 #include <osgUtil/LineSegmentIntersector>
  32 namespace osg
  33 {
  34 class Camera;
  35 }
  36
  37 namespace osgViewer
  38 {
  39 class Viewer;
  40 }
  41
  42 class SGPropertyNode;
  43
  44 namespace flightgear
  45 {
  46
  47 class GraphicsWindow;
  48
  49 /** A wrapper around osg::Camera that contains some extra information.
  50  */
  51 struct CameraInfo : public osg::Referenced
  52 {
  53     CameraInfo(unsigned flags_, osg::Camera* camera_ = 0)
  54         : flags(flags_), camera(camera_), slaveIndex(-1), farSlaveIndex(-1),
  55           x(0.0), y(0.0), width(0.0), height(0.0)
  56     {
  57     }
  58     /** Properties of the camera. @see CameraGroup::Flags.
  59      */
  60     unsigned flags;
  61     /** the camera object
  62      */
  63     osg::ref_ptr<osg::Camera> camera;
  64     /** camera for rendering far field, if needed
  65      */
  66     osg::ref_ptr<osg::Camera> farCamera;
  67     /** Index of this camera in the osgViewer::Viewer slave list.
  68      */
  69     int slaveIndex;
  70     /** index of far camera in slave list
  71      */
  72     int farSlaveIndex;
  73     /** Viewport parameters.
  74      */
  75     double x;
  76     double y;
  77     double width;
  78     double height;
  79 };
  80
  81 /** Update the OSG cameras from the camera info.
  82  */
  83 void updateCameras(const CameraInfo* info);
  84
  85 class CameraGroup : public osg::Referenced
  86 {
  87 public:
  88     /** properties of a camera.
  89      */
  90     enum Flags
  91     {
  92         VIEW_ABSOLUTE = 0x1, /**< The camera view is absolute, not
  93                                 relative to the master camera. */
  94         PROJECTION_ABSOLUTE = 0x2, /**< The projection is absolute. */
  95         ORTHO = 0x4,               /**< The projection is orthographic */
  96         GUI = 0x8,                 /**< Camera draws the GUI. */
  97         DO_INTERSECTION_TEST = 0x10,/**< scene intersection tests this
  98                                        camera. */
  99         FIXED_NEAR_FAR = 0x20      /**< take the near far values in the
 100                                       projection for real. */
 101     };
 102     /** Create a camera group associated with an osgViewer::Viewer.
 103      * @param viewer the viewer
 104      */
 105     CameraGroup(osgViewer::Viewer* viewer);
 106     /** Get the camera group's Viewer.
 107      * @return the viewer
 108      */
 109     osgViewer::Viewer* getViewer() { return _viewer.get(); }
 110     /** Add a camera to the group. The camera is added to the viewer
 111      * as a slave. See osgViewer::Viewer::addSlave.
 112      * @param flags properties of the camera; see CameraGroup::Flags
 113      * @param projection slave projection matrix
 114      * @param view slave view matrix
 115      * @param useMasterSceneData whether the camera displays the
 116      * viewer's scene data.
 117      * @return a CameraInfo object for the camera.
 118      */
 119     CameraInfo* addCamera(unsigned flags, osg::Camera* camera,
 120                           const osg::Matrix& projection,
 121                           const osg::Matrix& view,
 122                           bool useMasterSceneData = true);
 123     /** Create an osg::Camera from a property node and add it to the
 124      * camera group.
 125      * @param cameraNode the property node.
 126      * @return a CameraInfo object for the camera.
 127      */
 128     CameraInfo* buildCamera(SGPropertyNode* cameraNode);
 129     /** Create a camera from properties that will draw the GUI and add
 130      * it to the camera group.
 131      * @param cameraNode the property node. This can be 0, in which
 132      * case a default GUI camera is created.
 133      * @param window the GraphicsWindow to use for the GUI camera. If
 134      * this is 0, the window is determined from the property node.
 135      * @return a CameraInfo object for the GUI camera.
 136      */
 137     CameraInfo* buildGUICamera(SGPropertyNode* cameraNode,
 138                                GraphicsWindow* window = 0);
 139     /** Update the view for the camera group.
 140      * @param position the world position of the view
 141      * @param orientation the world orientation of the view.
 142      */
 143     void update(const osg::Vec3d& position, const osg::Quat& orientation);
 144     /** Set the parameters of the viewer's master camera. This won't
 145      * affect cameras that have CameraFlags::PROJECTION_ABSOLUTE set.
 146      * XXX Should znear and zfar be settable?
 147      * @param vfov the vertical field of view angle
 148      * @param aspectRatio the master camera's aspect ratio. This
 149      * doesn't actually change the viewport, but should reflect the
 150      * current viewport.
 151      */
 152     void setCameraParameters(float vfov, float aspectRatio);
 153     /** Set the default CameraGroup, which is the only one that
 154      * matters at this time.
 155      * @param group the group to set.
 156      */
 157     static void setDefault(CameraGroup* group) { _defaultGroup = group; }
 158     /** Get the default CameraGroup.
 159      * @return the default camera group.
 160      */
 161     static CameraGroup* getDefault() { return _defaultGroup.get(); }
 162     typedef std::vector<osg::ref_ptr<CameraInfo> > CameraList;
 163     typedef CameraList::iterator CameraIterator;
 164     typedef CameraList::const_iterator ConstCameraIterator;
 165     /** Get iterator for camera vector. The iterator's value is a ref_ptr.
 166      */
 167     CameraIterator camerasBegin() { return _cameras.begin(); }
 168     /** Get iteator pointing to the end of the camera list.
 169      */
 170     CameraIterator camerasEnd() { return _cameras.end(); }
 171     ConstCameraIterator camerasBegin() const { return _cameras.begin(); }
 172     ConstCameraIterator camerasEnd() const { return _cameras.end(); }
 173     /** Build a complete CameraGroup from a property node.
 174      * @param viewer the viewer associated with this camera group.
 175      * @param the camera group property node.
 176      */
 177     static CameraGroup* buildCameraGroup(osgViewer::Viewer* viewer,
 178                                          SGPropertyNode* node);
 179     /** Set the cull mask on all non-GUI cameras
 180      */
 181     void setCameraCullMasks(osg::Node::NodeMask nm);
 182     /** Update camera properties after a resize event.
 183      */
 184     void resized();
 185
 186     void buildDistortionCamera(const SGPropertyNode* psNode,
 187                                osg::Camera* camera);
 188
 189     /**
 190      * get aspect ratio of master camera's viewport
 191      */
 192     double getMasterAspectRatio() const;
 193 protected:
 194     CameraList _cameras;
 195     osg::ref_ptr<osgViewer::Viewer> _viewer;
 196     static osg::ref_ptr<CameraGroup> _defaultGroup;
 197     // Near, far for the master camera if used.
 198     float _zNear;
 199     float _zFar;
 200     float _nearField;
 201     typedef std::map<std::string, osg::ref_ptr<osg::TextureRectangle> > TextureMap;
 202     TextureMap _textureTargets;
 203 };
 204
 205 }
 206
 207 namespace osgGA
 208 {
 209 class GUIEventAdapter;
 210 }
 211
 212 namespace flightgear
 213 {
 214 /** Get the osg::Camera that draws the GUI, if any, from a camera
 215  * group.
 216  * @param cgroup the camera group
 217  * @return the GUI camera or 0
 218  */
 219 osg::Camera* getGUICamera(CameraGroup* cgroup);
 220 /** Choose a camera using an event and do intersection testing on its
 221  * view of the scene. Only cameras with the DO_INTERSECTION_TEST flag
 222  * set are considered.
 223  * @param cgroup the CameraGroup
 224  * @param ea the event containing a window and mouse coordinates
 225  * @param intersections container for the result of intersection
 226  * testing.
 227  * @return true if any intersections are found
 228  */
 229 bool computeIntersections(const CameraGroup* cgroup,
 230                           const osgGA::GUIEventAdapter* ea,
 231                           osgUtil::LineSegmentIntersector::Intersections&
 232                           intersections);
 233 /** Warp the pointer to coordinates in the GUI camera of a camera group.
 234  * @param cgroup the camera group
 235  * @param x x window coordinate of pointer
 236  * @param y y window coordinate of pointer, in "y down" coordinates.
 237  */
 238 void warpGUIPointer(CameraGroup* cgroup, int x, int y);
 239 }
 240 #endif