WMIsosurfaceRaytracer.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 WMISOSURFACERAYTRACER_H
#define WMISOSURFACERAYTRACER_H
 
#include <memory>
#include <string>
 
#include <osg/Node>
#include <osg/Uniform>
 
#include "core/graphicsEngine/shaders/WGEShader.h"
#include "core/kernel/WModule.h"
#include "core/kernel/WModuleInputData.h"
#include "core/kernel/WModuleOutputData.h"
 
class WDataSetVector;
class WDataSetScalar;
 
/**
 * This module builds the base for fast raytracing of isosurfacesin OpenWalnut. It uses shader based raytracing.
 *
 * \ingroup modules
 */
class WMIsosurfaceRaytracer: public WModule
{
public:
    /**
     * Default constructor.
     */
    WMIsosurfaceRaytracer();
 
    /**
     * Destructor.
     */
    virtual ~WMIsosurfaceRaytracer();
 
    /**
     * 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();
 
    /**
     * Initialize requirements for this module.
     */
    virtual void requirements();
 
private:
    /**
     * An input connector used to get datasets from other modules. The connection management between connectors must not be handled by the module.
     */
    std::shared_ptr< WModuleInputData< WDataSetScalar > > m_input;
 
    /**
     * The gradient field input
     */
    std::shared_ptr< WModuleInputData< WDataSetVector > > m_gradients;
 
    /**
     * The Isovalue used in the case m_isoSurface is true.
     */
    WPropDouble m_isoValue;
 
    /**
     * The color used when in isosurface mode for blending.
     */
    WPropColor m_isoColor;
 
    /**
     * The number of steps to walk along the ray.
     */
    WPropInt m_stepCount;
 
    /**
     * The numeric precision used for iso-checking.
     */
    WPropDouble m_epsilon;
 
    /**
     * The alpha transparency used for the rendering
     */
    WPropDouble m_alpha;
 
    /**
     * The ratio between colormap and normal surface color.
     */
    WPropDouble m_colormapRatio;
 
    /**
     * Some special coloring mode for disabling specular hightlights.
     */
    WPropBool m_phongNoSpec;
 
    /**
     * If true, per-pixel-phong shading is applied to the surface.
     */
    WPropBool m_phongShading;
 
    /**
     * If true, the ray-tracer uses stochastic jitter to improve image quality.
     */
    WPropBool m_stochasticJitter;
 
    /**
     * If true, a certain border area can be clipped. Very useful for non-peeled noisy data.
     */
    WPropBool m_borderClip;
 
    /**
     * The distance used for clipping.
     */
    WPropDouble m_borderClipDistance;
 
    /**
     * A condition used to notify about changes in several properties.
     */
    std::shared_ptr< WCondition > m_propCondition;
 
    /**
     * the DVR shader.
     */
    osg::ref_ptr< WGEShader > m_shader;
};
 
#endif  // WMISOSURFACERAYTRACER_H