Browse Source

Exporter: update documentation.

acgessler 12 years ago
parent
commit
faaea5224f
2 changed files with 13 additions and 1 deletions
  1. 7 1
      include/assimp/Exporter.hpp
  2. 6 0
      include/assimp/cexport.h

+ 7 - 1
include/assimp/Exporter.hpp

@@ -198,7 +198,13 @@ public:
 	 *   redundant as exporters would apply them anyhow. A good example 
 	 *   redundant as exporters would apply them anyhow. A good example 
 	 *   is triangulation - whilst you can enforce it by specifying
 	 *   is triangulation - whilst you can enforce it by specifying
 	 *   the #aiProcess_Triangulate flag, most export formats support only
 	 *   the #aiProcess_Triangulate flag, most export formats support only
-	 *  triangulate data so they would run the step even if it wasn't requested.
+	 *   triangulate data so they would run the step even if it wasn't requested.
+	 *
+	 *   If assimp detects that the input scene was directly taken from the importer side of 
+     *   the library (i.e. not copied using aiCopyScene and potetially modified afterwards), 
+     *   any postprocessing steps already applied to the scene will not be applied again, unless
+     *   they show non-idempotent behaviour (#aiProcess_MakeLeftHanded, #aiProcess_FlipUVs and 
+     *   #aiProcess_FlipWindingOrder).
 	 * @return AI_SUCCESS if everything was fine. 
 	 * @return AI_SUCCESS if everything was fine. 
 	 * @note Use aiCopyScene() to get a modifiable copy of a previously
 	 * @note Use aiCopyScene() to get a modifiable copy of a previously
 	 *   imported scene.*/
 	 *   imported scene.*/

+ 6 - 0
include/assimp/cexport.h

@@ -143,6 +143,12 @@ ASSIMP_API void aiFreeScene(const C_STRUCT aiScene* pIn);
 *   is triangulation - whilst you can enforce it by specifying
 *   is triangulation - whilst you can enforce it by specifying
 *   the #aiProcess_Triangulate flag, most export formats support only
 *   the #aiProcess_Triangulate flag, most export formats support only
 *   triangulate data so they would run the step anyway.
 *   triangulate data so they would run the step anyway.
+*
+*   If assimp detects that the input scene was directly taken from the importer side of 
+*   the library (i.e. not copied using aiCopyScene and potetially modified afterwards), 
+*   any postprocessing steps already applied to the scene will not be applied again, unless
+*   they show non-idempotent behaviour (#aiProcess_MakeLeftHanded, #aiProcess_FlipUVs and 
+*   #aiProcess_FlipWindingOrder).
 * @return a status code indicating the result of the export
 * @return a status code indicating the result of the export
 * @note Use aiCopyScene() to get a modifiable copy of a previously
 * @note Use aiCopyScene() to get a modifiable copy of a previously
 *   imported scene.
 *   imported scene.