VisualizationTool3D.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_VISUALIZATIONTOOL3D_H_
#define _MIRA_VISUALIZATIONTOOL3D_H_

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

#include <OGRE/OgreVector3.h>

namespace Ogre {
    class SceneNode;
}

namespace mira {


class MIRA_GUI_VISUALIZATION_EXPORT VisualizationTool3D : public VisualizationTool
{
    MIRA_ABSTRACT_OBJECT(VisualizationTool3D)

public:
    // force alignment, since we contain a rigid transform, that contains eigen
    // matrices, ...
    EIGEN_MAKE_ALIGNED_OPERATOR_NEW

    VisualizationTool3D();
    virtual ~VisualizationTool3D();

public:

    template <typename Reflector>
    void reflect(Reflector& r)
    {
        MIRA_REFLECT_BASE(r, VisualizationTool);
    }

public:

    virtual void init(IVisualizationSite* site);

    virtual IVisualization3DSite* getSite();

public:

    virtual void activate();

    virtual void deactivate();

protected:

    virtual void update(Duration dt);

    virtual void setupScene(IVisualization3DSite* site) {};

    Ogre::Vector3 transformVector(const Ogre::Vector3& v);

protected:

    Ogre::SceneNode* mNode;
    RigidTransform3f mTransform;

private:

    IVisualization3DSite* mSite;
};


}

#endif