Parcourir la source

Added docs update

markcwm il y a 8 ans
Parent
commit
d901381cb4

+ 3 - 3
README.md

@@ -7,7 +7,7 @@ Blitzmax Openb3d library collection
 
 Blitzmax library wrapper for Newton dynamics v3.13. Newton v3.13 source is included in the module but can also be found on <a href="https://github.com/MADEAPPS/newton-dynamics/releases">Github</a>.
 
-The wrapper is not ready for use yet.
+The wrapper is not ready for use yet but there are a few basic examples.
 
 #### License ####
 
@@ -17,9 +17,9 @@ Both the library and wrapper are licensed with the zlib license.
 
 BlitzMax library wrapper for Assimp v3.1.1.
 
-Assimp is included with the module and uses [Boost](http://www.boost.org/users/history/) so [BaH.Boost](https://github.com/maxmods/bah.mod) is required, there is currently no Boost workaround option but bear in mind this has no threads. 
+Assimp source is included with the module and [Boost](http://www.boost.org/users/history/) is required so use [BaH.Boost](https://github.com/maxmods/bah.mod), the Boost workaround option does not seem to work but this lacks threads so is not recommended. 
 
-The wrapper is now a source import and can load meshes from streams allowing incbin or zipstream. Animations are not implemented and it does not work in 64-bit yet.
+The wrapper is now a source import again and can load meshes from streams either incbin or zipstream. For zip functionality [Koriolis.Zipstream](https://github.com/maxmods/koriolis.mod) is required. It is now working in 64-bit but animations are not yet implemented.
 
 #### License ####
 

+ 8 - 3
assimp.mod/assimp.bmx

@@ -3,16 +3,21 @@
 Strict
 
 Rem
-bbdoc: Assimp wrapper for Openb3d
-about: Assimp mesh loader and helper functions.
+bbdoc: Assimp for Openb3d
+about: Assimp mesh loader and a few helper functions. 
+To build Assimp in 64-bit use @{bmk makemods -a -w -g x64 openb3dlibs.assimp}.
+Requires BaH.Boost source and Koriolis.Zipstream module binaries, see source links below.
+To get BaH.Boost with Subversion open command-line and make sure you "cd" to bah.mod before checkout.
 End Rem
 Module Openb3dlibs.Assimp
 
 ModuleInfo "Version: 0.40"
 ModuleInfo "License: BSD-3-Clause"
 ModuleInfo "Copyright: Wrapper - 2009-2017 Peter Scheutz, Mark Mcvittie"
-ModuleInfo "Copyright: Library - 2006-2012 assimp team"
+ModuleInfo "Copyright: Library - 2006-2012 Assimp team"
 ModuleInfo "Source: https://github.com/markcwm/openb3dlibs.mod"
+ModuleInfo "Source: svn checkout https://github.com/maxmods/bah.mod/trunk/boost.mod"
+ModuleInfo "Source: https://github.com/maxmods/koriolis.mod"
 
 Import Openb3d.B3dglgraphics
 Import Openb3dlibs.Assimplib

+ 9 - 4
assimp.mod/doc/commands.html

@@ -1,4 +1,4 @@
-<html><head><title>Assimp wrapper for Openb3d reference</title>
+<html><head><title>Assimp for Openb3d reference</title>
 <link rel=stylesheet Type=text/css href='../../../../doc/bmxstyle.css'>
 </head><body>
 <table width=100% cellspacing=0><tr align=center><td class=small>&nbsp;</td>
@@ -7,8 +7,11 @@
 <td class=small width=1%><a href=#modinfo class=small>Modinfo</a></td>
 <td class=small width=1%><a href='../../../../mod/openb3dlibs.mod/assimp.mod/assimp.bmx' class=small>Source</a></td>
 <td class=small>&nbsp;</td></tr></table>
-<h1>Assimp wrapper for Openb3d</h1>
-Assimp mesh loader and helper functions.
+<h1>Assimp for Openb3d</h1>
+Assimp mesh loader and a few helper functions.
+To build Assimp in 64-bit use <b>bmk makemods -a -w -g x64 openb3dlibs.assimp</b>.
+Requires BaH.Boost source and Koriolis.Zipstream module binaries, see source links below.
+To get BaH.Boost with Subversion open command-line and make sure you "cd" to bah.mod before checkout.
 <h2><a name=functions></a>Functions Summary</h2><table class=doc width=100%>
 <tr><td class=docleft width=1%><a href=#aiEnumFiles>aiEnumFiles</a></td><td class=docright>
 Creates a list of valid files to load.
@@ -43,6 +46,8 @@ Like <a href="http://www.blitzbasic.com/b3ddocs/command.php?name=LoadMesh">LoadM
 <tr><th width=1%>Version</th><td>0.40</td></tr>
 <tr><th width=1%>License</th><td>BSD-3-Clause</td></tr>
 <tr><th width=1%>Copyright</th><td>Wrapper - 2009-2017 Peter Scheutz, Mark Mcvittie</td></tr>
-<tr><th width=1%>Copyright</th><td>Library - 2006-2012 assimp team</td></tr>
+<tr><th width=1%>Copyright</th><td>Library - 2006-2012 Assimp team</td></tr>
 <tr><th width=1%>Source</th><td>https://github.com/markcwm/openb3dlibs.mod</td></tr>
+<tr><th width=1%>Source</th><td>svn checkout https://github.com/maxmods/bah.mod/trunk/boost.mod</td></tr>
+<tr><th width=1%>Source</th><td>https://github.com/maxmods/koriolis.mod</td></tr>
 </body></html>

+ 6 - 4
assimplib.mod/assimplib.bmx

@@ -3,17 +3,19 @@
 Strict
 
 Rem
-bbdoc: Assimp
-about: Wrapper for Open Asset Import library. Requires BaH.Boost and Koriolis.Zipstream.
+bbdoc: Assimp library wrapper
+about: Wrapper for Assimp (Open Asset Import) library. Imported by assimp.mod.
+Requires BaH.Boost source and Koriolis.Zipstream module binaries, see source links below.
+To get BaH.Boost with Subversion open command-line and make sure you "cd" to bah.mod before checkout.
 End Rem
 Module Openb3dlibs.Assimplib
 
 ModuleInfo "Version: 0.40"
 ModuleInfo "License: BSD-3-Clause"
 ModuleInfo "Copyright: Wrapper - 2009-2017 Peter Scheutz, Mark Mcvittie"
-ModuleInfo "Copyright: Library - 2006-2012 assimp team"
+ModuleInfo "Copyright: Library - 2006-2012 Assimp team"
 ModuleInfo "Source: https://github.com/markcwm/openb3dlibs.mod"
-ModuleInfo "Source: https://github.com/maxmods/bah.mod/tree/master/boost.mod"
+ModuleInfo "Source: svn checkout https://github.com/maxmods/bah.mod/trunk/boost.mod"
 ModuleInfo "Source: https://github.com/maxmods/koriolis.mod"
 
 ModuleInfo "History: 0.40 Release Aug 2017 - added zipstream, 64-bit wrapper"

+ 10 - 8
assimplib.mod/doc/commands.html

@@ -1,4 +1,4 @@
-<html><head><title>Assimp reference</title>
+<html><head><title>Assimp library wrapper reference</title>
 <link rel=stylesheet Type=text/css href='../../../../doc/bmxstyle.css'>
 </head><body>
 <table width=100% cellspacing=0><tr align=center><td class=small>&nbsp;</td>
@@ -8,8 +8,10 @@
 <td class=small width=1%><a href=#modinfo class=small>Modinfo</a></td>
 <td class=small width=1%><a href='../../../../mod/openb3dlibs.mod/assimplib.mod/assimplib.bmx' class=small>Source</a></td>
 <td class=small>&nbsp;</td></tr></table>
-<h1>Assimp</h1>
-Wrapper for Open Asset Import library. Requires BaH.Boost and Koriolis.Zipstream.
+<h1>Assimp library wrapper</h1>
+Wrapper for Assimp (Open Asset Import) library. Imported by assimp.mod.
+Requires BaH.Boost source and Koriolis.Zipstream module binaries, see source links below.
+To get BaH.Boost with Subversion open command-line and make sure you "cd" to bah.mod before checkout.
 <h2><a name=functions></a>Functions Summary</h2><table class=doc width=100%>
 <tr><td class=docleft width=1%><a href=#aiGetMaterialColor>aiGetMaterialColor</a></td><td class=docright>
 Get a color (3 or 4 floats) from the material.
@@ -35,7 +37,7 @@ Reads the given file and returns its content.
 <tr><td class=docleft width=1%><a href=#aiImportFileFromMemory>aiImportFileFromMemory</a></td><td class=docright>
 Reads the given file from a given memory buffer.
 </td></tr>
-<tr><td class=docleft width=1%><a href=#aiIsExtensionSupported>aiIsExtensionSupported</a></td><td class=docright>
+<tr><td class=docleft width=1%><a href=#aiIsExtensionSupported_>aiIsExtensionSupported_</a></td><td class=docright>
 Returns the error text of the last failed import process.
 </td></tr>
 <tr><td class=docleft width=1%><a href=#aiReleaseImport>aiReleaseImport</a></td><td class=docright>
@@ -106,8 +108,8 @@ and <a href="http://assimp.sourceforge.net/lib_html/cimport_8h.html">cimport.h</
 and <a href="http://assimp.sourceforge.net/lib_html/cimport_8h.html">cimport.h</a>.</td></tr>
 </table>
 <br>
-<table class=doc width=100% cellspacing=3 id=aiIsExtensionSupported>
-<tr><td class=doctop colspan=2>Function aiIsExtensionSupported:Int( pFile$z )</td></tr>
+<table class=doc width=100% cellspacing=3 id=aiIsExtensionSupported_>
+<tr><td class=doctop colspan=2>Function aiIsExtensionSupported_:Int( pFile$z )</td></tr>
 <tr><td class=docleft width=1%>Description</td><td class=docright>Returns the error text of the last failed import process.</td></tr>
 <tr><td class=docleft width=1%>Information</td><td class=docright>See <a href="http://assimp.sourceforge.net/lib_html/class_assimp_1_1_importer.html">Assimp.cpp</a>
 and <a href="http://assimp.sourceforge.net/lib_html/cimport_8h.html">cimport.h</a>.</td></tr>
@@ -146,9 +148,9 @@ A mesh uses only a single material which is referenced by a material ID.
 <tr><th width=1%>Version</th><td>0.40</td></tr>
 <tr><th width=1%>License</th><td>BSD-3-Clause</td></tr>
 <tr><th width=1%>Copyright</th><td>Wrapper - 2009-2017 Peter Scheutz, Mark Mcvittie</td></tr>
-<tr><th width=1%>Copyright</th><td>Library - 2006-2012 assimp team</td></tr>
+<tr><th width=1%>Copyright</th><td>Library - 2006-2012 Assimp team</td></tr>
 <tr><th width=1%>Source</th><td>https://github.com/markcwm/openb3dlibs.mod</td></tr>
-<tr><th width=1%>Source</th><td>https://github.com/maxmods/bah.mod/tree/master/boost.mod</td></tr>
+<tr><th width=1%>Source</th><td>svn checkout https://github.com/maxmods/bah.mod/trunk/boost.mod</td></tr>
 <tr><th width=1%>Source</th><td>https://github.com/maxmods/koriolis.mod</td></tr>
 <tr><th width=1%>History</th><td>0.40 Release Aug 2017 - added zipstream, 64-bit wrapper</td></tr>
 <tr><th width=1%>History</th><td>0.38 Release Jul 2017 - added source wrapper, incbin streams</td></tr>