Blast 1.1 release (windows / linux)

see docs/release_notes.txt for details

1 files changed, 38 insertions, 7 deletions

diff --git a/docs/_source/ext_authoring.txt b/docs/_source/ext_authoring.txt
index 9b9cbf9..aeae4e8 100644
--- a/docs/_source/ext_authoring.txt
+++ b/docs/_source/ext_authoring.txt
@@ -1,31 +1,39 @@
 /*! \page pageextauthoring Asset Authoring (NvBlastExtAuthoring)
 
-Blast extensions provide tools for creation Blast asset from provided geometry mesh.
+The Authoring extension provides tools for creation of a Blast&tm; asset from a provided mesh.
 
 There are three tools for creation Blast asset.
 
-First one is FractureTool which is used for fracturing input mesh. It supports Voronoi fracturing method and slicing.
-Internal surface of output chunks can be tesselated and noise can be applied to it. 
-Slicing method supports slicing with noisy slicing surface, which makes possible creation of jagged slicing line. Noisy slicing is switched on by 
-setting non-zero noise amplitude in slicing parameters.
+First one is FractureTool (see NvBlastExtAuthoringFractureTool.h) which is used to fracture an input mesh. It supports Voronoi fracturing and also
+simple slicing.  Internal surfaces of output chunks can be tesselated and noise can be applied to them.  The slicing method supports slicing with
+a noisy slicing surface, which allows the creation of a jagged slicing line.  Noisy slicing is switched on by setting a non-zero noise amplitude
+in slicing parameters (Nv::Blast::SlicingConfiguration).
+
+<br>
+\section fracturetool FractureTool
 
 Nv::Blast::FractureTool supports two types of output:
 
-1) Array of triangles - tool fills provided array with triangles of chunk, ID of chunk should be provided.
+1) Array of triangles - the tool fills provided array with triangles of chunk, ID of chunk should be provided.
 
 2) Buffered output - tool fills provided array with vertices, and another array of arrays with indices. Indices form triplets of vertices of triangle.
 
+<br>
+\section convexmeshbuilder ConvexMeshBuilder
+
 Nv::Blast::ConvexMeshBuilder is tool for creation collision geometry for physics engine. It recieves mesh vertices, and returns convex hull of that vertices. If creation of convex hull fails,
 tool creates collision geometry as a bounding box of provided vertices.
 
 Tool provides method to trim convex hulls against each other. It can be used along with noisy slicing to avoid "explosive" behavior due to penetration of neighboor collision hulls into each other.
 As a drawback penetration of render meshes into each other is possible due to trimmed collision geometry. 
 
+<br>
+\section bondgenerator BondGenerator
 
 Nv::Blast::BlastBondGenerator tool for creation Blast Bond descriptors from provided geometry data. 
 It has separate method which is optimized for working FractureTool. 
 \code
-	int32_t Nv::Blast::BlastBondGenerator::buildDescFromInternalFracture(FractureTool* tool, const std::vector<bool>& chunkIsSupport, std::vector<NvBlastBondDesc>& resultBondDescs, std::vector<NvBlastChunkDesc>& resultChunkDescriptors);
+int32_t Nv::Blast::BlastBondGenerator::buildDescFromInternalFracture(FractureTool* tool, const std::vector<bool>& chunkIsSupport, std::vector<NvBlastBondDesc>& resultBondDescs, std::vector<NvBlastChunkDesc>& resultChunkDescriptors);
 \endcode
 
 Other methods can work with prefractured mesh created in Third party tool, and can be used for converting prefractured models to Blast assets.
@@ -36,6 +44,29 @@ Nv::Blast::BlastBondGenerator supports two modes of NvBlastBond data generation:
 
 2) Average - this mode uses approximations of interface, and can be used for gathering NvBlastBond data for assets, where chunks penetrate each other, e.g. chunks with noise.
 
+<br>
+\section meshcleaner MeshCleaner
+
+Nv::Blast::MeshCleaner can be used to remove self intersections and open edges in interior of mesh, making it more likely to fracture well.
+
+To use it, create a MeshCleaner using
+
+\code
+Nv::Blast::MeshCleaner* cleaner = NvBlastExtAuthoringCreateMeshCleaner();
+\endcode
+
+Given an Nv::Blast::Mesh called "mesh," simply call
+
+\code
+Nv::Blast::Mesh* newMesh = cleaner->cleanMesh(mesh);
+\endcode
+
+If successful, newMesh will be a valid pointer to the cleaned mesh.  Otherwise, newMesh will be NULL.
+
+When done, release using
+\code
+cleaner->release();
+\endcode
 
 <br>
 */