core/fwData/include/fwData/Mesh.hpp

/* ***** BEGIN LICENSE BLOCK *****
 * FW4SPL - Copyright (C) IRCAD, 2009-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_MESH_HPP__
#define __FWDATA_MESH_HPP__

#include "fwData/Array.hpp"
#include "fwData/config.hpp"
#include "fwData/Exception.hpp"
#include "fwData/factory/new.hpp"

#include <fwCore/macros.hpp>

#include <boost/multi_array.hpp>

fwCampAutoDeclareDataMacro((fwData)(Mesh), FWDATA_API);

namespace fwData
{

class FWDATA_CLASS_API Mesh : public ::fwData::Object
{

public:

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

    fwCampMakeFriendDataMacro((fwData)(Mesh));

    typedef std::map< std::string, ::fwData::Array::sptr > ArrayMapType;
    typedef std::uint64_t Id;

    typedef enum
    {
        NO_CELL = 0,
        POINT,
        EDGE,
        TRIANGLE,
        QUAD,
        POLY,
        TETRA
    } CellTypesEnum;

    typedef enum
    {
        RGB  = 3,
        RGBA = 4
    } ColorArrayTypes;

    typedef float PointValueType;
    typedef std::uint8_t ColorValueType;
    typedef float NormalValueType;
    typedef float TexCoordValueType;
    typedef Id CellValueType;
    typedef Id CellDataOffsetType;
    typedef std::uint8_t CellTypes;

    typedef boost::multi_array_ref<PointValueType, 2> PointsMultiArrayType;
    typedef boost::multi_array_ref<CellTypes, 1> CellTypesMultiArrayType;
    typedef boost::multi_array_ref<CellValueType, 1> CellDataMultiArrayType;
    typedef boost::multi_array_ref<CellDataOffsetType, 1> CellDataOffsetsMultiArrayType;
    typedef boost::multi_array_ref<ColorValueType, 2> PointColorsMultiArrayType;
    typedef boost::multi_array_ref<ColorValueType, 2> CellColorsMultiArrayType;
    typedef boost::multi_array_ref<NormalValueType, 2> PointNormalsMultiArrayType;
    typedef boost::multi_array_ref<NormalValueType, 2> CellNormalsMultiArrayType;
    typedef boost::multi_array_ref<TexCoordValueType, 2> PointTexCoordsMultiArrayType;
    typedef boost::multi_array_ref<TexCoordValueType, 2> CellTexCoordsMultiArrayType;

    typedef boost::const_multi_array_ref<PointValueType, 2> ConstPointsMultiArrayType;
    typedef boost::const_multi_array_ref<CellTypes, 1> ConstCellTypesMultiArrayType;
    typedef boost::const_multi_array_ref<CellValueType, 1> ConstCellDataMultiArrayType;
    typedef boost::const_multi_array_ref<CellDataOffsetType, 1> ConstCellDataOffsetsMultiArrayType;
    typedef boost::const_multi_array_ref<ColorValueType, 2> ConstPointColorsMultiArrayType;
    typedef boost::const_multi_array_ref<ColorValueType, 2> ConstCellColorsMultiArrayType;
    typedef boost::const_multi_array_ref<NormalValueType, 2> ConstPointNormalsMultiArrayType;
    typedef boost::const_multi_array_ref<NormalValueType, 2> ConstCellNormalsMultiArrayType;
    typedef boost::const_multi_array_ref<TexCoordValueType, 2> ConstPointTexCoordsMultiArrayType;
    typedef boost::const_multi_array_ref<TexCoordValueType, 2> ConstCellTexCoordsMultiArrayType;

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

    FWDATA_API virtual ~Mesh();

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

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

    FWDATA_API size_t allocate(size_t nbPts, size_t nbCells, size_t nbCellsData = 0);

    FWDATA_API size_t allocatePointNormals();

    FWDATA_API size_t allocatePointColors(ColorArrayTypes t);

    FWDATA_API size_t allocatePointTexCoords();

    FWDATA_API size_t allocateCellNormals();

    FWDATA_API size_t allocateCellColors(ColorArrayTypes t);

    FWDATA_API size_t allocateCellTexCoords();

    FWDATA_API bool adjustAllocatedMemory();

    FWDATA_API void setPointsArray           (const ::fwData::Array::sptr& array);
    FWDATA_API void setCellTypesArray        (const ::fwData::Array::sptr& array);
    FWDATA_API void setCellDataArray         (const ::fwData::Array::sptr& array);
    FWDATA_API void setCellDataOffsetsArray  (const ::fwData::Array::sptr& array);
    FWDATA_API void setPointColorsArray      (const ::fwData::Array::sptr& array);
    FWDATA_API void setCellColorsArray       (const ::fwData::Array::sptr& array);
    FWDATA_API void setPointNormalsArray     (const ::fwData::Array::sptr& array);
    FWDATA_API void setCellNormalsArray      (const ::fwData::Array::sptr& array);
    FWDATA_API void setPointTexCoordsArray   (const ::fwData::Array::sptr& array);
    FWDATA_API void setCellTexCoordsArray    (const ::fwData::Array::sptr& array);

    FWDATA_API ::fwData::Array::sptr getPointsArray           () const;
    FWDATA_API ::fwData::Array::sptr getCellTypesArray        () const;
    FWDATA_API ::fwData::Array::sptr getCellDataArray         () const;
    FWDATA_API ::fwData::Array::sptr getCellDataOffsetsArray  () const;
    FWDATA_API ::fwData::Array::sptr getPointColorsArray      () const;
    FWDATA_API ::fwData::Array::sptr getCellColorsArray       () const;
    FWDATA_API ::fwData::Array::sptr getPointNormalsArray     () const;
    FWDATA_API ::fwData::Array::sptr getCellNormalsArray      () const;
    FWDATA_API ::fwData::Array::sptr getPointTexCoordsArray   () const;
    FWDATA_API ::fwData::Array::sptr getCellTexCoordsArray    () const;

    FWDATA_API void clearPoints();

    FWDATA_API void clearCells();

    FWDATA_API void clear();

    FWDATA_API void clearPointNormals();
    FWDATA_API void clearPointColors();
    FWDATA_API void clearPointTexCoords();
    FWDATA_API void clearCellNormals();
    FWDATA_API void clearCellColors();
    FWDATA_API void clearCellTexCoords();

    FWDATA_API void setNumberOfPoints(Id nb);

    FWDATA_API Id getNumberOfPoints() const;

    FWDATA_API void setNumberOfCells(Id nb);

    FWDATA_API Id getNumberOfCells() const;

    FWDATA_API void setCellDataSize(Id nb);

    FWDATA_API Id getCellDataSize() const;

    FWDATA_API size_t getDataSizeInBytes() const;

    FWDATA_API size_t getAllocatedSizeInBytes() const;

    FWDATA_API void addDataArray(const std::string& name, ::fwData::Array::sptr array);

    FWDATA_API ::fwData::Array::sptr getDataArray(const std::string& name) const;

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

    FWDATA_API std::vector<std::string> getDataArrayNames() const;

    /***
     * @name Signals
     * @{
     */

    typedef ::fwCom::Signal< void () > VertexModifiedSignalType;

    FWDATA_API static const ::fwCom::Signals::SignalKeyType s_VERTEX_MODIFIED_SIG;

    typedef ::fwCom::Signal< void () > PointColorsModifiedSignalType;

    FWDATA_API static const ::fwCom::Signals::SignalKeyType s_POINT_COLORS_MODIFIED_SIG;

    typedef ::fwCom::Signal< void () > CellColorsModifiedSignalType;

    FWDATA_API static const ::fwCom::Signals::SignalKeyType s_CELL_COLORS_MODIFIED_SIG;

    typedef ::fwCom::Signal< void () > PointNormalsModifiedSignalType;

    FWDATA_API static const ::fwCom::Signals::SignalKeyType s_POINT_NORMALS_MODIFIED_SIG;

    typedef ::fwCom::Signal< void () > CellNormalsModifiedSignalType;

    FWDATA_API static const ::fwCom::Signals::SignalKeyType s_CELL_NORMALS_MODIFIED_SIG;

    typedef ::fwCom::Signal< void () > PointTexCoordsModifiedSignalType;

    FWDATA_API static const ::fwCom::Signals::SignalKeyType s_POINT_TEX_COORDS_MODIFIED_SIG;

    typedef ::fwCom::Signal< void () > CellTexCoordsModifiedSignalType;

    FWDATA_API static const ::fwCom::Signals::SignalKeyType s_CELL_TEX_COORDS_MODIFIED_SIG;

protected:

    FWDATA_API void initArrays();

    Id m_nbPoints;

    Id m_nbCells;

    Id m_cellsDataSize;

    ::fwData::Array::sptr m_points;

    ::fwData::Array::sptr m_cellTypes;

    ::fwData::Array::sptr m_cellData;

    ::fwData::Array::sptr m_cellDataOffsets;

    ::fwData::Array::sptr m_pointColors;

    ::fwData::Array::sptr m_cellColors;

    ::fwData::Array::sptr m_pointNormals;

    ::fwData::Array::sptr m_cellNormals;

    ::fwData::Array::sptr m_pointTexCoords;

    ::fwData::Array::sptr m_cellTexCoords;

    // analysis.
    ArrayMapType m_arrayMap;
};

} // namespace fwData

#endif // __FWDATA_MESH_HPP__