SphericalManipulator.h

Go to the documentation of this file.

/* -*-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
 * (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
 * OpenSceneGraph Public License for more details.
*/

#ifndef __SphericalManipulator_h__
#define __SphericalManipulator_h__

#include <osgGA/CameraManipulator>
#include <osg/Math>
#include <osg/Quat>

namespace osgGA
{

class OSGGA_EXPORT SphericalManipulator : public CameraManipulator
{
    public:
        SphericalManipulator();

        virtual const char* className() const { return "Spherical Manipulator"; }

        virtual void setByMatrix(const osg::Matrixd& matrix);

        virtual void setByInverseMatrix(const osg::Matrixd& matrix) { setByMatrix(osg::Matrixd::inverse(matrix)); }

        virtual osg::Matrixd getMatrix() const;

        virtual osg::Matrixd getInverseMatrix() const;

        virtual osgUtil::SceneView::FusionDistanceMode getFusionDistanceMode() const { return osgUtil::SceneView::USE_FUSION_DISTANCE_VALUE; }

        virtual float getFusionDistanceValue() const { return _distance; }

        virtual void setNode(osg::Node*);

        virtual const osg::Node* getNode() const;

        virtual osg::Node* getNode();

        virtual void home(const osgGA::GUIEventAdapter& ea,osgGA::GUIActionAdapter& us);
        virtual void home(double);

        virtual void init(const osgGA::GUIEventAdapter& ea,osgGA::GUIActionAdapter& us);

        void zoomOn(const osg::BoundingSphere& bound);

        virtual bool handle(const osgGA::GUIEventAdapter& ea,osgGA::GUIActionAdapter& us);

        virtual void computeHomePosition();

        void computeViewPosition(const osg::BoundingSphere& bound,double& scale,double& distance,osg::Vec3d& center);

        void setCenter(const osg::Vec3d& center) {_center=center;}
        const osg::Vec3d& getCenter() const {return _center;}

        bool setDistance(double distance);
        double getDistance() const { return _distance; }

        double getHomeDistance() const { return _homeDistance; }

        void setHeading(double azimuth) { _heading = azimuth; }
        double getHeading() const {return _heading;}

        void setElevation(double elevation) { _elevation = elevation; }
        double getElevtion() const {return _elevation;}


        double getMinimumZoomScale() const { return _minimumZoomScale; }

        void setMinimumZoomScale(double minimumZoomScale) {_minimumZoomScale=minimumZoomScale;}


        void setScroolWheelZoomDelta(double zoomDelta) { _zoomDelta = zoomDelta; }

        double getScroolWheelZoomDelta() const { return _zoomDelta; }


        virtual void getUsage(osg::ApplicationUsage& usage) const;

        enum RotationMode
        {
                ELEVATION_HEADING=0,
                HEADING,
                ELEVATION,
                MAP
        };

        RotationMode getRotationMode() const {return _rotationMode;}
        void setRotationMode(RotationMode mode);

        bool getAllowThrow() const { return _allowThrow; }
        void setAllowThrow(bool allowThrow) { _allowThrow = allowThrow; }

    protected:

        virtual ~SphericalManipulator();

        void flushMouseEventStack();
        void addMouseEvent(const osgGA::GUIEventAdapter& ea);

        bool calcMovement();

        bool isMouseMoving();

        // Internal event stack comprising last two mouse events.
        osg::ref_ptr<const osgGA::GUIEventAdapter> _ga_t1;
        osg::ref_ptr<const osgGA::GUIEventAdapter> _ga_t0;

        osg::observer_ptr<osg::Node>       _node;

        double _modelScale;
        double _minimumZoomScale;

        bool _thrown;
        bool _allowThrow;

        double _delta_frame_time;

        double _last_frame_time;

        RotationMode    _rotationMode;
        osg::Vec3d      _center;
        double          _distance;
        double          _heading;  // angle from x axis in xy plane
        double          _elevation;   // angle from xy plane, positive upwards towards the z axis
        double          _homeDistance;
        double          _zoomDelta;
};
}
#endif