RawVolume.inl

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.   
*******************************************************************************/

namespace PolyVox
{
    template <typename VoxelType>
    RawVolume<VoxelType>::RawVolume(const Region& regValid)
        :BaseVolume<VoxelType>(regValid)
    {
        this->setBorderValue(VoxelType());

        //Create a volume of the right size.
        initialise(regValid);
    }

    template <typename VoxelType>
    RawVolume<VoxelType>::RawVolume(const RawVolume<VoxelType>& /*rhs*/)
    {
        POLYVOX_ASSERT(false, "Copy constructor not implemented."); // See function comment above.
    }

    template <typename VoxelType>
    RawVolume<VoxelType>::~RawVolume()
    {
        delete[] m_pData;
        m_pData = 0;
    }

    template <typename VoxelType>
    RawVolume<VoxelType>& RawVolume<VoxelType>::operator=(const RawVolume<VoxelType>& /*rhs*/)
    {
        POLYVOX_ASSERT(false, "Assignment operator not implemented."); // See function comment above.
    }

    template <typename VoxelType>
    VoxelType RawVolume<VoxelType>::getVoxel(int32_t uXPos, int32_t uYPos, int32_t uZPos) const
    {
        POLYVOX_ASSERT(this->m_regValidRegion.containsPoint(Vector3DInt32(uXPos, uYPos, uZPos)), "Position is outside valid region");

        const Vector3DInt32& v3dLowerCorner = this->m_regValidRegion.getLowerCorner();
        int32_t iLocalXPos = uXPos - v3dLowerCorner.getX();
        int32_t iLocalYPos = uYPos - v3dLowerCorner.getY();
        int32_t iLocalZPos = uZPos - v3dLowerCorner.getZ();

        return m_pData
        [
            iLocalXPos + 
            iLocalYPos * this->getWidth() + 
            iLocalZPos * this->getWidth() * this->getHeight()
        ];
    }

    template <typename VoxelType>
    VoxelType RawVolume<VoxelType>::getVoxel(const Vector3DInt32& v3dPos) const
    {
        return getVoxel(v3dPos.getX(), v3dPos.getY(), v3dPos.getZ());
    }

    template <typename VoxelType>
    VoxelType RawVolume<VoxelType>::getVoxelAt(int32_t uXPos, int32_t uYPos, int32_t uZPos) const
    {
        if(this->m_regValidRegion.containsPoint(Vector3DInt32(uXPos, uYPos, uZPos)))
        {
            const Vector3DInt32& v3dLowerCorner = this->m_regValidRegion.getLowerCorner();
            int32_t iLocalXPos = uXPos - v3dLowerCorner.getX();
            int32_t iLocalYPos = uYPos - v3dLowerCorner.getY();
            int32_t iLocalZPos = uZPos - v3dLowerCorner.getZ();

            return m_pData
            [
                iLocalXPos + 
                iLocalYPos * this->getWidth() + 
                iLocalZPos * this->getWidth() * this->getHeight()
            ];
        }
        else
        {
            return this->getBorderValue();
        }
    }

    template <typename VoxelType>
    VoxelType RawVolume<VoxelType>::getVoxelAt(const Vector3DInt32& v3dPos) const
    {
        return getVoxelAt(v3dPos.getX(), v3dPos.getY(), v3dPos.getZ());
    }

    template <typename VoxelType>
    VoxelType RawVolume<VoxelType>::getVoxelWithWrapping(int32_t uXPos, int32_t uYPos, int32_t uZPos, WrapMode eWrapMode, VoxelType tBorder) const
    {
        switch(eWrapMode)
        {
            case WrapModes::Clamp:
            {
                //Perform clamping
                uXPos = (std::max)(uXPos, this->m_regValidRegion.getLowerX());
                uYPos = (std::max)(uYPos, this->m_regValidRegion.getLowerY());
                uZPos = (std::max)(uZPos, this->m_regValidRegion.getLowerZ());
                uXPos = (std::min)(uXPos, this->m_regValidRegion.getUpperX());
                uYPos = (std::min)(uYPos, this->m_regValidRegion.getUpperY());
                uZPos = (std::min)(uZPos, this->m_regValidRegion.getUpperZ());

                //Get the voxel value
                return getVoxel(uXPos, uYPos, uZPos);
                //No need to break as we've returned
            }
            case WrapModes::Border:
            {
                if(this->m_regValidRegion.containsPoint(uXPos, uYPos, uZPos))
                {
                    return getVoxel(uXPos, uYPos, uZPos);
                }
                else
                {
                    return tBorder;
                }
                //No need to break as we've returned
            }
            default:
            {
                //Should never happen
                POLYVOX_ASSERT(false, "Invalid case.");
                return VoxelType();
            }
        }
    }

    template <typename VoxelType>
    VoxelType RawVolume<VoxelType>::getVoxelWithWrapping(const Vector3DInt32& v3dPos, WrapMode eWrapMode, VoxelType tBorder) const
    {
        return getVoxelWithWrapping(v3dPos.getX(), v3dPos.getY(), v3dPos.getZ(), eWrapMode, tBorder);
    }

    template <typename VoxelType>
    bool RawVolume<VoxelType>::setVoxelAt(int32_t uXPos, int32_t uYPos, int32_t uZPos, VoxelType tValue)
    {
        if(this->m_regValidRegion.containsPoint(Vector3DInt32(uXPos, uYPos, uZPos)))
        {
            const Vector3DInt32& v3dLowerCorner = this->m_regValidRegion.getLowerCorner();
            int32_t iLocalXPos = uXPos - v3dLowerCorner.getX();
            int32_t iLocalYPos = uYPos - v3dLowerCorner.getY();
            int32_t iLocalZPos = uZPos - v3dLowerCorner.getZ();

            m_pData
            [
                iLocalXPos + 
                iLocalYPos * this->getWidth() + 
                iLocalZPos * this->getWidth() * this->getHeight()
            ] = tValue;

            //Return true to indicate that we modified a voxel.
            return true;
        }
        else
        {
            return false;
        }
    }

    template <typename VoxelType>
    bool RawVolume<VoxelType>::setVoxelAt(const Vector3DInt32& v3dPos, VoxelType tValue)
    {
        return setVoxelAt(v3dPos.getX(), v3dPos.getY(), v3dPos.getZ(), tValue);
    }

    template <typename VoxelType>
    void RawVolume<VoxelType>::initialise(const Region& regValidRegion)
    {
        this->m_regValidRegion = regValidRegion;

        //Ensure dimensions of the specified Region are valid
        POLYVOX_ASSERT(this->getWidth() > 0, "Volume width must be greater than zero.");
        POLYVOX_ASSERT(this->getHeight() > 0, "Volume width must be greater than zero.");
        POLYVOX_ASSERT(this->getDepth() > 0, "Volume width must be greater than zero.");

        //Create the data
        m_pData = new VoxelType[this->getWidth() * this->getHeight()* this->getDepth()];

        //Other properties we might find useful later
        this->m_uLongestSideLength = (std::max)((std::max)(this->getWidth(),this->getHeight()),this->getDepth());
        this->m_uShortestSideLength = (std::min)((std::min)(this->getWidth(),this->getHeight()),this->getDepth());
        this->m_fDiagonalLength = sqrtf(static_cast<float>(this->getWidth() * this->getWidth() + this->getHeight() * this->getHeight() + this->getDepth() * this->getDepth()));
    }

    template <typename VoxelType>
    uint32_t RawVolume<VoxelType>::calculateSizeInBytes(void)
    {
        return this->getWidth() * this->getHeight() * this->getDepth() * sizeof(VoxelType);
    }

}