1
0
Fork 0
flightgear/src/Main/CameraGroup.cxx
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

592 lines
23 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.
#include "CameraGroup.hxx"
#include "globals.hxx"
#include "renderer.hxx"
#include "FGEventHandler.hxx"
#include "WindowBuilder.hxx"
#include "WindowSystemAdapter.hxx"
#include <simgear/props/props.hxx>
#include <simgear/structure/OSGUtils.hxx>
#include <simgear/scene/util/RenderConstants.hxx>
#include <algorithm>
#include <cstring>
#include <string>
#include <osg/Camera>
#include <osg/GraphicsContext>
#include <osg/Math>
#include <osg/Matrix>
#include <osg/Quat>
#include <osg/Vec3d>
#include <osg/Viewport>
#include <osgUtil/IntersectionVisitor>
#include <osgViewer/GraphicsWindow>
namespace flightgear
{
using namespace osg;
using std::strcmp;
using std::string;
ref_ptr<CameraGroup> CameraGroup::_defaultGroup;
CameraGroup::CameraGroup(osgViewer::Viewer* viewer) :
_viewer(viewer)
{
}
}
namespace
{
using namespace osg;
// Given a projection matrix, return a new one with the same frustum
// sides and new near / far values.
void makeNewProjMat(Matrixd& oldProj, double znear,
double zfar, Matrixd& projection)
{
projection = oldProj;
// Slightly inflate the near & far planes to avoid objects at the
// extremes being clipped out.
znear *= 0.999;
zfar *= 1.001;
// Clamp the projection matrix z values to the range (near, far)
double epsilon = 1.0e-6;
if (fabs(projection(0,3)) < epsilon &&
fabs(projection(1,3)) < epsilon &&
fabs(projection(2,3)) < epsilon) {
// Projection is Orthographic
epsilon = -1.0/(zfar - znear); // Used as a temp variable
projection(2,2) = 2.0*epsilon;
projection(3,2) = (zfar + znear)*epsilon;
} else {
// Projection is Perspective
double trans_near = (-znear*projection(2,2) + projection(3,2)) /
(-znear*projection(2,3) + projection(3,3));
double trans_far = (-zfar*projection(2,2) + projection(3,2)) /
(-zfar*projection(2,3) + projection(3,3));
double ratio = fabs(2.0/(trans_near - trans_far));
double center = -0.5*(trans_near + trans_far);
projection.postMult(osg::Matrixd(1.0, 0.0, 0.0, 0.0,
0.0, 1.0, 0.0, 0.0,
0.0, 0.0, ratio, 0.0,
0.0, 0.0, center*ratio, 1.0));
}
}
void installCullVisitor(Camera* camera)
{
#if 0 // Not yet
osgViewer::Renderer* renderer
= static_cast<osgViewer::Renderer*>(camera->getRenderer());
for (int i = 0; i < 2; ++i) {
osgUtil::SceneView* sceneView = renderer->getSceneView(i);
sceneView->setCullVisitor(new simgear::EffectCullVisitor);
}
#endif
}
}
namespace flightgear
{
void updateCameras(const CameraInfo* info)
{
if (info->camera.valid())
info->camera->getViewport()->setViewport(info->x, info->y,
info->width, info->height);
if (info->farCamera.valid())
info->farCamera->getViewport()->setViewport(info->x, info->y,
info->width, info->height);
}
CameraInfo* CameraGroup::addCamera(unsigned flags, Camera* camera,
const Matrix& view,
const Matrix& projection,
bool useMasterSceneData)
{
CameraInfo* info = new CameraInfo(flags);
// The camera group will always update the camera
camera->setReferenceFrame(Transform::ABSOLUTE_RF);
Camera* farCamera = 0;
if ((flags & (GUI | ORTHO)) == 0) {
farCamera = simgear::clone(camera);
farCamera->setGraphicsContext(camera->getGraphicsContext());
// Each camera's viewport is written when the window is
// resized; if the the viewport isn't copied here, it gets updated
// twice and ends up with the wrong value.
farCamera->setViewport(simgear::clone(camera->getViewport()));
_viewer->addSlave(farCamera, view, projection, useMasterSceneData);
installCullVisitor(farCamera);
info->farCamera = farCamera;
info->farSlaveIndex = _viewer->getNumSlaves() - 1;
farCamera->setRenderOrder(Camera::NESTED_RENDER, info->farSlaveIndex);
camera->setCullMask(camera->getCullMask() & ~simgear::BACKGROUND_BIT);
camera->setClearMask(GL_DEPTH_BUFFER_BIT);
}
_viewer->addSlave(camera, view, projection, useMasterSceneData);
installCullVisitor(camera);
info->camera = camera;
info->slaveIndex = _viewer->getNumSlaves() - 1;
camera->setRenderOrder(Camera::NESTED_RENDER, info->slaveIndex);
_cameras.push_back(info);
return info;
}
void CameraGroup::update(const osg::Vec3d& position,
const osg::Quat& orientation)
{
const Matrix masterView(osg::Matrix::translate(-position)
* osg::Matrix::rotate(orientation.inverse()));
_viewer->getCamera()->setViewMatrix(masterView);
const Matrix& masterProj = _viewer->getCamera()->getProjectionMatrix();
for (CameraList::iterator i = _cameras.begin(); i != _cameras.end(); ++i) {
const CameraInfo* info = i->get();
const View::Slave& slave = _viewer->getSlave(info->slaveIndex);
// refreshes camera viewports (for now)
updateCameras(info);
Camera* camera = info->camera.get();
Matrix viewMatrix;
if ((info->flags & VIEW_ABSOLUTE) != 0)
viewMatrix = slave._viewOffset;
else
viewMatrix = masterView * slave._viewOffset;
camera->setViewMatrix(viewMatrix);
Matrix projectionMatrix;
if ((info->flags & PROJECTION_ABSOLUTE) != 0)
projectionMatrix = slave._projectionOffset;
else
projectionMatrix = masterProj * slave._projectionOffset;
if (!info->farCamera.valid()) {
camera->setProjectionMatrix(projectionMatrix);
} else {
Camera* farCamera = info->farCamera.get();
farCamera->setViewMatrix(viewMatrix);
double left, right, bottom, top, parentNear, parentFar;
projectionMatrix.getFrustum(left, right, bottom, top,
parentNear, parentFar);
if (parentFar < _nearField || _nearField == 0.0f) {
camera->setProjectionMatrix(projectionMatrix);
camera->setCullMask(camera->getCullMask()
| simgear::BACKGROUND_BIT);
camera->setClearMask(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
farCamera->setNodeMask(0);
} else {
Matrix nearProj, farProj;
makeNewProjMat(projectionMatrix, parentNear, _nearField,
nearProj);
makeNewProjMat(projectionMatrix, _nearField, parentFar,
farProj);
camera->setProjectionMatrix(nearProj);
camera->setCullMask(camera->getCullMask()
& ~simgear::BACKGROUND_BIT);
camera->setClearMask(GL_DEPTH_BUFFER_BIT);
farCamera->setProjectionMatrix(farProj);
farCamera->setNodeMask(camera->getNodeMask());
}
}
}
}
void CameraGroup::setCameraParameters(float vfov, float aspectRatio)
{
_viewer->getCamera()->setProjectionMatrixAsPerspective(vfov,
1.0f / aspectRatio,
_zNear, _zFar);
}
}
namespace
{
// A raw value for property nodes that references a class member via
// an osg::ref_ptr.
template<class C, class T>
class RefMember : public SGRawValue<T>
{
public:
RefMember (C *obj, T C::*ptr)
: _obj(obj), _ptr(ptr) {}
virtual ~RefMember () {}
virtual T getValue () const
{
return _obj.get()->*_ptr;
}
virtual bool setValue (T value)
{
_obj.get()->*_ptr = value;
return true;
}
virtual SGRawValue<T> * clone () const
{
return new RefMember(_obj.get(), _ptr);
}
private:
ref_ptr<C> _obj;
T C::* const _ptr;
};
template<typename C, typename T>
RefMember<C, T> makeRefMember(C *obj, T C::*ptr)
{
return RefMember<C, T>(obj, ptr);
}
template<typename C, typename T>
void bindMemberToNode(SGPropertyNode* parent, const char* childName,
C* obj, T C::*ptr, T value)
{
SGPropertyNode* valNode = parent->getNode(childName);
RefMember<C, T> refMember = makeRefMember(obj, ptr);
if (!valNode) {
valNode = parent->getNode(childName, true);
valNode->tie(refMember, false);
setValue(valNode, value);
} else {
valNode->tie(refMember, true);
}
}
void buildViewport(flightgear::CameraInfo* info, SGPropertyNode* viewportNode,
const osg::GraphicsContext::Traits *traits)
{
using namespace flightgear;
bindMemberToNode(viewportNode, "x", info, &CameraInfo::x, 0.0);
bindMemberToNode(viewportNode, "y", info, &CameraInfo::y, 0.0);
bindMemberToNode(viewportNode, "width", info, &CameraInfo::width,
static_cast<double>(traits->width));
bindMemberToNode(viewportNode, "height", info, &CameraInfo::height,
static_cast<double>(traits->height));
}
}
namespace flightgear
{
CameraInfo* CameraGroup::buildCamera(SGPropertyNode* cameraNode)
{
WindowBuilder *wBuild = WindowBuilder::getWindowBuilder();
const SGPropertyNode* windowNode = cameraNode->getNode("window");
GraphicsWindow* window = 0;
static int cameraNum = 0;
int cameraFlags = DO_INTERSECTION_TEST;
if (windowNode) {
// New style window declaration / definition
window = wBuild->buildWindow(windowNode);
} else {
// Old style: suck window params out of camera block
window = wBuild->buildWindow(cameraNode);
}
if (!window) {
return 0;
}
Camera* camera = new Camera;
camera->setAllowEventFocus(false);
camera->setGraphicsContext(window->gc.get());
camera->setViewport(new Viewport);
camera->setCullingMode(CullSettings::SMALL_FEATURE_CULLING
| CullSettings::VIEW_FRUSTUM_CULLING);
camera->setInheritanceMask(CullSettings::ALL_VARIABLES
& ~(CullSettings::CULL_MASK
| CullSettings::CULLING_MODE));
osg::Matrix pOff;
osg::Matrix vOff;
const SGPropertyNode* viewNode = cameraNode->getNode("view");
if (viewNode) {
double heading = viewNode->getDoubleValue("heading-deg", 0.0);
double pitch = viewNode->getDoubleValue("pitch-deg", 0.0);
double roll = viewNode->getDoubleValue("roll-deg", 0.0);
double x = viewNode->getDoubleValue("x", 0.0);
double y = viewNode->getDoubleValue("y", 0.0);
double z = viewNode->getDoubleValue("z", 0.0);
// Build a view matrix, which is the inverse of a model
// orientation matrix.
vOff = (Matrix::translate(-x, -y, -z)
* Matrix::rotate(-DegreesToRadians(heading),
Vec3d(0.0, 1.0, 0.0),
-DegreesToRadians(pitch),
Vec3d(1.0, 0.0, 0.0),
-DegreesToRadians(roll),
Vec3d(0.0, 0.0, 1.0)));
if (viewNode->getBoolValue("absolute", false))
cameraFlags |= VIEW_ABSOLUTE;
} else {
// Old heading parameter, works in the opposite direction
double heading = cameraNode->getDoubleValue("heading-deg", 0.0);
vOff.makeRotate(DegreesToRadians(heading), osg::Vec3(0, 1, 0));
}
const SGPropertyNode* projectionNode = 0;
if ((projectionNode = cameraNode->getNode("perspective")) != 0) {
double fovy = projectionNode->getDoubleValue("fovy-deg", 55.0);
double aspectRatio = projectionNode->getDoubleValue("aspect-ratio",
1.0);
double zNear = projectionNode->getDoubleValue("near", 0.0);
double zFar = projectionNode->getDoubleValue("far", 0.0);
double offsetX = projectionNode->getDoubleValue("offset-x", 0.0);
double offsetY = projectionNode->getDoubleValue("offset-y", 0.0);
double tan_fovy = tan(DegreesToRadians(fovy*0.5));
double right = tan_fovy * aspectRatio * zNear + offsetX;
double left = -tan_fovy * aspectRatio * zNear + offsetX;
double top = tan_fovy * zNear + offsetY;
double bottom = -tan_fovy * zNear + offsetY;
pOff.makeFrustum(left, right, bottom, top, zNear, zFar);
cameraFlags |= PROJECTION_ABSOLUTE;
} else if ((projectionNode = cameraNode->getNode("frustum")) != 0
|| (projectionNode = cameraNode->getNode("ortho")) != 0) {
double top = projectionNode->getDoubleValue("top", 0.0);
double bottom = projectionNode->getDoubleValue("bottom", 0.0);
double left = projectionNode->getDoubleValue("left", 0.0);
double right = projectionNode->getDoubleValue("right", 0.0);
double zNear = projectionNode->getDoubleValue("near", 0.0);
double zFar = projectionNode->getDoubleValue("far", 0.0);
if (cameraNode->getNode("frustum")) {
pOff.makeFrustum(left, right, bottom, top, zNear, zFar);
cameraFlags |= PROJECTION_ABSOLUTE;
} else {
pOff.makeOrtho(left, right, bottom, top, zNear, zFar);
cameraFlags |= (PROJECTION_ABSOLUTE | ORTHO);
}
} else {
// old style shear parameters
double shearx = cameraNode->getDoubleValue("shear-x", 0);
double sheary = cameraNode->getDoubleValue("shear-y", 0);
pOff.makeTranslate(-shearx, -sheary, 0);
}
CameraInfo* info = addCamera(cameraFlags, camera, pOff, vOff);
// If a viewport isn't set on the camera, then it's hard to dig it
// out of the SceneView objects in the viewer, and the coordinates
// of mouse events are somewhat bizzare.
SGPropertyNode* viewportNode = cameraNode->getNode("viewport", true);
buildViewport(info, viewportNode, window->gc->getTraits());
updateCameras(info);
return info;
}
CameraInfo* CameraGroup::buildGUICamera(SGPropertyNode* cameraNode,
GraphicsWindow* window)
{
WindowBuilder *wBuild = WindowBuilder::getWindowBuilder();
const SGPropertyNode* windowNode = (cameraNode
? cameraNode->getNode("window")
: 0);
static int cameraNum = 0;
if (!window) {
if (windowNode) {
// New style window declaration / definition
window = wBuild->buildWindow(windowNode);
} else {
return 0;
}
}
Camera* camera = new Camera;
camera->setAllowEventFocus(false);
camera->setGraphicsContext(window->gc.get());
camera->setViewport(new Viewport);
// XXX Camera needs to be drawn last; eventually the render order
// should be assigned by a camera manager.
camera->setRenderOrder(osg::Camera::POST_RENDER, 100);
camera->setClearMask(0);
camera->setInheritanceMask(CullSettings::ALL_VARIABLES
& ~(CullSettings::COMPUTE_NEAR_FAR_MODE
| CullSettings::CULLING_MODE));
camera->setComputeNearFarMode(osg::CullSettings::DO_NOT_COMPUTE_NEAR_FAR);
camera->setCullingMode(osg::CullSettings::NO_CULLING);
camera->setProjectionResizePolicy(Camera::FIXED);
camera->setReferenceFrame(Transform::ABSOLUTE_RF);
const int cameraFlags = GUI;
CameraInfo* result = addCamera(cameraFlags, camera, Matrixd::identity(),
Matrixd::identity(), false);
SGPropertyNode* viewportNode = cameraNode->getNode("viewport", true);
buildViewport(result, viewportNode, window->gc->getTraits());
// Disable statistics for the GUI camera.
result->camera->setStats(0);
updateCameras(result);
return result;
}
CameraGroup* CameraGroup::buildCameraGroup(osgViewer::Viewer* viewer,
SGPropertyNode* gnode)
{
CameraGroup* cgroup = new CameraGroup(viewer);
for (int i = 0; i < gnode->nChildren(); ++i) {
SGPropertyNode* pNode = gnode->getChild(i);
const char* name = pNode->getName();
if (!strcmp(name, "camera")) {
cgroup->buildCamera(pNode);
} else if (!strcmp(name, "window")) {
WindowBuilder::getWindowBuilder()->buildWindow(pNode);
} else if (!strcmp(name, "gui")) {
cgroup->buildGUICamera(pNode);
}
}
bindMemberToNode(gnode, "znear", cgroup, &CameraGroup::_zNear, .4f);
bindMemberToNode(gnode, "zfar", cgroup, &CameraGroup::_zFar, 120000.0f);
bindMemberToNode(gnode, "near-field", cgroup, &CameraGroup::_nearField,
100.0f);
return cgroup;
}
void CameraGroup::setCameraCullMasks(Node::NodeMask nm)
{
for (CameraIterator i = camerasBegin(), e = camerasEnd(); i != e; ++i) {
CameraInfo* info = i->get();
if (info->flags & GUI)
continue;
if (info->farCamera.valid() && info->farCamera->getNodeMask() != 0) {
info->camera->setCullMask(nm & ~simgear::BACKGROUND_BIT);
info->farCamera->setCullMask(nm);
} else {
info->camera->setCullMask(nm);
}
}
}
void CameraGroup::resized()
{
for (CameraIterator i = camerasBegin(), e = camerasEnd(); i != e; ++i) {
CameraInfo *info = i->get();
const Viewport* viewport = info->camera->getViewport();
info->x = viewport->x();
info->y = viewport->y();
info->width = viewport->width();
info->height = viewport->height();
}
}
Camera* getGUICamera(CameraGroup* cgroup)
{
CameraGroup::CameraIterator end = cgroup->camerasEnd();
CameraGroup::CameraIterator result
= std::find_if(cgroup->camerasBegin(), end,
FlagTester<CameraInfo>(CameraGroup::GUI));
if (result != end)
return (*result)->camera.get();
else
return 0;
}
bool computeIntersections(const CameraGroup* cgroup,
const osgGA::GUIEventAdapter* ea,
osgUtil::LineSegmentIntersector::Intersections& intersections)
{
using osgUtil::Intersector;
using osgUtil::LineSegmentIntersector;
double x, y;
eventToWindowCoords(ea, x, y);
// Find camera that contains event
for (CameraGroup::ConstCameraIterator iter = cgroup->camerasBegin(),
e = cgroup->camerasEnd();
iter != e;
++iter) {
const CameraInfo* cinfo = iter->get();
if ((cinfo->flags & CameraGroup::DO_INTERSECTION_TEST) == 0)
continue;
const Camera* camera = cinfo->camera.get();
if (camera->getGraphicsContext() != ea->getGraphicsContext())
continue;
const Viewport* viewport = camera->getViewport();
double epsilon = 0.5;
if (!(x >= viewport->x() - epsilon
&& x < viewport->x() + viewport->width() -1.0 + epsilon
&& y >= viewport->y() - epsilon
&& y < viewport->y() + viewport->height() -1.0 + epsilon))
continue;
Vec4d start(x, y, 0.0, 1.0);
Vec4d end(x, y, 1.0, 1.0);
Matrix windowMat = viewport->computeWindowMatrix();
Matrix startPtMat = Matrix::inverse(camera->getProjectionMatrix()
* windowMat);
Matrix endPtMat;
if (!cinfo->farCamera.valid() || cinfo->farCamera->getNodeMask() == 0)
endPtMat = startPtMat;
else
endPtMat = Matrix::inverse(cinfo->farCamera->getProjectionMatrix()
* windowMat);
start = start * startPtMat;
start /= start.w();
end = end * endPtMat;
end /= end.w();
ref_ptr<LineSegmentIntersector> picker
= new LineSegmentIntersector(Intersector::VIEW,
Vec3d(start.x(), start.y(), start.z()),
Vec3d(end.x(), end.y(), end.z()));
osgUtil::IntersectionVisitor iv(picker.get());
const_cast<Camera*>(camera)->accept(iv);
if (picker->containsIntersections()) {
intersections = picker->getIntersections();
return true;
} else {
break;
}
}
intersections.clear();
return false;
}
void warpGUIPointer(CameraGroup* cgroup, int x, int y)
{
using osgViewer::GraphicsWindow;
Camera* guiCamera = getGUICamera(cgroup);
if (!guiCamera)
return;
Viewport* vport = guiCamera->getViewport();
GraphicsWindow* gw
= dynamic_cast<GraphicsWindow*>(guiCamera->getGraphicsContext());
if (!gw)
return;
globals->get_renderer()->getEventHandler()->setMouseWarped();
// Translate the warp request into the viewport of the GUI camera,
// send the request to the window, then transform the coordinates
// for the Viewer's event queue.
double wx = x + vport->x();
double wyUp = vport->height() + vport->y() - y;
double wy;
const GraphicsContext::Traits* traits = gw->getTraits();
if (gw->getEventQueue()->getCurrentEventState()->getMouseYOrientation()
== osgGA::GUIEventAdapter::Y_INCREASING_DOWNWARDS) {
wy = traits->height - wyUp;
} else {
wy = wyUp;
}
gw->getEventQueue()->mouseWarped(wx, wy);
gw->requestWarpPointer(wx, wy);
osgGA::GUIEventAdapter* eventState
= cgroup->getViewer()->getEventQueue()->getCurrentEventState();
double viewerX
= (eventState->getXmin()
+ ((wx / double(traits->width))
* (eventState->getXmax() - eventState->getXmin())));
double viewerY
= (eventState->getYmin()
+ ((wyUp / double(traits->height))
* (eventState->getYmax() - eventState->getYmin())));
cgroup->getViewer()->getEventQueue()->mouseWarped(viewerX, viewerY);
}
}