WMWriteMesh.h

//---------------------------------------------------------------------------
//
// Project: OpenWalnut ( http://www.openwalnut.org )
//
// Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
// For more information see http://www.openwalnut.org/copying
//
// This file is part of OpenWalnut.
//
// OpenWalnut is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// OpenWalnut is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
//
//---------------------------------------------------------------------------
 
#ifndef WMWRITEMESH_H
#define WMWRITEMESH_H
 
#include <memory>
#include <string>
#include <vector>
 
#include <osg/Geode>
 
#include "core/graphicsEngine/WTriangleMesh.h"
#include "core/kernel/WModule.h"
#include "core/kernel/WModuleInputData.h"
#include "core/kernel/WModuleOutputData.h"
 
/**
 * This module writes the triangle mesh given at its input connector
 * as a VTK ASCII file or .json file or STL file
 *
 * \ingroup modules
 */
class WMWriteMesh: public WModule
{
/**
 * Only UnitTests may be friends.
 */
friend class WMWriteMeshTest;
 
public:
    /**
     *
     */
    WMWriteMesh();
 
    /**
     *
     */
    virtual ~WMWriteMesh();
 
    /**
     * Gives back the name of this module.
     * \return the module's name.
     */
    virtual const std::string getName() const;
 
    /**
     * Gives back a description of this module.
     * \return description to module.
     */
    virtual const std::string getDescription() const;
 
    /**
     * Due to the prototype design pattern used to build modules, this method returns a new instance of this method. NOTE: it
     * should never be initialized or modified in some other way. A simple new instance is required.
     *
     * \return the prototype used to create every module in OpenWalnut.
     */
    virtual std::shared_ptr< WModule > factory() const;
 
    /**
     * Get the icon for this module in XPM format.
     * \return The icon.
     */
    virtual const char** getXPMIcon() const;
 
protected:
    /**
     * Entry point after loading the module. Runs in separate thread.
     */
    virtual void moduleMain();
 
    /**
     * Initialize the connectors this module is using.
     */
    virtual void connectors();
 
    /**
     * Initialize the properties for this module.
     */
    virtual void properties();
 
 
private:
    /**
     * Store the mesh in legacy vtk file format.
     *
     * \return true if successful.
     */
    bool saveVTKASCII() const;
 
    /**
     * Write STL format.
     *
     * \return  true if successful.
     */
    bool saveSTL();
 
    /**
     * Store the mesh in a json (javascript object notation) file.
     *
     * \return true if successful.
     */
    bool saveJson();
 
    /**
     * Splits the mesh in several mesh files (to solve maximum mesh limits in BrainGlL).
     *
     * \param triMesh mesh object to be divided
     * \param  targetSize maximum resulting mesh size
     * \return vector of resulting meshes
     */
    std::vector< std::shared_ptr< WTriangleMesh > >splitMesh( std::shared_ptr< WTriangleMesh > triMesh, size_t targetSize );
 
    std::shared_ptr< WModuleInputData< WTriangleMesh > > m_meshInput; //!< Input connector for a mesh
    std::shared_ptr< WTriangleMesh > m_triMesh; //!< A pointer to the currently processed tri mesh
    std::shared_ptr< WCondition > m_propCondition;  //!< A condition used to notify about changes in several properties.
    WPropGroup    m_savePropGroup; //!< Property group containing properties needed for saving the mesh.
    WPropTrigger  m_saveTriggerProp; //!< This property triggers the actual writing,
    WPropFilename m_meshFile; //!< The mesh will be written to this file.
 
    /**
     * A list of file type selection types
     */
    std::shared_ptr< WItemSelection > m_fileTypeSelectionsList;
 
    /**
     * Selection property for file types
     */
    WPropSelection m_fileTypeSelection;
 
    /**
     * If true, colors get exported too.
     */
    WPropBool m_writeColors;
};
 
#endif  // WMWRITEMESH_H