PolyVoxCore/include/PolyVoxCore/Density.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_Density_H__
#define __PolyVox_Density_H__

#include "PolyVoxImpl/TypeDef.h"

#include <cassert>
#include <limits>

namespace PolyVox
{
    template <typename DensityType>
    class Density
    {
    public:
        Density() : m_uDensity(0) {}
        Density(DensityType uDensity) : m_uDensity(uDensity) {}

        bool operator==(const Density& rhs) const throw()
        {
            return (m_uDensity == rhs.m_uDensity);
        };

        bool operator!=(const Density& rhs) const throw()
        {
            return !(*this == rhs);
        }

        DensityType getDensity() const throw() { return m_uDensity; }
        uint32_t getMaterial() const throw() { return 1; }

        void setDensity(DensityType uDensity) { m_uDensity = uDensity; }
        void setMaterial(uint32_t uMaterial) { assert(false); } //Cannot set material on voxel of type Density

        static DensityType getMaxDensity() throw() { return (std::numeric_limits<DensityType>::max)(); } 
        static DensityType getMinDensity() throw() { return (std::numeric_limits<DensityType>::min)(); }
        static DensityType getThreshold() throw() { return (std::numeric_limits<DensityType>::max)() / 2; }

    private:
        DensityType m_uDensity;
    };

    typedef Density<uint8_t> Density8;
}

#endif //__PolyVox_Density_H__