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

Add a whole bunch of documentation

Browse Source
This commit is contained in:
Matt Williams
2012-10-27 18:52:50 +01:00
parent 313f7a11ec
commit 856cdca604
8 changed files with 73 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
library/PolyVoxCore/include/PolyVoxCore/SimpleVolume.h
View File

@@ -45,6 +45,7 @@ namespace PolyVox
{
public:
#ifndef SWIG
//Could be made private?
class Block
{
public:
@@ -82,24 +83,35 @@ namespace PolyVox
#endif
{
public:
/// Construct a new Sampler
Sampler(SimpleVolume<VoxelType>* volume);
~Sampler();
Sampler& operator=(const Sampler& rhs) throw();
VoxelType getSubSampledVoxel(uint8_t uLevel) const;
inline VoxelType getVoxel(void) const;
/// Get the value of the current voxel
inline VoxelType getVoxel(void) const;
/// Set the current voxel position
void setPosition(const Vector3DInt32& v3dNewPos);
/// Set the current voxel position
void setPosition(int32_t xPos, int32_t yPos, int32_t zPos);
/// Set the value of the current voxel
inline bool setVoxel(VoxelType tValue);
/// Increase the \a x position by \a 1
void movePositiveX(void);
/// Increase the \a y position by \a 1
void movePositiveY(void);
/// Increase the \a z position by \a 1
void movePositiveZ(void);
/// Decrease the \a x position by \a 1
void moveNegativeX(void);
/// Decrease the \a y position by \a 1
void moveNegativeY(void);
/// Decrease the \a z position by \a 1
void moveNegativeZ(void);
inline VoxelType peekVoxel1nx1ny1nz(void) const;