BaseVolume.h

Go to the documentation of this file.

/*******************************************************************************
Copyright (c) 2005-2009 David Williams

This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:

    1. The origin of this software must not be misrepresented; you must not
    claim that you wrote the original software. If you use this software
    in a product, an acknowledgment in the product documentation would be
    appreciated but is not required.

    2. Altered source versions must be plainly marked as such, and must not be
    misrepresented as being the original software.

    3. This notice may not be removed or altered from any source
    distribution.   
*******************************************************************************/

#ifndef __PolyVox_BaseVolume_H__
#define __PolyVox_BaseVolume_H__

#include "PolyVoxCore/Log.h"
#include "PolyVoxCore/Region.h"
#include "PolyVoxCore/Vector.h"

#include <limits>

namespace PolyVox
{
    namespace WrapModes
    {
        enum WrapMode
        {
            Clamp = 0,
            Border = 1
        };
    }
    typedef WrapModes::WrapMode WrapMode;

    template <typename _VoxelType>
    class BaseVolume
    {
    public:
        typedef _VoxelType VoxelType;

        #ifndef SWIG
        template <typename DerivedVolumeType>
        class Sampler
        {
        public:
            Sampler(DerivedVolumeType* volume);
            ~Sampler();

            Vector3DInt32 getPosition(void) const;
            inline VoxelType getVoxel(void) const;  

            bool isCurrentPositionValid(void) const;

            void setPosition(const Vector3DInt32& v3dNewPos);
            void setPosition(int32_t xPos, int32_t yPos, int32_t zPos);
            inline bool setVoxel(VoxelType tValue);
            void setWrapMode(WrapMode eWrapMode, VoxelType tBorder = VoxelType());

            void movePositiveX(void);
            void movePositiveY(void);
            void movePositiveZ(void);

            void moveNegativeX(void);
            void moveNegativeY(void);
            void moveNegativeZ(void);

            inline VoxelType peekVoxel1nx1ny1nz(void) const;
            inline VoxelType peekVoxel1nx1ny0pz(void) const;
            inline VoxelType peekVoxel1nx1ny1pz(void) const;
            inline VoxelType peekVoxel1nx0py1nz(void) const;
            inline VoxelType peekVoxel1nx0py0pz(void) const;
            inline VoxelType peekVoxel1nx0py1pz(void) const;
            inline VoxelType peekVoxel1nx1py1nz(void) const;
            inline VoxelType peekVoxel1nx1py0pz(void) const;
            inline VoxelType peekVoxel1nx1py1pz(void) const;

            inline VoxelType peekVoxel0px1ny1nz(void) const;
            inline VoxelType peekVoxel0px1ny0pz(void) const;
            inline VoxelType peekVoxel0px1ny1pz(void) const;
            inline VoxelType peekVoxel0px0py1nz(void) const;
            inline VoxelType peekVoxel0px0py0pz(void) const;
            inline VoxelType peekVoxel0px0py1pz(void) const;
            inline VoxelType peekVoxel0px1py1nz(void) const;
            inline VoxelType peekVoxel0px1py0pz(void) const;
            inline VoxelType peekVoxel0px1py1pz(void) const;

            inline VoxelType peekVoxel1px1ny1nz(void) const;
            inline VoxelType peekVoxel1px1ny0pz(void) const;
            inline VoxelType peekVoxel1px1ny1pz(void) const;
            inline VoxelType peekVoxel1px0py1nz(void) const;
            inline VoxelType peekVoxel1px0py0pz(void) const;
            inline VoxelType peekVoxel1px0py1pz(void) const;
            inline VoxelType peekVoxel1px1py1nz(void) const;
            inline VoxelType peekVoxel1px1py0pz(void) const;
            inline VoxelType peekVoxel1px1py1pz(void) const;

        protected:
            VoxelType getVoxelAt(int32_t uXPos, int32_t uYPos, int32_t uZPos) const;

            DerivedVolumeType* mVolume;

            //The current position in the volume
            int32_t mXPosInVolume;
            int32_t mYPosInVolume;
            int32_t mZPosInVolume;

            WrapMode m_eWrapMode;
            VoxelType m_tBorder;

            //Whether the current position is inside the volume
            //FIXME - Replace these with flags
            bool m_bIsCurrentPositionValidInX;
            bool m_bIsCurrentPositionValidInY;
            bool m_bIsCurrentPositionValidInZ;
        };
        #endif

    public:
        VoxelType getBorderValue(void) const;
        const Region& getEnclosingRegion(void) const;
        int32_t getWidth(void) const;
        int32_t getHeight(void) const;
        int32_t getDepth(void) const;
        int32_t getLongestSideLength(void) const;
        int32_t getShortestSideLength(void) const;
        float getDiagonalLength(void) const;
        VoxelType getVoxel(int32_t uXPos, int32_t uYPos, int32_t uZPos) const;
        VoxelType getVoxel(const Vector3DInt32& v3dPos) const;
        VoxelType getVoxelAt(int32_t uXPos, int32_t uYPos, int32_t uZPos) const;
        VoxelType getVoxelAt(const Vector3DInt32& v3dPos) const;
        VoxelType getVoxelWithWrapping(int32_t uXPos, int32_t uYPos, int32_t uZPos, WrapMode eWrapMode = WrapModes::Border, VoxelType tBorder = VoxelType()) const;
        VoxelType getVoxelWithWrapping(const Vector3DInt32& v3dPos, WrapMode eWrapMode = WrapModes::Border, VoxelType tBorder = VoxelType()) const;

        void setBorderValue(const VoxelType& tBorder);
        bool setVoxelAt(int32_t uXPos, int32_t uYPos, int32_t uZPos, VoxelType tValue);
        bool setVoxelAt(const Vector3DInt32& v3dPos, VoxelType tValue);

        uint32_t calculateSizeInBytes(void);

    protected:  
        BaseVolume(const Region& regValid);

        BaseVolume(const BaseVolume& rhs);

        ~BaseVolume();

        BaseVolume& operator=(const BaseVolume& rhs);

        //The size of the volume
        Region m_regValidRegion;

        //Some useful sizes
        int32_t m_uLongestSideLength;
        int32_t m_uShortestSideLength;
        float m_fDiagonalLength;

        //The border value
        VoxelType m_tBorderValue;
    };
}

#include "PolyVoxCore/BaseVolume.inl"
#include "PolyVoxCore/BaseVolumeSampler.inl"

#endif //__PolyVox_BaseVolume_H__