BaseVolume.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>
    BaseVolume<VoxelType>::BaseVolume(const Region& regValid)
        :m_regValidRegion(regValid)
        ,m_tBorderValue()
    {
    }

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

    template <typename VoxelType>
    BaseVolume<VoxelType>::~BaseVolume()
    {
    }

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

    template <typename VoxelType>
    VoxelType BaseVolume<VoxelType>::getBorderValue(void) const
    {
        return m_tBorderValue;
    }

    template <typename VoxelType>
    const Region& BaseVolume<VoxelType>::getEnclosingRegion(void) const
    {
        return m_regValidRegion;
    }

    template <typename VoxelType>
    int32_t BaseVolume<VoxelType>::getWidth(void) const
    {
        return m_regValidRegion.getUpperX() - m_regValidRegion.getLowerX() + 1;
    }

    template <typename VoxelType>
    int32_t BaseVolume<VoxelType>::getHeight(void) const
    {
        return m_regValidRegion.getUpperY() - m_regValidRegion.getLowerY() + 1;
    }

    template <typename VoxelType>
    int32_t BaseVolume<VoxelType>::getDepth(void) const
    {
        return m_regValidRegion.getUpperZ() - m_regValidRegion.getLowerZ() + 1;
    }

    template <typename VoxelType>
    int32_t BaseVolume<VoxelType>::getShortestSideLength(void) const
    {
        return m_uShortestSideLength;
    }

    template <typename VoxelType>
    int32_t BaseVolume<VoxelType>::getLongestSideLength(void) const
    {
        return m_uLongestSideLength;
    }   

    template <typename VoxelType>
    float BaseVolume<VoxelType>::getDiagonalLength(void) const
    {
        return m_fDiagonalLength;
    }

    template <typename VoxelType>
    VoxelType BaseVolume<VoxelType>::getVoxel(int32_t /*uXPos*/, int32_t /*uYPos*/, int32_t /*uZPos*/) const
    {
        POLYVOX_ASSERT(false, "You should never call the base class version of this function.");
        return VoxelType();
    }

    template <typename VoxelType>
    VoxelType BaseVolume<VoxelType>::getVoxel(const Vector3DInt32& /*v3dPos*/) const
    {
        POLYVOX_ASSERT(false, "You should never call the base class version of this function.");
        return VoxelType();
    }

    template <typename VoxelType>
    VoxelType BaseVolume<VoxelType>::getVoxelAt(int32_t /*uXPos*/, int32_t /*uYPos*/, int32_t /*uZPos*/) const
    {
        POLYVOX_ASSERT(false, "You should never call the base class version of this function.");
        return VoxelType();
    }

    template <typename VoxelType>
    VoxelType BaseVolume<VoxelType>::getVoxelAt(const Vector3DInt32& /*v3dPos*/) const
    {
        POLYVOX_ASSERT(false, "You should never call the base class version of this function.");
        return VoxelType();
    }

    template <typename VoxelType>
    VoxelType BaseVolume<VoxelType>::getVoxelWithWrapping(int32_t /*uXPos*/, int32_t /*uYPos*/, int32_t /*uZPos*/, WrapMode /*eWrapMode*/, VoxelType /*tBorder*/) const
    {
        POLYVOX_ASSERT(false, "You should never call the base class version of this function.");
        return VoxelType();
    }

    template <typename VoxelType>
    VoxelType BaseVolume<VoxelType>::getVoxelWithWrapping(const Vector3DInt32& /*v3dPos*/, WrapMode /*eWrapMode*/, VoxelType /*tBorder*/) const
    {
        POLYVOX_ASSERT(false, "You should never call the base class version of this function.");
        return VoxelType();
    }

    template <typename VoxelType>
    void BaseVolume<VoxelType>::setBorderValue(const VoxelType& tBorder) 
    {
        m_tBorderValue = tBorder;
    }

    template <typename VoxelType>
    bool BaseVolume<VoxelType>::setVoxelAt(int32_t /*uXPos*/, int32_t /*uYPos*/, int32_t /*uZPos*/, VoxelType /*tValue*/)
    {
        POLYVOX_ASSERT(false, "You should never call the base class version of this function.");
        return false;
    }

    template <typename VoxelType>
    bool BaseVolume<VoxelType>::setVoxelAt(const Vector3DInt32& /*v3dPos*/, VoxelType /*tValue*/)
    {
        POLYVOX_ASSERT(false, "You should never call the base class version of this function.");
        return false;
    }

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