Visualization3DContainer.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_VISUALIZATION3DCONTAINER_H_
#define _MIRA_VISUALIZATION3DCONTAINER_H_

#include <list>

#include <widgets/OgreWidgetEx.h>

#include <visualization/Visualization3D.h>
#include <visualization/VisualizationTool3D.h>

namespace mira {

class PropertyEditor;


class MIRA_GUI_VISUALIZATION_EXPORT Visualization3DContainer : public OgreWidgetEx, public IVisualization3DSite
{
public:
    Visualization3DContainer(QWidget* parent=NULL, bool enableOrbitTool = true);
    virtual ~Visualization3DContainer();

public:

    Visualization3D* addVisualization(const std::string& visualizationClassName);

    void addVisualization(Visualization3D* vis);

    std::string getPropertyString(Visualization3D* vis, const std::string& property);

    template <typename T>
    T getProperty(Visualization3D* vis, const std::string& property) {
        return fromString<T>(getPropertyString(vis,property));
    }

    void setPropertyString(Visualization3D* vis, const std::string& property, const std::string& value);

    template <typename T>
    void setProperty(Visualization3D* vis, const std::string& property, const T& value) {
        setPropertyString(vis,property,toString<T>(value));
    }

    PropertyEditor* getPropertyEditor(QWidget* parent = NULL);

public:
    // implementation of IVisualization3DSite
    virtual Ogre::SceneManager* getSceneManager();

    virtual void registerInteractionListener(InteractionListener3D* listener);
    virtual void removeInteractionListener(InteractionListener3D* listener);
    virtual std::set<InteractionListener3D*> getInteractionListeners();

    virtual const Camera& getCamera() const;

    virtual void setCamera(const Camera& camera);

    virtual Ogre::Camera* acquireCamera(boost::function<void()> lostCameraCallback = boost::function<void()>());

    virtual void releaseCamera();

    virtual const std::string& getFixedFrame() const;
    virtual const std::string& getCameraFrame() const;

    void setFixedFrame(const std::string& frame);
    void setCameraFrame(const std::string& frame);

public:

    virtual void mousePressEvent(QMouseEvent* e);
    virtual void mouseReleaseEvent(QMouseEvent* e);
    virtual void mouseMoveEvent(QMouseEvent* e);
    virtual void wheelEvent(QWheelEvent* e);

    virtual void timerEvent(QTimerEvent* e);

protected:

    virtual void initOgre();

private:

    void setupVisualizations(bool enableOrbitTool = true);

private:

    mutable Camera mCameraSettings;

    bool mCameraAcquired;
    boost::function<void()> mLostCameraCallback;

    bool mEnableOrbitTool;
    boost::shared_ptr<VisualizationTool3D> mActiveTool;

    Time mLastUpdateTime;

    boost::shared_ptr<PropertyNode> mGeneralProperties;
    std::map<Visualization3D*, boost::shared_ptr<PropertyNode>> mVisualizations;

    PropertyEditor* mEditor;

    std::string mFixedFrame;
    std::string mCameraFrame;

    boost::mutex mListenerMutex;
    std::set<InteractionListener3D*> mListeners;
};


} // namespace

#endif