src/Viewer/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 #include <osg/Texture2D>
  30 #include <osg/TexGen>
  31 #include <osgUtil/RenderBin>
  32
  33 // For osgUtil::LineSegmentIntersector::Intersections, which is a typedef.
  34 #include <osgUtil/LineSegmentIntersector>
  35 namespace osg
  36 {
  37 class Camera;
  38 }
  39
  40 namespace osgViewer
  41 {
  42 class Viewer;
  43 }
  44
  45 class SGPropertyNode;
  46
  47 namespace flightgear
  48 {
  49
  50 class GraphicsWindow;
  51
  52 struct RenderBufferInfo {
  53     RenderBufferInfo(osg::Texture2D* t = 0, float s = 1.0 ) : texture(t), scaleFactor(s) {}
  54     osg::ref_ptr<osg::Texture2D> texture;
  55     float scaleFactor;
  56 };
  57 typedef std::map<std::string,RenderBufferInfo> RenderBufferMap;
  58 typedef std::map<osg::Camera::BufferComponent,std::string> AttachmentMap;
  59
  60 struct RenderStageInfo {
  61     RenderStageInfo(osg::Camera* camera_ = 0, int si = -1, bool fs = false)
  62         : camera(camera_), slaveIndex(si), scaleFactor(1.0f), fullscreen(fs)
  63         , resizable(true)
  64     {
  65     }
  66
  67     osg::ref_ptr<osg::Camera> camera;
  68     AttachmentMap buffers;
  69     int slaveIndex;
  70     float scaleFactor;
  71     bool fullscreen;
  72     bool resizable;
  73 };
  74
  75 extern const char* MAIN_CAMERA;
  76 extern const char* FAR_CAMERA;
  77 extern const char* GEOMETRY_CAMERA;
  78 extern const char* SHADOW_CAMERA;
  79 extern const char* LIGHTING_CAMERA;
  80 extern const char* DISPLAY_CAMERA;
  81
  82 typedef std::map<std::string,RenderStageInfo> CameraMap;
  83
  84 /** A wrapper around osg::Camera that contains some extra information.
  85  */
  86 struct CameraInfo : public osg::Referenced
  87 {
  88     CameraInfo(unsigned flags_)
  89         : flags(flags_),
  90           x(0.0), y(0.0), width(0.0), height(0.0),
  91           physicalWidth(0), physicalHeight(0), bezelHeightTop(0),
  92           bezelHeightBottom(0), bezelWidthLeft(0), bezelWidthRight(0),
  93           relativeCameraParent(~0u),
  94           bufferSize( new osg::Uniform("fg_BufferSize", osg::Vec2f() ) ),
  95           projInverse( new osg::Uniform( "fg_ProjectionMatrixInverse", osg::Matrixf() ) ),
  96           viewInverse( new osg::Uniform( "fg_ViewMatrixInverse",osg::Matrixf() ) ),
  97           view( new osg::Uniform( "fg_ViewMatrix",osg::Matrixf() ) ),
  98           worldPosCart( new osg::Uniform( "fg_CameraPositionCart", osg::Vec3f() ) ),
  99           worldPosGeod( new osg::Uniform( "fg_CameraPositionGeod", osg::Vec3f() ) ),
 100           du( new osg::Uniform( "fg_du",osg::Vec4() ) ),
 101           dv( new osg::Uniform( "fg_dv",osg::Vec4() ) )
 102     {
 103         shadowMatrix[0] = new osg::Uniform("fg_ShadowMatrix_0", osg::Matrixf());
 104         shadowMatrix[1] = new osg::Uniform("fg_ShadowMatrix_1", osg::Matrixf());
 105         shadowMatrix[2] = new osg::Uniform("fg_ShadowMatrix_2", osg::Matrixf());
 106         shadowMatrix[3] = new osg::Uniform("fg_ShadowMatrix_3", osg::Matrixf());
 107     }
 108
 109     /** Update and resize cameras
 110      */
 111     void updateCameras();
 112     void resized(double w, double h);
 113     /** The name as given in the config file.
 114      */
 115     std::string name;
 116     /** Properties of the camera. @see CameraGroup::Flags.
 117      */
 118     unsigned flags;
 119
 120     /** Viewport parameters.
 121      */
 122     double x;
 123     double y;
 124     double width;
 125     double height;
 126     /** Physical size parameters.
 127      */
 128     double physicalWidth;
 129     double physicalHeight;
 130     double bezelHeightTop;
 131     double bezelHeightBottom;
 132     double bezelWidthLeft;
 133     double bezelWidthRight;
 134     /** The parent camera for relative camera configurations.
 135      */
 136     unsigned relativeCameraParent;
 137
 138     /** the camera objects
 139      */
 140     CameraMap cameras;
 141     void addCamera( const std::string& k, osg::Camera* c, int si = -1, bool fs = false ) { cameras[k].camera = c; cameras[k].slaveIndex = si; cameras[k].fullscreen = fs; }
 142     void addCamera( const std::string& k, osg::Camera* c, bool fs ) { cameras[k].camera = c; cameras[k].fullscreen = fs; }
 143     void addCamera( const std::string& k, osg::Camera* c, float s, bool fs = false ) { cameras[k].camera = c; cameras[k].scaleFactor = s; cameras[k].fullscreen = fs; }
 144     osg::Camera* getCamera(const std::string& k) const;
 145     int getMainSlaveIndex() const;
 146     RenderStageInfo& getRenderStageInfo( const std::string& k ) { return cameras[k]; }
 147
 148     /** the buffer objects
 149      */
 150     RenderBufferMap buffers;
 151     void addBuffer(const std::string& k, osg::Texture2D* tex, float scale = 1.0 ) { buffers[k] = RenderBufferInfo(tex,scale); }
 152     osg::Texture2D* getBuffer(const std::string& k) const;
 153
 154     osg::ref_ptr<osg::Uniform> bufferSize;
 155     osg::ref_ptr<osg::Uniform> projInverse;
 156     osg::ref_ptr<osg::Uniform> viewInverse;
 157     osg::ref_ptr<osg::Uniform> view;
 158     osg::ref_ptr<osg::Uniform> worldPosCart;
 159     osg::ref_ptr<osg::Uniform> worldPosGeod;
 160     osg::ref_ptr<osg::Uniform> du;
 161     osg::ref_ptr<osg::Uniform> dv;
 162     osg::ref_ptr<osg::Uniform> shadowMatrix[4];
 163
 164     void setMatrices( osg::Camera* c );
 165
 166     osgUtil::RenderBin::RenderBinList savedTransparentBins;
 167     /** The reference points in the parents projection space.
 168      */
 169     osg::Vec2d parentReference[2];
 170     /** The reference points in the current projection space.
 171      */
 172     osg::Vec2d thisReference[2];
 173 };
 174
 175 /** Update the OSG cameras from the camera info.
 176  */
 177 void updateCameras(const CameraInfo* info);
 178
 179 class CameraGroup : public osg::Referenced
 180 {
 181 public:
 182     /** properties of a camera.
 183      */
 184     enum Flags
 185     {
 186         VIEW_ABSOLUTE = 0x1, /**< The camera view is absolute, not
 187                                 relative to the master camera. */
 188         PROJECTION_ABSOLUTE = 0x2, /**< The projection is absolute. */
 189         ORTHO = 0x4,               /**< The projection is orthographic */
 190         GUI = 0x8,                 /**< Camera draws the GUI. */
 191         DO_INTERSECTION_TEST = 0x10,/**< scene intersection tests this
 192                                        camera. */
 193         FIXED_NEAR_FAR = 0x20,     /**< take the near far values in the
 194                                       projection for real. */
 195         ENABLE_MASTER_ZOOM = 0x40  /**< Can apply the zoom algorithm. */
 196     };
 197     /** Create a camera group associated with an osgViewer::Viewer.
 198      * @param viewer the viewer
 199      */
 200     CameraGroup(osgViewer::Viewer* viewer);
 201     /** Get the camera group's Viewer.
 202      * @return the viewer
 203      */
 204     osgViewer::Viewer* getViewer() { return _viewer.get(); }
 205     /** Create an osg::Camera from a property node and add it to the
 206      * camera group.
 207      * @param cameraNode the property node.
 208      * @return a CameraInfo object for the camera.
 209      */
 210     CameraInfo* buildCamera(SGPropertyNode* cameraNode);
 211     /** Create a camera from properties that will draw the GUI and add
 212      * it to the camera group.
 213      * @param cameraNode the property node. This can be 0, in which
 214      * case a default GUI camera is created.
 215      * @param window the GraphicsWindow to use for the GUI camera. If
 216      * this is 0, the window is determined from the property node.
 217      * @return a CameraInfo object for the GUI camera.
 218      */
 219     CameraInfo* buildGUICamera(SGPropertyNode* cameraNode,
 220                                GraphicsWindow* window = 0);
 221     /** Update the view for the camera group.
 222      * @param position the world position of the view
 223      * @param orientation the world orientation of the view.
 224      */
 225     void update(const osg::Vec3d& position, const osg::Quat& orientation);
 226     /** Set the parameters of the viewer's master camera. This won't
 227      * affect cameras that have CameraFlags::PROJECTION_ABSOLUTE set.
 228      * XXX Should znear and zfar be settable?
 229      * @param vfov the vertical field of view angle
 230      * @param aspectRatio the master camera's aspect ratio. This
 231      * doesn't actually change the viewport, but should reflect the
 232      * current viewport.
 233      */
 234     void setCameraParameters(float vfov, float aspectRatio);
 235     /** Set the default CameraGroup, which is the only one that
 236      * matters at this time.
 237      * @param group the group to set.
 238      */
 239     static void setDefault(CameraGroup* group) { _defaultGroup = group; }
 240     /** Get the default CameraGroup.
 241      * @return the default camera group.
 242      */
 243     static CameraGroup* getDefault() { return _defaultGroup.get(); }
 244     typedef std::vector<osg::ref_ptr<CameraInfo> > CameraList;
 245     typedef CameraList::iterator CameraIterator;
 246     typedef CameraList::const_iterator ConstCameraIterator;
 247     /** Get iterator for camera vector. The iterator's value is a ref_ptr.
 248      */
 249     CameraIterator camerasBegin() { return _cameras.begin(); }
 250     /** Get iteator pointing to the end of the camera list.
 251      */
 252     CameraIterator camerasEnd() { return _cameras.end(); }
 253     ConstCameraIterator camerasBegin() const { return _cameras.begin(); }
 254     ConstCameraIterator camerasEnd() const { return _cameras.end(); }
 255     void addCamera(CameraInfo* info) { _cameras.push_back(info); }
 256     /** Build a complete CameraGroup from a property node.
 257      * @param viewer the viewer associated with this camera group.
 258      * @param the camera group property node.
 259      */
 260     static CameraGroup* buildCameraGroup(osgViewer::Viewer* viewer,
 261                                          SGPropertyNode* node);
 262     /** Set the cull mask on all non-GUI cameras
 263      */
 264     void setCameraCullMasks(osg::Node::NodeMask nm);
 265     /** Update camera properties after a resize event.
 266      */
 267     void resized();
 268
 269     void buildDistortionCamera(const SGPropertyNode* psNode,
 270                                osg::Camera* camera);
 271
 272     /**
 273      * get aspect ratio of master camera's viewport
 274      */
 275     double getMasterAspectRatio() const;
 276
 277     /**
 278      * find the GUI camera if one is defined
 279      */
 280     const CameraInfo* getGUICamera() const;
 281 protected:
 282     CameraList _cameras;
 283     osg::ref_ptr<osgViewer::Viewer> _viewer;
 284     static osg::ref_ptr<CameraGroup> _defaultGroup;
 285     // Near, far for the master camera if used.
 286     float _zNear;
 287     float _zFar;
 288     float _nearField;
 289     typedef std::map<std::string, osg::ref_ptr<osg::TextureRectangle> > TextureMap;
 290     TextureMap _textureTargets;
 291 };
 292
 293 }
 294
 295 namespace osgGA
 296 {
 297 class GUIEventAdapter;
 298 }
 299
 300 namespace flightgear
 301 {
 302 /** Get the osg::Camera that draws the GUI, if any, from a camera
 303  * group.
 304  * @param cgroup the camera group
 305  * @return the GUI camera or 0
 306  */
 307 osg::Camera* getGUICamera(CameraGroup* cgroup);
 308 /** Choose a camera using an event and do intersection testing on its
 309  * view of the scene. Only cameras with the DO_INTERSECTION_TEST flag
 310  * set are considered.
 311  * @param cgroup the CameraGroup
 312  * @param ea the event containing a window and mouse coordinates
 313  * @param intersections container for the result of intersection
 314  * testing.
 315  * @return true if any intersections are found
 316  */
 317 bool computeIntersections(const CameraGroup* cgroup,
 318                           const osgGA::GUIEventAdapter* ea,
 319                           osgUtil::LineSegmentIntersector::Intersections&
 320                           intersections);
 321 /** Warp the pointer to coordinates in the GUI camera of a camera group.
 322  * @param cgroup the camera group
 323  * @param x x window coordinate of pointer
 324  * @param y y window coordinate of pointer, in "y down" coordinates.
 325  */
 326 void warpGUIPointer(CameraGroup* cgroup, int x, int y);
 327 }
 328 #endif