OpenSceneGraph/include/osgGA/KeySwitchCameraManipulator

/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2003 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 OSGUTIL_KEYSWITCCAMERAMANIPULATORHER
#define OSGUTIL_KEYSWITCHCAMERAMANIPULATORER 1

#include <osgGA/Export>
#include <osgGA/CameraManipulator>
#include <osgGA/GUIEventHandler>
#include <osgGA/GUIEventHandlerVisitor>

namespace osgGA{

class GUIEventAdapter;
class GUIActionAdapter;

/**
KeySwitchCameraManipulator is a decorator which allows the type of camera manipulator
being used to be switched by pressing a key. E.g. '1' for a TrackballManipultor,
'2' for a DriveManipulator, '3' for a FlightManipulator. The manipulators available,
and the associated switch keys, can be configured.
*/
class OSGGA_EXPORT KeySwitchCameraManipulator : public CameraManipulator
{
public:

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

        /**
        Add a camera manipulator with an associated name, and a key to
        trigger the switch,
        */
        void addCameraManipulator(int key, std::string name, CameraManipulator *cm);

	/**
	Add a camera manipulator with an autogenerated keybinding which is '1' + previous number of camera's registerd.
	*/
        void addNumberedCameraManipulator(CameraManipulator *cm);

        unsigned int getNumCameraManipualtors() const { return _manips.size(); }

        void selectCameraManipulator(unsigned int num);


        CameraManipulator* getCurrentCameraManipulator() { return _current.get(); }

        const CameraManipulator* getCurrentCameraManipulator() const { return _current.get(); }


        CameraManipulator* getCameraManipulator(unsigned int num);

        const CameraManipulator* getCameraManipulator(unsigned int num) const;


        // Overrides from CameraManipulator...


        virtual void setCamera(osg::Camera* c)          { _current->setCamera(c); }

        virtual const osg::Camera * getCamera() const   { return _current->getCamera(); }

        virtual osg::Camera * getCamera()               { return _current->getCamera(); }

        virtual void setNode(osg::Node* n);

        virtual const osg::Node* getNode() const        { return _current->getNode(); }

        virtual osg::Node* getNode()                    { return _current->getNode(); }

        virtual void home(const GUIEventAdapter& ee,GUIActionAdapter& aa) { _current->home(ee,aa); }

        virtual void init(const GUIEventAdapter& ee,GUIActionAdapter& aa) { _current->init(ee,aa); }

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

        /** Get the keyboard and mouse usage of this manipulator.*/
        virtual void getUsage(osg::ApplicationUsage& usage) const;

private:

        typedef std::pair<std::string, osg::ref_ptr<CameraManipulator> > NamedManipulator;
        typedef std::map<int, NamedManipulator> KeyManipMap;
        KeyManipMap _manips;

        osg::ref_ptr<CameraManipulator> _current;
};

};

#endif