Region.cpp

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

#include "PolyVoxCore/Region.h"

#include <limits>

namespace PolyVox
{
    const Region Region::MaxRegion
    (
        Vector3DInt32((std::numeric_limits<int32_t>::min)(), (std::numeric_limits<int32_t>::min)(), (std::numeric_limits<int32_t>::min)()),
        Vector3DInt32((std::numeric_limits<int32_t>::max)(), (std::numeric_limits<int32_t>::max)(), (std::numeric_limits<int32_t>::max)())
    );

    const Region Region::InvertedRegion
    (
        Vector3DInt32((std::numeric_limits<int32_t>::max)(), (std::numeric_limits<int32_t>::max)(), (std::numeric_limits<int32_t>::max)()),
        Vector3DInt32((std::numeric_limits<int32_t>::min)(), (std::numeric_limits<int32_t>::min)(), (std::numeric_limits<int32_t>::min)())
    );

    void Region::accumulate(int32_t iX, int32_t iY, int32_t iZ)
    {
        m_iLowerX = ((std::min)(m_iLowerX, iX));
        m_iLowerY = ((std::min)(m_iLowerY, iY));
        m_iLowerZ = ((std::min)(m_iLowerZ, iZ));
        m_iUpperX = ((std::max)(m_iUpperX, iX));
        m_iUpperY = ((std::max)(m_iUpperY, iY));
        m_iUpperZ = ((std::max)(m_iUpperZ, iZ));
    }

    void Region::accumulate(const Vector3DInt32& v3dPos)
    {
        accumulate(v3dPos.getX(), v3dPos.getY(), v3dPos.getZ());
    }

    void Region::accumulate(const Region& reg)
    {
        POLYVOX_ASSERT(reg.isValid(), "You cannot accumulate an invalid region."); //The result of accumulating an invalid region is not defined.

        m_iLowerX = ((std::min)(m_iLowerX, reg.getLowerX()));
        m_iLowerY = ((std::min)(m_iLowerY, reg.getLowerY()));
        m_iLowerZ = ((std::min)(m_iLowerZ, reg.getLowerZ()));
        m_iUpperX = ((std::max)(m_iUpperX, reg.getUpperX()));
        m_iUpperY = ((std::max)(m_iUpperY, reg.getUpperY()));
        m_iUpperZ = ((std::max)(m_iUpperZ, reg.getUpperZ()));
    }

    Region::Region()
        :m_iLowerX(0)
        ,m_iLowerY(0)
        ,m_iLowerZ(0)
        ,m_iUpperX(0)
        ,m_iUpperY(0)
        ,m_iUpperZ(0)
    {
    }

    Region::Region(const Vector3DInt32& v3dLowerCorner, const Vector3DInt32& v3dUpperCorner)
        :m_iLowerX(v3dLowerCorner.getX())
        ,m_iLowerY(v3dLowerCorner.getY())
        ,m_iLowerZ(v3dLowerCorner.getZ())
        ,m_iUpperX(v3dUpperCorner.getX())
        ,m_iUpperY(v3dUpperCorner.getY())
        ,m_iUpperZ(v3dUpperCorner.getZ())
    {
    }

    Region::Region(int32_t iLowerX, int32_t iLowerY, int32_t iLowerZ, int32_t iUpperX, int32_t iUpperY, int32_t iUpperZ)
        :m_iLowerX(iLowerX)
        ,m_iLowerY(iLowerY)
        ,m_iLowerZ(iLowerZ)
        ,m_iUpperX(iUpperX)
        ,m_iUpperY(iUpperY)
        ,m_iUpperZ(iUpperZ)
    {
    }

    bool Region::operator==(const Region& rhs) const
    {
        return ((m_iLowerX == rhs.m_iLowerX) && (m_iLowerY == rhs.m_iLowerY) && (m_iLowerZ == rhs.m_iLowerZ)
            &&  (m_iUpperX == rhs.m_iUpperX) && (m_iUpperY == rhs.m_iUpperY) && (m_iUpperZ == rhs.m_iUpperZ));
    }

    bool Region::operator!=(const Region& rhs) const
    {
        return !(*this == rhs);
    }

    bool Region::containsPoint(float fX, float fY, float fZ, float boundary) const
    {
        return (fX <= m_iUpperX - boundary)
            && (fY <= m_iUpperY - boundary)
            && (fZ <= m_iUpperZ - boundary)
            && (fX >= m_iLowerX + boundary)
            && (fY >= m_iLowerY + boundary)
            && (fZ >= m_iLowerZ + boundary);
    }

    bool Region::containsPoint(const Vector3DFloat& pos, float boundary) const
    {
        return containsPoint(pos.getX(), pos.getY(), pos.getZ(), boundary);
    }

    bool Region::containsPoint(int32_t iX, int32_t iY, int32_t iZ, uint8_t boundary) const
    {
        return (iX <= m_iUpperX - boundary)
            && (iY <= m_iUpperY - boundary) 
            && (iZ <= m_iUpperZ - boundary)
            && (iX >= m_iLowerX + boundary)
            && (iY >= m_iLowerY + boundary)
            && (iZ >= m_iLowerZ + boundary);
    }

    bool Region::containsPoint(const Vector3DInt32& pos, uint8_t boundary) const
    {
        return containsPoint(pos.getX(), pos.getY(), pos.getZ(), boundary);
    }

    bool Region::containsPointInX(float pos, float boundary) const
    {
        return (pos <= m_iUpperX - boundary)
            && (pos >= m_iLowerX + boundary);
    }

    bool Region::containsPointInX(int32_t pos, uint8_t boundary) const
    {
        return (pos <= m_iUpperX - boundary)
            && (pos >= m_iLowerX + boundary);
    }

    bool Region::containsPointInY(float pos, float boundary) const
    {
        return (pos <= m_iUpperY - boundary)
            && (pos >= m_iLowerY + boundary);
    }

    bool Region::containsPointInY(int32_t pos, uint8_t boundary) const
    {
        return (pos <= m_iUpperY - boundary) 
            && (pos >= m_iLowerY + boundary);
    }

    bool Region::containsPointInZ(float pos, float boundary) const
    {
        return (pos <= m_iUpperZ - boundary)
            && (pos >= m_iLowerZ + boundary);
    }

    bool Region::containsPointInZ(int32_t pos, uint8_t boundary) const
    {
        return (pos <= m_iUpperZ - boundary)
            && (pos >= m_iLowerZ + boundary);
    }

    void Region::cropTo(const Region& other)
    {
        m_iLowerX = ((std::max)(m_iLowerX, other.m_iLowerX));
        m_iLowerY = ((std::max)(m_iLowerY, other.m_iLowerY));
        m_iLowerZ = ((std::max)(m_iLowerZ, other.m_iLowerZ));
        m_iUpperX = ((std::min)(m_iUpperX, other.m_iUpperX));
        m_iUpperY = ((std::min)(m_iUpperY, other.m_iUpperY));
        m_iUpperZ = ((std::min)(m_iUpperZ, other.m_iUpperZ));
    }

    void Region::grow(int32_t iAmount)
    {
        m_iLowerX -= iAmount;
        m_iLowerY -= iAmount;
        m_iLowerZ -= iAmount;

        m_iUpperX += iAmount;
        m_iUpperY += iAmount;
        m_iUpperZ += iAmount;
    }

    void Region::grow(int32_t iAmountX, int32_t iAmountY, int32_t iAmountZ)
    {
        m_iLowerX -= iAmountX;
        m_iLowerY -= iAmountY;
        m_iLowerZ -= iAmountZ;

        m_iUpperX += iAmountX;
        m_iUpperY += iAmountY;
        m_iUpperZ += iAmountZ;
    }

    void Region::grow(const Vector3DInt32& v3dAmount)
    {
        grow(v3dAmount.getX(), v3dAmount.getY(), v3dAmount.getZ());
    }

    bool Region::isValid(void) const
    {
        return (m_iUpperX >= m_iLowerX) && (m_iUpperY >= m_iLowerY) && (m_iUpperZ >= m_iLowerZ);
    }

    void Region::shift(int32_t iAmountX, int32_t iAmountY, int32_t iAmountZ)
    {
        shiftLowerCorner(iAmountX, iAmountY, iAmountZ);
        shiftUpperCorner(iAmountX, iAmountY, iAmountZ);
    }

    void Region::shift(const Vector3DInt32& v3dAmount)
    {
        shiftLowerCorner(v3dAmount);
        shiftUpperCorner(v3dAmount);
    }

    void Region::shiftLowerCorner(int32_t iAmountX, int32_t iAmountY, int32_t iAmountZ)
    {
        m_iLowerX += iAmountX;
        m_iLowerY += iAmountY;
        m_iLowerZ += iAmountZ;
    }

    void Region::shiftLowerCorner(const Vector3DInt32& v3dAmount)
    {
        shiftLowerCorner(v3dAmount.getX(), v3dAmount.getY(), v3dAmount.getZ());
    }

    void Region::shiftUpperCorner(int32_t iAmountX, int32_t iAmountY, int32_t iAmountZ)
    {
        m_iUpperX += iAmountX;
        m_iUpperY += iAmountY;
        m_iUpperZ += iAmountZ;
    }

    void Region::shiftUpperCorner(const Vector3DInt32& v3dAmount)
    {
        shiftUpperCorner(v3dAmount.getX(), v3dAmount.getY(), v3dAmount.getZ());
    }

    void Region::shrink(int32_t iAmount)
    {
        m_iLowerX += iAmount;
        m_iLowerY += iAmount;
        m_iLowerZ += iAmount;

        m_iUpperX -= iAmount;
        m_iUpperY -= iAmount;
        m_iUpperZ -= iAmount;
    }

    void Region::shrink(int32_t iAmountX, int32_t iAmountY, int32_t iAmountZ)
    {
        m_iLowerX += iAmountX;
        m_iLowerY += iAmountY;
        m_iLowerZ += iAmountZ;

        m_iUpperX -= iAmountX;
        m_iUpperY -= iAmountY;
        m_iUpperZ -= iAmountZ;
    }

    void Region::shrink(const Vector3DInt32& v3dAmount)
    {
        shrink(v3dAmount.getX(), v3dAmount.getY(), v3dAmount.getZ());
    }
}