OgreVolumeSource.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_Source_H__
#define __Ogre_Volume_Source_H__

#include <float.h>
#include "OgreVector3.h"
#include "OgreVolumePrerequisites.h"
#include "OgreRay.h"

namespace Ogre {
namespace Volume {

    class _OgreVolumeExport Source
    {
    protected:

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

    public:

        static const uint32 VOLUME_CHUNK_ID;

        static const uint16 VOLUME_CHUNK_VERSION;

        static const size_t SERIALIZATION_CHUNK_SIZE;
        
        virtual ~Source(void);

        virtual Vector4 getValueAndGradient(const Vector3 &position) const = 0;

        virtual Real getValue(const Vector3 &position) const = 0;

        void serialize(const Vector3 &from, const Vector3 &to, float voxelWidth, const String &file);
        
        void serialize(const Vector3 &from, const Vector3 &to, float voxelWidth, Real maxClampedAbsoluteDensity, const String &file);

        bool getFirstRayIntersection(const Ray &ray, Vector3 &result, Real scale = (Real)1.0, size_t maxIterations = 5000, Real maxDistance = (Real)10000.0) const;

        Real getVolumeSpaceToWorldSpaceFactor(void) const;
    };

}
}

#endif