OgreVolumeGridSource.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2013 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __Ogre_Volume_GridSource_H__
#define __Ogre_Volume_GridSource_H__

#include "OgreVector4.h"

#include "OgreVolumePrerequisites.h"
#include "OgreVolumeSource.h"
#include "OgreVolumeCSGSource.h"

namespace Ogre {
namespace Volume {

    class _OgreVolumeExport GridSource : public Source
    {
    protected:

        size_t mWidth;

        size_t mHeight;
        
        size_t mDepth;
        
        Real mPosXScale;
        
        Real mPosYScale;
        
        Real mPosZScale;

        bool mTrilinearValue;
        
        const bool mTrilinearGradient;

        const bool mSobelGradient;

        Real mVolumeSpaceToWorldSpaceFactor;
        
        virtual Vector3 getIntersectionStart(const Ray &ray, Real maxDistance) const;
        
        virtual Vector3 getIntersectionEnd(const Ray &ray, Real maxDistance) const;

        virtual float getVolumeGridValue(size_t x, size_t y, size_t z) const = 0;
        
        virtual void setVolumeGridValue(int x, int y, int z, float value) = 0;

        inline const Vector3 getGradient(size_t x, size_t y, size_t z) const
        {
            if (mSobelGradient)
            {
                // Calculate gradient like in the original MC paper but mix a bit of Sobel in
                return Vector3(
                (getVolumeGridValue(x + 1, y - 1, z) - getVolumeGridValue(x - 1, y - 1, z))
                        + (Real)2.0 * (getVolumeGridValue(x + 1, y, z) - getVolumeGridValue(x - 1, y, z))
                        + (getVolumeGridValue(x + 1, y + 1, z) - getVolumeGridValue(x - 1, y + 1, z)),
                (getVolumeGridValue(x, y + 1, z - 1) - getVolumeGridValue(x, y - 1, z - 1))
                    + (Real)2.0 * (getVolumeGridValue(x, y + 1, z) - getVolumeGridValue(x, y - 1, z))
                    + (getVolumeGridValue(x, y + 1, z + 1) - getVolumeGridValue(x, y - 1, z + 1)),
                (getVolumeGridValue(x - 1, y, z + 1) - getVolumeGridValue(x - 1, y, z - 1))
                    + (Real)2.0 * (getVolumeGridValue(x, y, z + 1) - getVolumeGridValue(x, y, z - 1))
                    + (getVolumeGridValue(x + 1, y, z + 1) - getVolumeGridValue(x + 1, y, z - 1))) / (Real)4.0;
            }
            // Calculate gradient like in the original MC paper
            return Vector3(
                getVolumeGridValue(x + 1, y, z) - getVolumeGridValue(x - 1, y, z),
                getVolumeGridValue(x, y + 1, z) - getVolumeGridValue(x, y - 1, z),
                getVolumeGridValue(x, y, z + 1) - getVolumeGridValue(x, y, z - 1));
        }

    public:

        GridSource(bool trilinearValue, bool trilinearGradient, bool sobelGradient);

        virtual ~GridSource(void);

        virtual Vector4 getValueAndGradient(const Vector3 &position) const;
        
        virtual Real getValue(const Vector3 &position) const;

        size_t getWidth(void) const;
        
        size_t getHeight(void) const;
        
        size_t getDepth(void) const;

        virtual void combineWithSource(CSGOperationSource *operation, Source *source, const Vector3 &center, Real radius);
    
        
        Real getVolumeSpaceToWorldSpaceFactor(void) const;

    };

}
}

#endif