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

Minor update to 'Principles of PolyVox'

Browse Source
This commit is contained in:
David Williams 2016-01-31 10:23:46 +00:00
parent b5e8b63810
commit 3caa86a462
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
documentation/principles.rst
View File

@ -3,12 +3,10 @@ Principles of PolyVox
**********************
.. warning ::
This section is being written and is just a skeleton for now
This section is yet to be fully written and is just a skeleton for now.
PolyVox provides a library for managing 3D arrays (volumes) of data (voxels). It gives you the tools to iterate through, randomly access, read and write volumes. It supports any type you'd like to represent each voxel whether it's just an ``int`` or a class which encapsulates both density and colour.
PolyVox provides a library for managing 3D arrays (volumes) of data (voxels). It gives you the tools to iterate through, randomly access, read and write volumes. The volumes are templatized on voxel type, so that each voxel can be as simple as just an number or as complex as a class with a range of properties.
Once you have a volume, PolyVox provides a number of tools for turning it into something that you can pass to your rendering engine. These are called `surface extractors`.
Once you have created a volume, PolyVox provides a number of tools for turning it into a mesh that you can pass to your rendering engine. These are called `surface extractors`. A 'Marching Cubes' surface extractor and a 'cubic' (Minecraft-style) surface extractor are included, and it is possible to write your own.
Each surface extractor needs to be told how to interperet your voxel type and that is done using...
Link to a page describing how to write your own voxel type and link it to a surface extractor...
PolyVox primarily handles this task of storing volume data and extracting surfaces from it. Most other aspects of you voxel application or game will need to be implemented by you (rendering, logic, physics, AI, networking, etc) though PolyVox does have a few utility classes for things like the A* algorithm on a 3D grid.