Update tsMeshFit.cpp

update addCollisionDetail documentation
This commit is contained in:
marauder2k7 2024-05-16 08:18:17 +01:00
parent 92b10df7eb
commit 280102d565

View file

@ -938,23 +938,20 @@ DefineTSShapeConstructorMethod( addCollisionDetail, bool, ( S32 size, const char
"@param type one of: box, sphere, capsule, 10-dop x, 10-dop y, 10-dop z, 18-dop, "
"26-dop, convex hulls. See the Shape Editor documentation for more details "
"about these types.\n"
"@param target geometry to fit collision mesh(es) to; either \"bounds\" (for the "
"whole shape), or the name of an object in the shape\n"
"@param target geometry to fit collision mesh(es) to; either \"bounds\" (for the whole shape), or the name of an object in the shape\n"
"@param fillMode method for filling the voxels in the volume (hulls only)\n"
"@param depth maximum split recursion depth (hulls only)\n"
"@param merge volume % threshold used to merge hulls together (hulls only)\n"
"@param minPercentage volume % error threshold (hulls only)\n"
"@param maxHulls allowed to be generated (hulls only)\n"
"@param maxVerts maximum number of vertices per hull (hulls only)\n"
"@param boxMaxError max % volume difference for a hull to be converted to a "
"box (hulls only)\n"
"@param sphereMaxError max % volume difference for a hull to be converted to "
"a sphere (hulls only)\n"
"@param capsuleMaxError max % volume difference for a hull to be converted to "
"a capsule (hulls only)\n"
"@param boxMaxError max % volume difference for a hull to be converted to a box (hulls only)\n"
"@param sphereMaxError max % volume difference for a hull to be converted to a sphere (hulls only)\n"
"@param capsuleMaxError max % volume difference for a hull to be converted to a capsule (hulls only)\n"
"@return true if successful, false otherwise\n\n"
"@tsexample\n"
"%this.addCollisionDetail( -1, \"box\", \"bounds\" );\n"
"%this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 0, 0, 0 );\n"
"%this.addCollisionDetail( -1, \"convex hulls\", \"bounds\", 4, 30, 30, 32, 50, 50, 50 );\n"
"%this.addCollisionDetail( -1, \"convex hulls\", \"bounds\",\"flood fill\", 4, 30, 30, 32, 50, 50, 50 );\n"
"@endtsexample\n" )
{
MeshFit fit( mShape );