a79633de09
Also, this will probably cause a compile error on Linux but I'm committing anyway so I remember to investigate it...
78 lines
3.3 KiB
C++
78 lines
3.3 KiB
C++
/*******************************************************************************
|
|
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_Voxel_H__
|
|
#define __PolyVox_Voxel_H__
|
|
|
|
#include "PolyVoxImpl/TypeDef.h"
|
|
|
|
#include <cassert>
|
|
#include <limits>
|
|
|
|
namespace PolyVox
|
|
{
|
|
/// This class represents a voxel
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// Detailed description...
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
template <typename DenType, typename MatType>
|
|
class Voxel
|
|
{
|
|
public:
|
|
// We expose DensityType and MaterialType in this way so that, when code is
|
|
// templatised on voxel type, it can determine the underlying storage type
|
|
// using code such as 'VoxelType::DensityType value = voxel.getDensity()'
|
|
// or 'VoxelType::MaterialType value = voxel.getMaterial()'.
|
|
typedef DenType DensityType;
|
|
typedef MatType MaterialType;
|
|
|
|
DensityType getDensity() const throw() { assert(false); return 0; }
|
|
MaterialType getMaterial() const throw() { assert(false); return 0; }
|
|
|
|
void setDensity(DensityType uDensity) { assert(false); }
|
|
void setMaterial(MaterialType /*uMaterial*/) { assert(false); }
|
|
};
|
|
|
|
// Various properties of the voxel types can be expressed via types traits, similar to the way std::numeric_limits is implemented.
|
|
// This has some advantages compared to storing the properties directly in the voxel class. For example, by using traits it is possible
|
|
// to also apply these properties to primative types which might be desirable (the Volume classes do accept primative types as template
|
|
// parameters). Also, properties such as MinDensity and MaxDensity would be difficult to represent though class members because they
|
|
// depend ont the type (float has a very different range from int8_t for example).
|
|
//
|
|
// The properties are currently exposed as constants because we need access to them at compile time. Ideally we would like to make them
|
|
// functions flagged with 'constexpr' as we could then make use of the max() and min() functions in std::numric_limits, but this is not
|
|
// widely supported by compilers yet. We may change this in the future.
|
|
//
|
|
// Syntax for templatised traits classes: http://stackoverflow.com/q/8606302/849083
|
|
template <typename Type>
|
|
class VoxelTypeTraits
|
|
{
|
|
public:
|
|
const static typename Type::DensityType MinDensity = 0;
|
|
const static typename Type::DensityType MaxDensity = 0;
|
|
};
|
|
|
|
}
|
|
|
|
#endif //__PolyVox_Voxel_H__
|