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           physicalWidth(0), physicalHeight(0), bezelHeightTop(0),
  57           bezelHeightBottom(0), bezelWidthLeft(0), bezelWidthRight(0),
  58           relativeCameraParent(~0u)
  59     {
  60     }
  61         /** Update and resize cameras
  62          */
  63         void updateCameras();
  64     /** The name as given in the config file.
  65      */
  66     std::string name;
  67     /** Properties of the camera. @see CameraGroup::Flags.
  68      */
  69     unsigned flags;
  70     /** the camera object
  71      */
  72     osg::ref_ptr<osg::Camera> camera;
  73     /** camera for rendering far field, if needed
  74      */
  75     osg::ref_ptr<osg::Camera> farCamera;
  76     /** Index of this camera in the osgViewer::Viewer slave list.
  77      */
  78     int slaveIndex;
  79     /** index of far camera in slave list
  80      */
  81     int farSlaveIndex;
  82     /** Viewport parameters.
  83      */
  84     double x;
  85     double y;
  86     double width;
  87     double height;
  88     /** Physical size parameters.
  89      */
  90     double physicalWidth;
  91     double physicalHeight;
  92     double bezelHeightTop;
  93     double bezelHeightBottom;
  94     double bezelWidthLeft;
  95     double bezelWidthRight;
  96     /** The parent camera for relative camera configurations.
  97      */
  98     unsigned relativeCameraParent;
  99     /** The reference points in the parents projection space.
 100      */
 101     osg::Vec2d parentReference[2];
 102     /** The reference points in the current projection space.
 103      */
 104     osg::Vec2d thisReference[2];
 105 };
 106
 107 /** Update the OSG cameras from the camera info.
 108  */
 109 void updateCameras(const CameraInfo* info);
 110
 111 class CameraGroup : public osg::Referenced
 112 {
 113 public:
 114     /** properties of a camera.
 115      */
 116     enum Flags
 117     {
 118         VIEW_ABSOLUTE = 0x1, /**< The camera view is absolute, not
 119                                 relative to the master camera. */
 120         PROJECTION_ABSOLUTE = 0x2, /**< The projection is absolute. */
 121         ORTHO = 0x4,               /**< The projection is orthographic */
 122         GUI = 0x8,                 /**< Camera draws the GUI. */
 123         DO_INTERSECTION_TEST = 0x10,/**< scene intersection tests this
 124                                        camera. */
 125         FIXED_NEAR_FAR = 0x20,     /**< take the near far values in the
 126                                       projection for real. */
 127         ENABLE_MASTER_ZOOM = 0x40  /**< Can apply the zoom algorithm. */
 128     };
 129     /** Create a camera group associated with an osgViewer::Viewer.
 130      * @param viewer the viewer
 131      */
 132     CameraGroup(osgViewer::Viewer* viewer);
 133     /** Get the camera group's Viewer.
 134      * @return the viewer
 135      */
 136     osgViewer::Viewer* getViewer() { return _viewer.get(); }
 137     /** Add a camera to the group. The camera is added to the viewer
 138      * as a slave. See osgViewer::Viewer::addSlave.
 139      * @param flags properties of the camera; see CameraGroup::Flags
 140      * @param projection slave projection matrix
 141      * @param view slave view matrix
 142      * @param useMasterSceneData whether the camera displays the
 143      * viewer's scene data.
 144      * @return a CameraInfo object for the camera.
 145      */
 146     CameraInfo* addCamera(unsigned flags, osg::Camera* camera,
 147                           const osg::Matrix& projection,
 148                           const osg::Matrix& view,
 149                           bool useMasterSceneData = true);
 150     /** Create an osg::Camera from a property node and add it to the
 151      * camera group.
 152      * @param cameraNode the property node.
 153      * @return a CameraInfo object for the camera.
 154      */
 155     CameraInfo* buildCamera(SGPropertyNode* cameraNode);
 156     /** Create a camera from properties that will draw the GUI and add
 157      * it to the camera group.
 158      * @param cameraNode the property node. This can be 0, in which
 159      * case a default GUI camera is created.
 160      * @param window the GraphicsWindow to use for the GUI camera. If
 161      * this is 0, the window is determined from the property node.
 162      * @return a CameraInfo object for the GUI camera.
 163      */
 164     CameraInfo* buildGUICamera(SGPropertyNode* cameraNode,
 165                                GraphicsWindow* window = 0);
 166     /** Update the view for the camera group.
 167      * @param position the world position of the view
 168      * @param orientation the world orientation of the view.
 169      */
 170     void update(const osg::Vec3d& position, const osg::Quat& orientation);
 171     /** Set the parameters of the viewer's master camera. This won't
 172      * affect cameras that have CameraFlags::PROJECTION_ABSOLUTE set.
 173      * XXX Should znear and zfar be settable?
 174      * @param vfov the vertical field of view angle
 175      * @param aspectRatio the master camera's aspect ratio. This
 176      * doesn't actually change the viewport, but should reflect the
 177      * current viewport.
 178      */
 179     void setCameraParameters(float vfov, float aspectRatio);
 180     /** Set the default CameraGroup, which is the only one that
 181      * matters at this time.
 182      * @param group the group to set.
 183      */
 184     static void setDefault(CameraGroup* group) { _defaultGroup = group; }
 185     /** Get the default CameraGroup.
 186      * @return the default camera group.
 187      */
 188     static CameraGroup* getDefault() { return _defaultGroup.get(); }
 189     typedef std::vector<osg::ref_ptr<CameraInfo> > CameraList;
 190     typedef CameraList::iterator CameraIterator;
 191     typedef CameraList::const_iterator ConstCameraIterator;
 192     /** Get iterator for camera vector. The iterator's value is a ref_ptr.
 193      */
 194     CameraIterator camerasBegin() { return _cameras.begin(); }
 195     /** Get iteator pointing to the end of the camera list.
 196      */
 197     CameraIterator camerasEnd() { return _cameras.end(); }
 198     ConstCameraIterator camerasBegin() const { return _cameras.begin(); }
 199     ConstCameraIterator camerasEnd() const { return _cameras.end(); }
 200     /** Build a complete CameraGroup from a property node.
 201      * @param viewer the viewer associated with this camera group.
 202      * @param the camera group property node.
 203      */
 204     static CameraGroup* buildCameraGroup(osgViewer::Viewer* viewer,
 205                                          SGPropertyNode* node);
 206     /** Set the cull mask on all non-GUI cameras
 207      */
 208     void setCameraCullMasks(osg::Node::NodeMask nm);
 209     /** Update camera properties after a resize event.
 210      */
 211     void resized();
 212
 213     void buildDistortionCamera(const SGPropertyNode* psNode,
 214                                osg::Camera* camera);
 215
 216     /**
 217      * get aspect ratio of master camera's viewport
 218      */
 219     double getMasterAspectRatio() const;
 220
 221     /**
 222      * find the GUI camera if one is defined
 223      */
 224     const CameraInfo* getGUICamera() const;
 225 protected:
 226     CameraList _cameras;
 227     osg::ref_ptr<osgViewer::Viewer> _viewer;
 228     static osg::ref_ptr<CameraGroup> _defaultGroup;
 229     // Near, far for the master camera if used.
 230     float _zNear;
 231     float _zFar;
 232     float _nearField;
 233     typedef std::map<std::string, osg::ref_ptr<osg::TextureRectangle> > TextureMap;
 234     TextureMap _textureTargets;
 235 };
 236
 237 }
 238
 239 namespace osgGA
 240 {
 241 class GUIEventAdapter;
 242 }
 243
 244 namespace flightgear
 245 {
 246 /** Get the osg::Camera that draws the GUI, if any, from a camera
 247  * group.
 248  * @param cgroup the camera group
 249  * @return the GUI camera or 0
 250  */
 251 osg::Camera* getGUICamera(CameraGroup* cgroup);
 252 /** Choose a camera using an event and do intersection testing on its
 253  * view of the scene. Only cameras with the DO_INTERSECTION_TEST flag
 254  * set are considered.
 255  * @param cgroup the CameraGroup
 256  * @param ea the event containing a window and mouse coordinates
 257  * @param intersections container for the result of intersection
 258  * testing.
 259  * @return true if any intersections are found
 260  */
 261 bool computeIntersections(const CameraGroup* cgroup,
 262                           const osgGA::GUIEventAdapter* ea,
 263                           osgUtil::LineSegmentIntersector::Intersections&
 264                           intersections);
 265 /** Warp the pointer to coordinates in the GUI camera of a camera group.
 266  * @param cgroup the camera group
 267  * @param x x window coordinate of pointer
 268  * @param y y window coordinate of pointer, in "y down" coordinates.
 269  */
 270 void warpGUIPointer(CameraGroup* cgroup, int x, int y);
 271 }
 272 #endif