fwData/include/fwData/Landmarks.hpp

/* ***** BEGIN LICENSE BLOCK *****
 * FW4SPL - Copyright (C) IRCAD, 2017.
 * Distributed under the terms of the GNU Lesser General Public License (LGPL) as
 * published by the Free Software Foundation.
 * ****** END LICENSE BLOCK ****** */

#ifndef __FWDATA_LANDMARKS_HPP__
#define __FWDATA_LANDMARKS_HPP__

#include "fwData/config.hpp"
#include "fwData/factory/new.hpp"
#include "fwData/Object.hpp"

#include <array>
#include <map>
#include <vector>

fwCampAutoDeclareDataMacro((fwData)(Landmarks), FWDATA_API);

namespace fwData
{
class FWDATA_CLASS_API Landmarks : public Object
{

public:

    typedef std::array< float, 4 > ColorType;
    typedef std::array< double, 3 > PointType;
    typedef float SizeType;
    typedef std::vector< PointType > PointContainer;
    typedef std::vector< std::string > GroupNameContainer;

    enum class Shape
    {
        SPHERE,
        CUBE
    };

    struct LandmarksGroup
    {
        LandmarksGroup(ColorType color, SizeType size, Shape shape, bool visibility) :
            m_color(color),
            m_size(size),
            m_shape(shape),
            m_visibility(visibility)
        {
        }

        ColorType m_color;
        SizeType m_size;
        Shape m_shape;
        bool m_visibility;
        PointContainer m_points;
    };

    fwCoreClassDefinitionsWithFactoryMacro( (Landmarks)(::fwData::Object), (()), ::fwData::factory::New< Landmarks > );

    fwCampMakeFriendDataMacro((fwData)(Landmarks));

    FWDATA_API Landmarks(::fwData::Object::Key key);

    FWDATA_API virtual ~Landmarks();

    FWDATA_API void shallowCopy( const Object::csptr& _source ) override;

    FWDATA_API void cachedDeepCopy(const Object::csptr& _source, DeepCopyCacheType& cache) override;

    FWDATA_API void addGroup(const std::string& name, const ColorType& color = {{1.0f, 1.0f, 1.0f, 1.0f}},
                             const SizeType size = 1.0f, const Shape shape = Shape::SPHERE,
                             const bool visibility = true);

    FWDATA_API const GroupNameContainer getGroupNames() const;

    FWDATA_API const LandmarksGroup& getGroup(const std::string& name) const;

    FWDATA_API LandmarksGroup& getGroup(const std::string& name);

    FWDATA_API void renameGroup(const std::string& oldName, const std::string& newName);

    FWDATA_API void removeGroup(const std::string& name);

    FWDATA_API void setGroupColor(const std::string& name, const ColorType& color);

    FWDATA_API void setGroupSize(const std::string& name, const SizeType size);

    FWDATA_API void setGroupShape(const std::string& name, const Shape shape);

    FWDATA_API void setGroupVisibility(const std::string& name, const bool visibility);

    FWDATA_API void addPoint(const std::string& name, const PointType& point);

    FWDATA_API void insertPoint(const std::string& name, const size_t index, const PointType& point);

    FWDATA_API const PointType& getPoint(const std::string& name, size_t index) const;

    FWDATA_API PointType& getPoint(const std::string& name, size_t index);

    FWDATA_API const PointContainer& getPoints(const std::string& name) const;

    FWDATA_API void removePoint(const std::string& name, size_t index);

    FWDATA_API void clearPoints(const std::string& name);

    size_t getNumberOfGroups() const;

    FWDATA_API size_t getNumberOfPoints() const;

    FWDATA_API size_t getNumberOfPoints(const std::string& name) const;

    typedef ::fwCom::Signal< void (std::string name) > GroupAddedSignalType;
    FWDATA_API static const ::fwCom::Signals::SignalKeyType s_GROUP_ADDED_SIG;

    typedef ::fwCom::Signal< void (std::string name) > GroupRemovedSignalType;
    FWDATA_API static const ::fwCom::Signals::SignalKeyType s_GROUP_REMOVED_SIG;

    typedef ::fwCom::Signal< void (std::string name) > PointAddedSignalType;
    FWDATA_API static const ::fwCom::Signals::SignalKeyType s_POINT_ADDED_SIG;

    typedef ::fwCom::Signal< void (std::string name, size_t index) > PointRemovedSignalType;
    FWDATA_API static const ::fwCom::Signals::SignalKeyType s_POINT_REMOVED_SIG;

    typedef ::fwCom::Signal< void (std::string name, size_t index) > PointInsertedSignalType;
    FWDATA_API static const ::fwCom::Signals::SignalKeyType s_POINT_INSERTED_SIG;

    typedef ::fwCom::Signal< void (std::string name, size_t index) > PointModifiedSigType;
    FWDATA_API static const ::fwCom::Signals::SignalKeyType s_POINT_MODIFIED_SIG;

    typedef ::fwCom::Signal< void (std::string name) > GroupModifiedSignalType;
    FWDATA_API static const ::fwCom::Signals::SignalKeyType s_GROUP_MODIFIED_SIG;

    typedef ::fwCom::Signal< void (std::string oldName, std::string newName) > GroupRenamedSignalType;
    FWDATA_API static const ::fwCom::Signals::SignalKeyType s_GROUP_RENAMED_SIG;

    typedef ::fwCom::Signal< void (std::string name, size_t index) > PointSelectedSignalType;
    FWDATA_API static const ::fwCom::Signals::SignalKeyType s_POINT_SELECTED_SIG;

    typedef ::fwCom::Signal< void (std::string name, size_t index) > PointDeselectedSignalType;
    FWDATA_API static const ::fwCom::Signals::SignalKeyType s_POINT_DESELECTED_SIG;

private:

    typedef std::map< std::string, LandmarksGroup > LandmarksContainer;
    LandmarksContainer m_landmarks;
}; // end class Landmarks

//------------------------------------------------------------------------------

inline size_t Landmarks::getNumberOfGroups() const
{
    return m_landmarks.size();
}

} // end namespace fwData

#endif // __FWDATA_LANDMARKS_HPP__