~ubuntu-branches/ubuntu/raring/openwalnut/raring

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

//

// 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 WDATACREATORSPHERE_H

#define WDATACREATORSPHERE_H

 

#include <core/common/WObjectNDIP.h>

 

#include "WDataSetSingleCreatorInterface.h"

 

/**

 * Creates a sphere inside a given grid. Only works on scalar fields.

 */

class WDataCreatorSphere: public WObjectNDIP< WDataSetSingleCreatorInterface >

{

public:

    /**

     * Default constructor.

     */

    WDataCreatorSphere();

 

    /**

     * Destructor.

     */

    virtual ~WDataCreatorSphere();

 

    /**

     * Create the dataset. This needs to be implemented by all the creators you write. This method is designed to be applicable to all kinds of

     * WDataSetSingle that use WValueSetBase. Your implementation does not need to support all types. If you do not support any order/dimension

     * combination, throw an exception (like by using WAssert).

     *

     * \param order the tensor order of the values stored in this WValueSet

     * \param dimension the tensor dimension of the values stored in this WValueSet

     * \param progress the progress instance you should increment each time you fill the value for one voxel.

     * \param grid the grid on which the value set has to be build

     * \param type the value type in the value set

     *

     * \return the value set for the given grid

     */

    virtual WValueSetBase::SPtr operator()( WProgress::SPtr progress,

                                            WGridRegular3D::ConstSPtr grid, unsigned char order = 0, unsigned char dimension = 1,

                                            dataType type = W_DT_FLOAT );

 

protected:

private:

    /**

     * Relative center coordinates

     */

    WPropPosition m_center;

 

    /**

     * The radius of the sphere in relative coordinates.

     */

    WPropDouble m_radius;

 

    /**

     * Clamp to 0 for all values below this one

     */

    WPropDouble m_lowerClamp;

 

    /**

     * Clamp to 0 for all values above

     */

    WPropDouble m_upperClamp;

 

    /**

     * To which value should be clamped?

     */

    WPropDouble m_lowerClampValue;

 

    /**

     * To which value should be clamped?

     */

    WPropDouble m_upperClampValue;

};

 

#endif  // WDATACREATORSPHERE_H