WMDistanceMapIsosurface.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 WMDISTANCEMAPISOSURFACE_H
#define WMDISTANCEMAPISOSURFACE_H
 
#include <memory>
 
 
#include "core/dataHandler/WDataSetScalar.h"
#include "core/kernel/WModule.h"
#include "core/kernel/WModuleContainer.h"
#include "core/kernel/WModuleInputForwardData.h"
#include "core/kernel/WModuleOutputForwardData.h"
 
/**
 * Computes a distance map from an anatomy dataset and renders it as isosurface. It is a composition of isosurface and the
 * distance map module.
 * \ingroup modules
 */
class WMDistanceMapIsosurface : public WModuleContainer
{
/**
 * Only UnitTests may be friends.
 */
friend class WMDistanceMapIsosurfaceTest;
 
public:
    /**
     * Standard constructor.
     */
    WMDistanceMapIsosurface();
 
    /**
     * Destructor.
     */
    ~WMDistanceMapIsosurface();
 
    /**
     * 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 requirements for this module.
     */
    virtual void requirements();
 
    /**
     * Callback for m_active. Overwrite this in your modules to handle m_active changes separately.
     */
    virtual void activate();
 
private:
    WPropDouble m_isoValueProp; //!< Property holding the value for the distance.
    WPropInt m_opacityProp; //!< Property holding the value for the opacity of the surface.
    WPropBool m_useTextureProp; //!< Property indicating whether to use texturing with scalar data sets.
    WPropColor m_surfaceColorProp; //!< Property indicating which color to use for non-textured surface.
 
    std::shared_ptr< WModuleInputForwardData< WDataSetScalar > > m_input;  //!< Input connector required by this module.
    std::shared_ptr< WModuleOutputForwardData< WDataSetScalar > > m_output; //!< Connector to provide the distance map to other modules.
 
    std::shared_ptr< WModule > m_isosurfaceModule; //!< The isosurface module used in this container.
    std::shared_ptr< WModule > m_distanceMapModule; //!< The distance map module used in this container.
};
 
#endif  // WMDISTANCEMAPISOSURFACE_H