AnotherFoxGuy/polyvox
1
0
Fork 0
Code Issues Pull Requests Activity

Various documentation enhancements.

Browse Source
This commit is contained in:
David Williams
2016-01-03 22:31:24 +00:00
parent 4d2a27ea8e
commit eef0bebacf
5 changed files with 15 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
include/PolyVox/BaseVolume.h
View File

@@ -35,7 +35,7 @@ namespace PolyVox
/// The BaseVolume class provides common functionality and an interface for other volume classes to implement.
/// You should not try to create an instance of this class directly. Instead you should use RawVolume or PagedVolume.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// More details to come...
/// \sa RawVolume, PagedVolume
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
template <typename _VoxelType>
class BaseVolume

9
include/PolyVox/DefaultIsQuadNeeded.h
View File

@@ -31,6 +31,15 @@
namespace PolyVox
{
/// Default implementation of a function object for deciding when
/// the cubic surface extractor should insert a face between two voxels.
///
/// The criteria used here are that the voxel in front of the potential
/// quad should have a value of zero (which would typically indicate empty
/// space) while the voxel behind the potential quad would have a value
/// geater than zero (typically indicating it is solid). Note that for
/// different behaviour users can create their own implementation and pass
/// it to extractCubicMesh().
template<typename VoxelType>
class DefaultIsQuadNeeded
{

2
include/PolyVox/DefaultMarchingCubesController.h
View File

@@ -56,7 +56,7 @@ namespace PolyVox
* will pass through the density value specified by the threshold, and so you should make sure that the threshold value you choose is between
* the minimum and maximum values found in your volume data. By default it is in the middle of the representable range of the underlying type.
*
* \sa MarchingCubesSurfaceExtractor
* \sa extractMarchingCubesMesh
*
*/
template<typename VoxelType>

4
include/PolyVox/Density.h
View File

@@ -38,7 +38,9 @@ namespace PolyVox
{
/// This class represents a voxel storing only a density.
////////////////////////////////////////////////////////////////////////////////
/// Detailed description...
/// Note that this should probably just be considered an example of how to define
/// a voxel type for the Marching Cubes algorithm. Advanced users are likely to
/// define custom voxel types and possibly custom controllers.
////////////////////////////////////////////////////////////////////////////////
template <typename Type>
class Density

2
include/PolyVox/Exceptions.h
View File

@@ -28,7 +28,7 @@
#include <stdexcept> // For base exception classes.
#include <string.h> // Exception constuctors take strings.
// These exceptions form part of the public API because lcient code may need to catch them.
// These exceptions form part of the public API because client code may need to catch them.
// Note that our utility macros such as 'POLYVOX_THROW_IF' do not form part of the public API
// as they are only for our own internal use.
namespace PolyVox