Marker.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_MARKER_H_
#define _MIRA_MARKER_H_

#include <image/Color.h>
#include <transform/Pose.h>
#include <geometry/Line.h>
#include <geometry/Point.h>
#include <geometry/Size.h>
#include <geometry/Polygon.h>

#include <model/RigidModelExports.h>

namespace mira { namespace model {


class MIRA_RIGID_MODEL_EXPORT MarkerBase : public Object
{
    MIRA_OBJECT(MarkerBase)
public:

    EIGEN_MAKE_ALIGNED_OPERATOR_NEW

    MarkerBase() :
        color(Color::White),
        scale(1.0f, 1.0f, 1.0f) {}

    MarkerBase(const Pose3& pos, const Color::RGBA& col=Color::White, const Size3f& s=Size3f(1.0f,1.0f,1.0f)) :
        position(pos),
        color(col),
        scale(s) {}

    template<typename Reflector>
    void reflect(Reflector& r)
    {
        r.member("Position", position, "");
        r.member("Color", color, "");
        r.member("Scale", scale, "");
    }

    Pose3 position;
    Color::RGBA color;
    Size3f scale;
};

typedef boost::shared_ptr<MarkerBase> MarkerBasePtr;


class MIRA_RIGID_MODEL_EXPORT BoxMarker : public MarkerBase
{
    MIRA_OBJECT(BoxMarker)
public:
    BoxMarker() : MarkerBase() {}
    BoxMarker(const Pose3& position, const Color::RGBA& color=Color::White, const Size3f& scale=Size3f(1.0f,1.0f,1.0f)) :
        MarkerBase(position, color, scale) {}
};

typedef boost::shared_ptr<BoxMarker> BoxMarkerPtr;


class MIRA_RIGID_MODEL_EXPORT SphereMarker : public MarkerBase
{
    MIRA_OBJECT(SphereMarker)
public:
    SphereMarker() : MarkerBase() {}
    SphereMarker(const Pose3& position, const Color::RGBA& color=Color::White, const Size3f& scale=Size3f(1.0f,1.0f,1.0f)) :
        MarkerBase(position, color, scale) {}
};

typedef boost::shared_ptr<SphereMarker> SphereMarkerPtr;


class MIRA_RIGID_MODEL_EXPORT CylinderMarker : public MarkerBase
{
    MIRA_OBJECT(CylinderMarker)
public:
    CylinderMarker() : MarkerBase() {}
    CylinderMarker(const Pose3& position, const Color::RGBA& color=Color::White, const Size3f& scale=Size3f(1.0f,1.0f,1.0f)) :
        MarkerBase(position, color, scale) {}
};

typedef boost::shared_ptr<CylinderMarker> CylinderMarkerPtr;


class MIRA_RIGID_MODEL_EXPORT ConeMarker : public MarkerBase
{
    MIRA_OBJECT(ConeMarker)
public:
    ConeMarker() : MarkerBase() {}
    ConeMarker(const Pose3& position, const Color::RGBA& color=Color::White, const Size3f& scale=Size3f(1.0f,1.0f,1.0f)) :
        MarkerBase(position, color, scale) {}
};

typedef boost::shared_ptr<ConeMarker> ConeMarkerPtr;


class MIRA_RIGID_MODEL_EXPORT TextMarker : public MarkerBase
{
    MIRA_OBJECT(TextMarker)
public:
    TextMarker() : MarkerBase() {}
    TextMarker(const std::string& str, const Pose3& position, const Color::RGBA& color=Color::White, const Size3f& scale=Size3f(1.0f,1.0f,1.0f)) :
        MarkerBase(position, color, scale), text(str) {}

    template<typename Reflector>
    void reflect(Reflector& r)
    {
        MIRA_REFLECT_BASE(r, MarkerBase);
        r.member("Text", text, "");
    }
    std::string text;
};

typedef boost::shared_ptr<TextMarker> TextMarkerPtr;


class MIRA_RIGID_MODEL_EXPORT ArrowMarker : public MarkerBase
{
    MIRA_OBJECT(ArrowMarker)
};

typedef boost::shared_ptr<ArrowMarker> ArrowMarkerPtr;

class MIRA_RIGID_MODEL_EXPORT PointedArrowMarker : public MarkerBase
{
    MIRA_OBJECT(PointedArrowMarker)
public:

    EIGEN_MAKE_ALIGNED_OPERATOR_NEW

    template<typename Reflector>
    void reflect(Reflector& r)
    {
        MIRA_REFLECT_BASE(r, MarkerBase);
        r.member("Start", start, "");
        r.member("End", end, "");
    }

    Point3f start;
    Point3f end;
};

typedef boost::shared_ptr<PointedArrowMarker> PointedArrowMarkerPtr;


class MIRA_RIGID_MODEL_EXPORT AxesMarker : public MarkerBase
{
    MIRA_OBJECT(AxesMarker)
public:
    AxesMarker() : MarkerBase(), applyColor(false) {}

    template<typename Reflector>
    void reflect(Reflector& r)
    {
        MIRA_REFLECT_BASE(r, MarkerBase);
        r.member("ApplyColor", applyColor, "");
    }

    bool applyColor;
};

typedef boost::shared_ptr<AxesMarker> AxesMarkerPtr;


class MIRA_RIGID_MODEL_EXPORT PolygonMarker : public MarkerBase
{
    MIRA_OBJECT(PolygonMarker)
public:
    template<typename Reflector>
    void reflect(Reflector& r)
    {
        MIRA_REFLECT_BASE(r, MarkerBase);
        r.member("Polygon", polygon, "");
    }

    Polygon3f polygon;
};

typedef boost::shared_ptr<PolygonMarker> PolygonMarkerPtr;


class MIRA_RIGID_MODEL_EXPORT LineListMarker : public MarkerBase
{
    MIRA_OBJECT(LineListMarker)
public:
    LineListMarker() : lineWidth(0.01f) {}

    template<typename Reflector>
    void reflect(Reflector& r)
    {
        MIRA_REFLECT_BASE(r, MarkerBase);
        r.member("LineWidth", lineWidth, "", 0.01f);
        r.member("Lines", lines, "");
    }
    float lineWidth;
    std::vector<Line3f> lines;
};

typedef boost::shared_ptr<LineListMarker> LineListMarkerPtr;


class MIRA_RIGID_MODEL_EXPORT LineStripMarker : public MarkerBase
{
    MIRA_OBJECT(LineStripMarker)
public:
    LineStripMarker() : lineWidth(0.01f) {}

    template<typename Reflector>
    void reflect(Reflector& r)
    {
        MIRA_REFLECT_BASE(r, MarkerBase);
        r.member("LineWidth", lineWidth, "", 0.01f);
        r.member("Points", points, "");
    }
    float lineWidth;
    std::vector<Point3f> points;
};

typedef boost::shared_ptr<LineStripMarker> LineStripMarkerPtr;

class MIRA_RIGID_MODEL_EXPORT MeshMarker : public MarkerBase
{
    MIRA_OBJECT(MeshMarker)
public:
    MeshMarker() : forceReloadResources(false) {}
    MeshMarker(const std::string& file, bool forceReload = false)
        : meshFile(file), forceReloadResources(false) {}

    template<typename Reflector>
    void reflect(Reflector& r)
    {
        MIRA_REFLECT_BASE(r, MarkerBase);
        r.member("MeshFile", meshFile, "");
        r.member("ForceReloadDir", forceReloadResources, "");
    }

    std::string meshFile;
    bool forceReloadResources;
};

typedef boost::shared_ptr<MeshMarker> MeshMarkerPtr;

struct Marker
{
    enum Command
    {
        CREATE_MODIFY = 0, 
        REMOVE = 1         
    };
    Marker() :
        id(0),
        ns(""),
        command(CREATE_MODIFY) {}

    template<typename Reflector>
    void reflect(Reflector& r)
    {
        r.member("ID", id, "");
        r.member("Namespace", ns, "");
        r.member("Command", command, "");
        r.member("Objects", objects, "");
    }
    uint32 id;
    std::string ns;
    Command command;
    std::vector<MarkerBasePtr> objects;
};


}} // namespace

#endif