Forráskód Böngészése

A few website fixes, format list in doxygen doc is complete now,format list in README file has been updated - OBJ was missing.

git-svn-id: https://assimp.svn.sourceforge.net/svnroot/assimp/trunk@138 67173fc5-114c-0410-ac8e-9d2fd5bffc1f
aramis_acg 17 éve
szülő
commit
4b66216e40
4 módosított fájl, 42 hozzáadás és 56 törlés
  1. 2 2
      CREDITS
  2. 8 7
      README
  3. 7 10
      doc/Doxyfile
  4. 25 37
      doc/dox.h

+ 2 - 2
CREDITS

@@ -6,8 +6,8 @@ Developers and Contributors
 The following is the list of all constributors.
 The following is the list of all constributors.
 Thanks for your help!
 Thanks for your help!
 
 
-- Andreas Geissler,
-3DS-, ACE-, DXF-, HMP-, HDO-, MD2-, MD3-, MD5-, MDC-, MDL-, NFF-, PLY-, RAW-, SDM-, LWO2- and SDL-Loader, 
+- Alexander Gessler,
+3DS-, ASE-, DXF-, HMP-, MDL-, MD2-, MD3-, MD5-, MDC-, NFF-, PLY-, STL- and LWO-Loader, 
 Configuration-Interface, AssImp-Viewer (Win32), Website (Admin and Design), admin.
 Configuration-Interface, AssImp-Viewer (Win32), Website (Admin and Design), admin.
 
 
 -Thomas Schulze,
 -Thomas Schulze,

+ 8 - 7
README

@@ -16,10 +16,9 @@ Here you can find information regarding the Asset Import Library:
 
 
 The Asset Import Library provides a lot of model formats:
 The Asset Import Library provides a lot of model formats:
 	- 3DS
 	- 3DS
-	- ACE
+	- ASE
 	- DXF
 	- DXF
 	- HMP
 	- HMP
- 	- HDO
 	- MD2
 	- MD2
  	- MD3 
  	- MD3 
 	- MD5
 	- MD5
@@ -27,10 +26,11 @@ The Asset Import Library provides a lot of model formats:
 	- MDL
 	- MDL
 	- NFF
 	- NFF
  	- PLY
  	- PLY
- 	- RAW
-	- SDM
-	- SDL
-	- LWO2
+	- STL
+	- X
+	- LWO
+	- OBJ
+	- SMD
 
 
 1.2 File structure
 1.2 File structure
 
 
@@ -44,7 +44,8 @@ are:
 	/include		Public headers.
 	/include		Public headers.
 	/lib			Static libraries.
 	/lib			Static libraries.
 	/obj			Object files.
 	/obj			Object files.
-	/port			Ports to other languages. Java is currently implemented.
+	/port			Ports to other languages.  The Java port is not finished, but
+                        the Java part of the interface is fixed.
 	/test			Unit- and regression tests.
 	/test			Unit- and regression tests.
 	/tools			Tools.
 	/tools			Tools.
 	/workspaces		Build enviroments.
 	/workspaces		Build enviroments.

+ 7 - 10
doc/Doxyfile

@@ -1,4 +1,4 @@
-# Doxyfile 1.5.4
+# Doxyfile 1.5.3
 
 
 #---------------------------------------------------------------------------
 #---------------------------------------------------------------------------
 # Project related configuration options
 # Project related configuration options
@@ -11,9 +11,9 @@ CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English
 OUTPUT_LANGUAGE        = English
 BRIEF_MEMBER_DESC      = YES
 BRIEF_MEMBER_DESC      = YES
 REPEAT_BRIEF           = YES
 REPEAT_BRIEF           = YES
-ABBREVIATE_BRIEF       = "The $name class     " \
-                         "The $name widget     " \
-                         "The $name file     " \
+ABBREVIATE_BRIEF       = "The $name class      " \
+                         "The $name widget      " \
+                         "The $name file      " \
                          is \
                          is \
                          provides \
                          provides \
                          specifies \
                          specifies \
@@ -40,10 +40,8 @@ OPTIMIZE_OUTPUT_FOR_C  = NO
 OPTIMIZE_OUTPUT_JAVA   = NO
 OPTIMIZE_OUTPUT_JAVA   = NO
 BUILTIN_STL_SUPPORT    = YES
 BUILTIN_STL_SUPPORT    = YES
 CPP_CLI_SUPPORT        = NO
 CPP_CLI_SUPPORT        = NO
-SIP_SUPPORT            = NO
 DISTRIBUTE_GROUP_DOC   = NO
 DISTRIBUTE_GROUP_DOC   = NO
 SUBGROUPING            = YES
 SUBGROUPING            = YES
-TYPEDEF_HIDES_STRUCT   = NO
 #---------------------------------------------------------------------------
 #---------------------------------------------------------------------------
 # Build related configuration options
 # Build related configuration options
 #---------------------------------------------------------------------------
 #---------------------------------------------------------------------------
@@ -82,13 +80,12 @@ WARNINGS               = YES
 WARN_IF_UNDOCUMENTED   = YES
 WARN_IF_UNDOCUMENTED   = YES
 WARN_IF_DOC_ERROR      = YES
 WARN_IF_DOC_ERROR      = YES
 WARN_NO_PARAMDOC       = NO
 WARN_NO_PARAMDOC       = NO
-WARN_FORMAT            = "$file:$line: $text     "
+WARN_FORMAT            = "$file:$line: $text      "
 WARN_LOGFILE           = 
 WARN_LOGFILE           = 
 #---------------------------------------------------------------------------
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 # configuration options related to the input files
 #---------------------------------------------------------------------------
 #---------------------------------------------------------------------------
 INPUT                  = ../include/ \
 INPUT                  = ../include/ \
-                         ../code/ \
                          ../doc/
                          ../doc/
 INPUT_ENCODING         = UTF-8
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.c \
 FILE_PATTERNS          = *.c \
@@ -159,8 +156,8 @@ HTML_STYLESHEET        =
 HTML_ALIGN_MEMBERS     = YES
 HTML_ALIGN_MEMBERS     = YES
 GENERATE_HTMLHELP      = NO
 GENERATE_HTMLHELP      = NO
 HTML_DYNAMIC_SECTIONS  = NO
 HTML_DYNAMIC_SECTIONS  = NO
-CHM_FILE               = 
-HHC_LOCATION           = 
+CHM_FILE               = AssimpDoc.chm
+HHC_LOCATION           = "C:/Program Files/HTML Help Workshop/hhc.exe"
 GENERATE_CHI           = NO
 GENERATE_CHI           = NO
 BINARY_TOC             = NO
 BINARY_TOC             = NO
 TOC_EXPAND             = NO
 TOC_EXPAND             = NO

+ 25 - 37
doc/dox.h

@@ -1,6 +1,6 @@
 /** @file General documentation built from a doxygen comment */
 /** @file General documentation built from a doxygen comment */
 
 
-/** @mainpage ASSIMP - The open asset import library
+/** @mainpage ASSIMP - The Open Asset Import Library
 @section intro Introduction
 @section intro Introduction
 
 
 ASSIMP is a library to load and process geometric scenes from various data formats. It is taylored at typical game 
 ASSIMP is a library to load and process geometric scenes from various data formats. It is taylored at typical game 
@@ -11,42 +11,30 @@ processing steps to the imported data such as conversion to indexed meshes, calc
 or conversion from right-handed to left-handed coordinate systems.
 or conversion from right-handed to left-handed coordinate systems.
 
 
 ASSIMP is able to import the following file formats into your application:
 ASSIMP is able to import the following file formats into your application:
-
-<b>AutoDesk 3D Studio 4/5 (.3ds).</b> The old native format of 3DS max, now still supported and
-widely used.
-<br>
-<b>AutoDesk 3D Studio ASCII Export (.ase).</b> Text format used by 3DS max. Supports bone animations
-and highly complex materials.
-<br>
-<b>DirectX (.x)</b> A file format that can easily be read by D3DX and that is supported 
-as export format by most 3D modellers. ASSIMP supports both binary and ASCII X-Files.
-<br>
-<b>Stanford Polygon (.ply)</b> File format developed by the university of
-stanford. Thanks to its flexibility it often used for scientific purposes. Supported by ASSIMP
-are ASCII and binary PLY files, both LittleEndian and BigEndian.
-<br>
-<b>WaveFront Object (.obj)</b> File format that is widely used to exchange asset data
-between different applications.
-<br>
-<b>Milkshape 3D (.ms3d)</b> Native file format of the well-known modeller Milkshape 3D. 
-ASSIMP provides full support for bone animations contained in ms3d files.
-<br>
-<b>Quake I (.mdl)</b> The file format that was once used by the first part of the
-quake series. ASSIMP provides full support for loading embedded textures from Quake models.
-<br>
-<b>3D GameStudio (.mdl)</b> The file format of Conitecs 3D GameStudio tool suite.
-Used by the freeware modelling tool MED. ASSIMP provides full support for all types of
-3D GameStudio MDL files: <i>MDL3, MDL4, MDL5, MDL6, MDL7</i>. Bone animations are supported.
-<br>
-<b>Half-Life/CS:S (.mdl, .smd)</b> The file formats used in half life.
-<b>Quake II (.md2)/ Quake III (.md3)</b> Used by many free models on the web, support for
-Quake 2's and Quake 3's file formats is a must-have for each game engine. Quake 4 is
-existing but not widely used. However, it is supported by ASSIMP (and RavenSoft .mdr is supported, too)
-<br>
-<b>Doom 3 (.md5)</b> The well-known native file format of the Doom 3 engine, used in
-many games. Supports bone animation and advanced material settings.
-
-
+<hr>
+<b>3D Studio Max 3DS</b> ( <i>*.3ds</i> ) <br>
+<b>3D Studio Max ASE</b> ( <i>*.ase</i> ) <br>
+<b>Wavefront Object</b> ( <i>*.obj</i> ) <br>
+<b>Stanford Polygon Library</b> ( <i>*.ply</i> ) <br>
+<b>Milkshape 3D</b> ( <i>*.ms3d</i> ) <sup>1</sup><br>
+<b>AutoCAD DXF</b> ( <i>*.dxf</i> ) <sup>2</sup><br>
+<b>Neutral File Format</b> ( <i>*.nff</i> ) <br>
+<b>LightWave</b> ( <i>*.lwo</i> ) <br>
+<b>Valve Model</b> ( <i>*.smd,*.vta</i> ) <sup>3</sup> <br>
+<b>Quake I</b> ( <i>*.mdl</i> ) <br>
+<b>Quake II</b> ( <i>*.md2</i> ) <br>
+<b>Quake III</b> ( <i>*.md3</i> ) <br>
+<b>Return to Castle Wolfenstein</b> ( <i>*.mdc</i> )<br>
+<b>EliteForce II</b> ( <i>*.mdr</i> )<sup>1</sup><br>
+<b>Doom 3</b> ( <i>*.md5</i> ) <sup>3</sup> <br>
+<b>DirectX X </b> ( <i>*.x</i> ). <br>		
+<b>3D GameStudio </b> ( <i>*.mdl</i> ) <br>
+<b>3D GameStudio Terrain</b> ( <i>*.hmp</i> )<br>(<i>All sub versions of 3D GameStudio models/terrains are supported: mdl2, mdl3, mdl4, mdl5, mdl7, hmp4, hmp5, hmp7</i>)<br><br>
+
+<sup>1</sup> Under development, but not included in the current beta release<br/>
+<sup>2</sup> Limited support<br/>
+<sup>3</sup> Animation support untested<br/>
+<hr>
 
 
 ASSIMP is independent of the Operating System by nature, providing a C++ interface for easy integration 
 ASSIMP is independent of the Operating System by nature, providing a C++ interface for easy integration 
 with game engines and a C interface to allow bindings to other programming languages. At the moment the library runs 
 with game engines and a C interface to allow bindings to other programming languages. At the moment the library runs