From c6a1b7e97f13ad1e13cdba2ebe8009f4c2208cdf Mon Sep 17 00:00:00 2001 From: Robert Osfield Date: Thu, 16 Sep 2010 09:49:22 +0000 Subject: [PATCH] From Magnus Kessler, "I'm resubmitting a slightly different version of the changes you left out for osg/Camera. The ::glName issue masked the fact that the "(..)" isn't handled well in doxygen and leads to "(." in the generated files. I'm also submitting a minor documentation fix to osgGA/DriveManipulator to get it out of my patch queue ;)" --- include/osg/Camera | 8 ++++---- include/osgGA/DriveManipulator | 27 ++++++++++++++------------- 2 files changed, 18 insertions(+), 17 deletions(-) diff --git a/include/osg/Camera b/include/osg/Camera index 09fe0d2a2..631a1783f 100644 --- a/include/osg/Camera +++ b/include/osg/Camera @@ -85,28 +85,28 @@ class OSG_EXPORT Camera : public Transform, public CullSettings const osg::DisplaySettings* getDisplaySettings() const { return _displaySettings.get(); } - /** Set the clear mask used in glClear(..). + /** Set the clear mask used in glClear(). * Defaults to GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT. */ inline void setClearMask(GLbitfield mask) { _clearMask = mask; applyMaskAction(CLEAR_MASK); } /** Get the clear mask.*/ inline GLbitfield getClearMask() const { return _clearMask; } - /** Set the clear color used in glClearColor(..). + /** Set the clear color used in glClearColor(). * glClearColor is only called if mask & GL_COLOR_BUFFER_BIT is true*/ void setClearColor(const osg::Vec4& color) { _clearColor=color; applyMaskAction(CLEAR_COLOR); } /** Get the clear color.*/ const osg::Vec4& getClearColor() const { return _clearColor; } - /** Set the clear accum used in glClearAccum(..). + /** Set the clear accum used in glClearAccum(). * glClearAcumm is only called if mask & GL_ACCUM_BUFFER_BIT is true. */ void setClearAccum(const osg::Vec4& color) { _clearAccum=color; } /** Get the clear accum value.*/ const osg::Vec4& getClearAccum() const { return _clearAccum; } - /** Set the clear depth used in glClearDepth(..). Defaults to 1.0 + /** Set the clear depth used in glClearDepth(). Defaults to 1.0 * glClearDepth is only called if mask & GL_DEPTH_BUFFER_BIT is true. */ void setClearDepth(double depth) { _clearDepth=depth; } diff --git a/include/osgGA/DriveManipulator b/include/osgGA/DriveManipulator index abbb438c1..d645fa06c 100644 --- a/include/osgGA/DriveManipulator +++ b/include/osgGA/DriveManipulator @@ -1,18 +1,18 @@ -/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield +/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield * - * This library is open source and may be redistributed and/or modified under - * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or + * This library is open source and may be redistributed and/or modified under + * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or * (at your option) any later version. The full license is in LICENSE file * included with this distribution, and on the openscenegraph.org website. - * + * * This library 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 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * OpenSceneGraph Public License for more details. */ #ifndef OSGGA_DRIVEMANIPULATOR -#define OSGGA_DRIVEMANIPULATOR 1 +#define OSGGA_DRIVEMANIPULATOR 1 #include #include @@ -34,16 +34,16 @@ class OSGGA_EXPORT DriveManipulator : public CameraManipulator virtual const char* className() const { return "Drive"; } - /** set the position of the matrix manipulator using a 4x4 Matrix.*/ + /** Get the position of the matrix manipulator using a 4x4 Matrix.*/ virtual void setByMatrix(const osg::Matrixd& matrix); - /** set the position of the matrix manipulator using a 4x4 Matrix.*/ + /** Set the position of the matrix manipulator using a 4x4 Matrix.*/ virtual void setByInverseMatrix(const osg::Matrixd& matrix) { setByMatrix(osg::Matrixd::inverse(matrix)); } - /** get the position of the manipulator as 4x4 Matrix.*/ + /** Get the position of the manipulator as 4x4 Matrix.*/ virtual osg::Matrixd getMatrix() const; - /** get the position of the manipulator as a inverse matrix of the manipulator, typically used as a model view matrix.*/ + /** Get the position of the manipulator as a inverse matrix of the manipulator, typically used as a model view matrix.*/ virtual osg::Matrixd getInverseMatrix() const; virtual void setNode(osg::Node*); @@ -86,8 +86,9 @@ class OSGGA_EXPORT DriveManipulator : public CameraManipulator void computePosition(const osg::Vec3d& eye,const osg::Vec3d& lv,const osg::Vec3d& up); - /** For the give mouse movement calculate the movement of the camera. - Return true is camera has moved and a redraw is required.*/ + /** For the given mouse movement calculate the movement of the camera. + * Return true if camera has moved and a redraw is required. + */ bool calcMovement(); // Internal event stack comprising last two mouse events. @@ -112,7 +113,7 @@ class OSGGA_EXPORT DriveManipulator : public CameraManipulator osg::Quat _rotation; double _pitch; double _distance; - + bool _pitchUpKeyPressed; bool _pitchDownKeyPressed; };