1
0
Fork 0
flightgear/src/Main/CameraGroup.hxx
timoore d43e0b83f7 Expose the CameraGroup near, far, and near/far boundry as properties
The near/far boundary, called "near-field", can be set to 0 which
disables the far camera and renders the whole scene using only one
camera. I'm hoping that this may be useful in resolving some
system-specific rendering bugs.

Various fixes were made to correctly render the scene using only the
near camera.
2009-01-03 23:53:04 +01:00

226 lines
7.8 KiB
C++

// Copyright (C) 2008 Tim Moore
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 2 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#ifndef CAMERAGROUP_HXX
#define CAMERAGROUP_HXX 1
#include <string>
#include <vector>
#include <osg/Matrix>
#include <osg/ref_ptr>
#include <osg/Referenced>
#include <osg/Node>
// For osgUtil::LineSegmentIntersector::Intersections, which is a typedef.
#include <osgUtil/LineSegmentIntersector>
namespace osg
{
class Camera;
}
namespace osgViewer
{
class Viewer;
}
class SGPropertyNode;
namespace flightgear
{
class GraphicsWindow;
/** A wrapper around osg::Camera that contains some extra information.
*/
struct CameraInfo : public osg::Referenced
{
CameraInfo(unsigned flags_, osg::Camera* camera_ = 0)
: flags(flags_), camera(camera_), slaveIndex(-1), farSlaveIndex(-1),
x(0.0), y(0.0), width(0.0), height(0.0)
{
}
/** Properties of the camera. @see CameraGroup::Flags.
*/
unsigned flags;
/** the camera object
*/
osg::ref_ptr<osg::Camera> camera;
/** camera for rendering far field, if needed
*/
osg::ref_ptr<osg::Camera> farCamera;
/** Index of this camera in the osgViewer::Viewer slave list.
*/
int slaveIndex;
/** index of far camera in slave list
*/
int farSlaveIndex;
/** Viewport parameters.
*/
double x;
double y;
double width;
double height;
};
/** Update the OSG cameras from the camera info.
*/
void updateCameras(const CameraInfo* info);
class CameraGroup : public osg::Referenced
{
public:
/** properties of a camera.
*/
enum Flags
{
VIEW_ABSOLUTE = 0x1, /**< The camera view is absolute, not
relative to the master camera. */
PROJECTION_ABSOLUTE = 0x2, /**< The projection is absolute. */
ORTHO = 0x4, /**< The projection is orthographic */
GUI = 0x8, /**< Camera draws the GUI. */
DO_INTERSECTION_TEST = 0x10 /**< scene intersection tests this
camera. */
};
/** Create a camera group associated with an osgViewer::Viewer.
* @param viewer the viewer
*/
CameraGroup(osgViewer::Viewer* viewer);
/** Get the camera group's Viewer.
* @return the viewer
*/
osgViewer::Viewer* getViewer() { return _viewer.get(); }
/** Add a camera to the group. The camera is added to the viewer
* as a slave. See osgViewer::Viewer::addSlave.
* @param flags properties of the camera; see CameraGroup::Flags
* @param projection slave projection matrix
* @param view slave view matrix
* @param useMasterSceneData whether the camera displays the
* viewer's scene data.
* @return a CameraInfo object for the camera.
*/
CameraInfo* addCamera(unsigned flags, osg::Camera* camera,
const osg::Matrix& projection,
const osg::Matrix& view,
bool useMasterSceneData = true);
/** Create an osg::Camera from a property node and add it to the
* camera group.
* @param cameraNode the property node.
* @return a CameraInfo object for the camera.
*/
CameraInfo* buildCamera(SGPropertyNode* cameraNode);
/** Create a camera from properties that will draw the GUI and add
* it to the camera group.
* @param cameraNode the property node. This can be 0, in which
* case a default GUI camera is created.
* @param window the GraphicsWindow to use for the GUI camera. If
* this is 0, the window is determined from the property node.
* @return a CameraInfo object for the GUI camera.
*/
CameraInfo* buildGUICamera(SGPropertyNode* cameraNode,
GraphicsWindow* window = 0);
/** Update the view for the camera group.
* @param position the world position of the view
* @param orientation the world orientation of the view.
*/
void update(const osg::Vec3d& position, const osg::Quat& orientation);
/** Set the parameters of the viewer's master camera. This won't
* affect cameras that have CameraFlags::PROJECTION_ABSOLUTE set.
* XXX Should znear and zfar be settable?
* @param vfov the vertical field of view angle
* @param aspectRatio the master camera's aspect ratio. This
* doesn't actually change the viewport, but should reflect the
* current viewport.
*/
void setCameraParameters(float vfov, float aspectRatio);
/** Set the default CameraGroup, which is the only one that
* matters at this time.
* @param group the group to set.
*/
static void setDefault(CameraGroup* group) { _defaultGroup = group; }
/** Get the default CameraGroup.
* @return the default camera group.
*/
static CameraGroup* getDefault() { return _defaultGroup.get(); }
typedef std::vector<osg::ref_ptr<CameraInfo> > CameraList;
typedef CameraList::iterator CameraIterator;
typedef CameraList::const_iterator ConstCameraIterator;
/** Get iterator for camera vector. The iterator's value is a ref_ptr.
*/
CameraIterator camerasBegin() { return _cameras.begin(); }
/** Get iteator pointing to the end of the camera list.
*/
CameraIterator camerasEnd() { return _cameras.end(); }
ConstCameraIterator camerasBegin() const { return _cameras.begin(); }
ConstCameraIterator camerasEnd() const { return _cameras.end(); }
/** Build a complete CameraGroup from a property node.
* @param viewer the viewer associated with this camera group.
* @param the camera group property node.
*/
static CameraGroup* buildCameraGroup(osgViewer::Viewer* viewer,
SGPropertyNode* node);
/** Set the cull mask on all non-GUI cameras
*/
void setCameraCullMasks(osg::Node::NodeMask nm);
/** Update camera properties after a resize event.
*/
void resized();
protected:
CameraList _cameras;
osg::ref_ptr<osgViewer::Viewer> _viewer;
static osg::ref_ptr<CameraGroup> _defaultGroup;
// Near, far for the master camera if used.
float _zNear;
float _zFar;
float _nearField;
};
}
namespace osgGA
{
class GUIEventAdapter;
}
namespace flightgear
{
/** Get the osg::Camera that draws the GUI, if any, from a camera
* group.
* @param cgroup the camera group
* @return the GUI camera or 0
*/
osg::Camera* getGUICamera(CameraGroup* cgroup);
/** Choose a camera using an event and do intersection testing on its
* view of the scene. Only cameras with the DO_INTERSECTION_TEST flag
* set are considered.
* @param cgroup the CameraGroup
* @param ea the event containing a window and mouse coordinates
* @param intersections container for the result of intersection
* testing.
* @return true if any intersections are found
*/
bool computeIntersections(const CameraGroup* cgroup,
const osgGA::GUIEventAdapter* ea,
osgUtil::LineSegmentIntersector::Intersections&
intersections);
/** Warp the pointer to coordinates in the GUI camera of a camera group.
* @param cgroup the camera group
* @param x x window coordinate of pointer
* @param y y window coordinate of pointer, in "y down" coordinates.
*/
void warpGUIPointer(CameraGroup* cgroup, int x, int y);
}
#endif