v4games
/
assimp
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor doc fixes. 

git-svn-id: https://assimp.svn.sourceforge.net/svnroot/assimp/trunk@335 67173fc5-114c-0410-ac8e-9d2fd5bffc1f
pull/1/head
aramis_acg 2009-02-07 11:23:22 +00:00
parent 9fe1652c2b
commit 8148ff36c0
3 changed files with 96 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
code/BaseProcess.h
View File

@ -70,6 +70,7 @@ public:
{} {}
}; };
//! Represents data that is allocated on the heap, thus needs to be deleted
template <typename T> template <typename T>
struct THeapData : public Base struct THeapData : public Base
{ {
@ -84,6 +85,7 @@ public:
T* data; T* data;
}; };
//! Represents static, by-value data not allocated on the heap
template <typename T> template <typename T>
struct TStaticData : public Base struct TStaticData : public Base
{ {
@ -97,16 +99,19 @@ public:
T data; T data;
}; };
// some typedefs for cleaner code
typedef unsigned int KeyType; typedef unsigned int KeyType;
typedef std::map<KeyType, Base*> PropertyMap; typedef std::map<KeyType, Base*> PropertyMap;
public: public:
//! Destructor
~SharedPostProcessInfo() ~SharedPostProcessInfo()
{ {
Clean(); Clean();
} }
//! Remove all stored properties from the table
void Clean() void Clean()
{ {
// invoke the virtual destructor for all stored properties // invoke the virtual destructor for all stored properties
@ -118,21 +123,22 @@ public:
pmap.clear(); pmap.clear();
} }
//! Add a heap property to the list
template <typename T> template <typename T>
inline void AddProperty( const char* name, T* in ) void AddProperty( const char* name, T* in ){
{
AddProperty(name,(Base*)new THeapData<T>(in)); AddProperty(name,(Base*)new THeapData<T>(in));
} }
//! Add a static by-value property to the list
template <typename T> template <typename T>
inline void AddProperty( const char* name, T in ) void AddProperty( const char* name, T in ){
{
AddProperty(name,(Base*)new TStaticData<T>(in)); AddProperty(name,(Base*)new TStaticData<T>(in));
} }
//! Get a heap property
template <typename T> template <typename T>
inline bool GetProperty( const char* name, T*& out ) const bool GetProperty( const char* name, T*& out ) const
{ {
THeapData<T>* t; THeapData<T>* t;
GetProperty(name,(Base*&)t); GetProperty(name,(Base*&)t);
@ -145,8 +151,9 @@ public:
return true; return true;
} }
//! Get a static, by-value property
template <typename T> template <typename T>
inline bool GetProperty( const char* name, T& out ) const bool GetProperty( const char* name, T& out ) const
{ {
TStaticData<T>* t; TStaticData<T>* t;
GetProperty(name,(Base*&)t); GetProperty(name,(Base*&)t);
@ -155,23 +162,47 @@ public:
return true; return true;
} }
inline void RemoveProperty( const char* name) { //! Remove a property of a specific type
void RemoveProperty( const char* name) {
SetGenericPropertyPtr<Base>(pmap,name,NULL); SetGenericPropertyPtr<Base>(pmap,name,NULL);
} }
private: private:
inline void AddProperty( const char* name, Base* data) { //! Internal
void AddProperty( const char* name, Base* data) {
SetGenericPropertyPtr<Base>(pmap,name,data); SetGenericPropertyPtr<Base>(pmap,name,data);
} }
inline void GetProperty( const char* name, Base*& data) const { //! Internal
void GetProperty( const char* name, Base*& data) const {
data = GetGenericProperty<Base*>(pmap,name,NULL); data = GetGenericProperty<Base*>(pmap,name,NULL);
} }
private:
//! Map of all stored properties
PropertyMap pmap; PropertyMap pmap;
}; };
#if 0
// ---------------------------------------------------------------------------
/** @brief Represents a dependency table for a postprocessing steps.
*
* For future use.
*/
struct PPDependencyTable
{
unsigned int execute_me_before_these;
unsigned int execute_me_after_these;
unsigned int only_if_these_are_not_specified;
unsigned int mutually_exclusive_with;
};
#endif
#define AI_SPP_SPATIAL_SORT "$Spat" #define AI_SPP_SPATIAL_SORT "$Spat"
// --------------------------------------------------------------------------- // ---------------------------------------------------------------------------

BIN
doc/lib_html/AssimpDoc.chm
View File

Binary file not shown.

93
include/aiPostProcess.h
View File

@ -53,7 +53,7 @@ extern "C" {
/** Defines the flags for all possible post processing steps. */ /** Defines the flags for all possible post processing steps. */
enum aiPostProcessSteps enum aiPostProcessSteps
{ {
/** Calculates the tangents and bitangents for the imported meshes. Does nothing /** <hr>Calculates the tangents and bitangents for the imported meshes. Does nothing
* if a mesh does not have normals. You might want this post processing step to be * if a mesh does not have normals. You might want this post processing step to be
* executed if you plan to use tangent space calculations such as normal mapping * executed if you plan to use tangent space calculations such as normal mapping
* applied to the meshes. There exists a configuration option, * applied to the meshes. There exists a configuration option,
@ -62,13 +62,13 @@ enum aiPostProcessSteps
*/ */
aiProcess_CalcTangentSpace = 1, aiProcess_CalcTangentSpace = 1,
/** Identifies and joins identical vertex data sets within all imported meshes. /** <hr>Identifies and joins identical vertex data sets within all imported meshes.
* After this step is run each mesh does contain only unique vertices anymore, * After this step is run each mesh does contain only unique vertices anymore,
* so a vertex is possibly used by multiple faces. You usually want * so a vertex is possibly used by multiple faces. You usually want
* to use this post processing step.*/ * to use this post processing step.*/
aiProcess_JoinIdenticalVertices = 2, aiProcess_JoinIdenticalVertices = 2,
/** Converts all the imported data to a left-handed coordinate space such as /** <hr>Converts all the imported data to a left-handed coordinate space such as
* the DirectX coordinate system. By default the data is returned in a right-handed * the DirectX coordinate system. By default the data is returned in a right-handed
* coordinate space which for example OpenGL prefers. In this space, +X points to the * coordinate space which for example OpenGL prefers. In this space, +X points to the
* right, +Y points towards the viewer and and +Z points upwards. In the DirectX * right, +Y points towards the viewer and and +Z points upwards. In the DirectX
@ -77,7 +77,7 @@ enum aiPostProcessSteps
*/ */
aiProcess_ConvertToLeftHanded = 4, aiProcess_ConvertToLeftHanded = 4,
/** Triangulates all faces of all meshes. By default the imported mesh data might /** <hr>Triangulates all faces of all meshes. By default the imported mesh data might
* contain faces with more than 3 indices. For rendering a mesh you usually need * contain faces with more than 3 indices. For rendering a mesh you usually need
* all faces to be triangles. This post processing step splits up all higher faces * all faces to be triangles. This post processing step splits up all higher faces
* to triangles. This step won't modify line and point primitives. If you need * to triangles. This step won't modify line and point primitives. If you need
@ -88,7 +88,7 @@ enum aiPostProcessSteps
*/ */
aiProcess_Triangulate = 8, aiProcess_Triangulate = 8,
/** Removes some parts of the data structure (animations, materials, /** <hr>Removes some parts of the data structure (animations, materials,
* light sources, cameras, textures, vertex components). * light sources, cameras, textures, vertex components).
* *
* The components to be removed are specified in a separate * The components to be removed are specified in a separate
@ -104,33 +104,36 @@ enum aiPostProcessSteps
*/ */
aiProcess_RemoveComponent = 0x10, aiProcess_RemoveComponent = 0x10,
/** Generates normals for all faces of all meshes. The normals are shared /** <hr>Generates normals for all faces of all meshes. The normals are shared
* between the three vertices of a face. This is ignored * between the three vertices of a face. This is ignored
* if normals are already existing. This flag may not be specified together * if normals are already existing. This flag may not be specified together
* with aiProcess_GenSmoothNormals * with aiProcess_GenSmoothNormals.
*/ */
aiProcess_GenNormals = 0x20, aiProcess_GenNormals = 0x20,
/** Generates smooth normals for all vertices in the mesh. This is ignored /** <hr>Generates smooth normals for all vertices in the mesh. This is ignored
* if normals are already existing. This flag may not be specified together * if normals are already existing. This flag may not be specified together
* with aiProcess_GenNormals. There exists a configuration option, * with aiProcess_GenNormals. There's a configuration option,
* #AI_CONFIG_PP_GSN_MAX_SMOOTHING_ANGLE that allows you to specify * #AI_CONFIG_PP_GSN_MAX_SMOOTHING_ANGLE that allows you to specify
* an angle maximum for the step. * an angle maximum for the normal smoothing algorithm. Normals exceeding
* this limit are not smoothed, resulting in a a 'hard' seam between two faces.
*/ */
aiProcess_GenSmoothNormals = 0x40, aiProcess_GenSmoothNormals = 0x40,
/** Splits large meshes into submeshes /** <hr>Splits large meshes into submeshes
* This is quite useful for realtime rendering where the number of vertices * This is quite useful for realtime rendering where the number of triangles
* is usually limited by the video driver. * to be maximally rendered in one drawcall is usually limited by the video driver.
* The maximum vertex buffer size suffers from limitations, too. Both
* requirements are met with this step: you can specify both a triangle and vertex
* limit for a single mesh.
* *
* The split limits can be set through aiSetVertexSplitLimit() and * The split limits can be set through the <tt>AI_CONFIG_PP_SLM_VERTEX_LIMIT</tt>
* aiSetTriangleSplitLimit(). The default values for this are defined * and <tt>AI_CONFIG_PP_SLM_TRIANGLE_LIMIT</tt> The default values are
* in the internal SplitLargeMeshes.h header as AI_SLM_DEFAULT_MAX_VERTICES * <tt>AI_SLM_DEFAULT_MAX_VERTICES</tt> and <tt>AI_SLM_DEFAULT_MAX_TRIANGLES</tt>.
* and AI_SLM_DEFAULT_MAX_TRIANGLES.
*/ */
aiProcess_SplitLargeMeshes = 0x80, aiProcess_SplitLargeMeshes = 0x80,
/** Removes the node graph and pre-transforms all vertices with /** <hr>Removes the node graph and pre-transforms all vertices with
* the local transformation matrices of their nodes. The output * the local transformation matrices of their nodes. The output
* scene does still contain nodes, however, there is only a * scene does still contain nodes, however, there is only a
* root node with children, each one referencing only one mesh, * root node with children, each one referencing only one mesh,
@ -146,7 +149,7 @@ enum aiPostProcessSteps
*/ */
aiProcess_PreTransformVertices = 0x100, aiProcess_PreTransformVertices = 0x100,
/** Limits the number of bones simultaneously affecting a single vertex /** <hr>Limits the number of bones simultaneously affecting a single vertex
* to a maximum value. If any vertex is affected by more than that number * to a maximum value. If any vertex is affected by more than that number
* of bones, the least important vertex weights are removed and the remaining * of bones, the least important vertex weights are removed and the remaining
* vertex weights are renormalized so that the weights still sum up to 1. * vertex weights are renormalized so that the weights still sum up to 1.
@ -159,7 +162,7 @@ enum aiPostProcessSteps
*/ */
aiProcess_LimitBoneWeights = 0x200, aiProcess_LimitBoneWeights = 0x200,
/** Validates the aiScene data structure before it is returned. /** <hr>Validates the aiScene data structure before it is returned.
* This makes sure that all indices are valid, all animations and * This makes sure that all indices are valid, all animations and
* bones are linked correctly, all material are correct and so on ... * bones are linked correctly, all material are correct and so on ...
* This is primarily intended for our internal debugging stuff, * This is primarily intended for our internal debugging stuff,
@ -168,7 +171,7 @@ enum aiPostProcessSteps
*/ */
aiProcess_ValidateDataStructure = 0x400, aiProcess_ValidateDataStructure = 0x400,
/** Reorders triangles for vertex cache locality and thus better performance. /** <hr>Reorders triangles for vertex cache locality and thus better performance.
* The step tries to improve the ACMR (average post-transform vertex cache * The step tries to improve the ACMR (average post-transform vertex cache
* miss ratio) for all meshes. The step runs in O(n) and is roughly * miss ratio) for all meshes. The step runs in O(n) and is roughly
* basing on the algorithm described in this paper: * basing on the algorithm described in this paper:
@ -176,7 +179,7 @@ enum aiPostProcessSteps
*/ */
aiProcess_ImproveCacheLocality = 0x800, aiProcess_ImproveCacheLocality = 0x800,
/** Searches for redundant materials and removes them. /** <hr>Searches for redundant materials and removes them.
* *
* This is especially useful in combination with the PretransformVertices * This is especially useful in combination with the PretransformVertices
* and OptimizeGraph steps. Both steps join small meshes, but they * and OptimizeGraph steps. Both steps join small meshes, but they
@ -184,7 +187,7 @@ enum aiPostProcessSteps
*/ */
aiProcess_RemoveRedundantMaterials = 0x1000, aiProcess_RemoveRedundantMaterials = 0x1000,
/** This step tries to determine which meshes have normal vectors /** <hr>This step tries to determine which meshes have normal vectors
* that are facing inwards. The algorithm is simple but effective: * that are facing inwards. The algorithm is simple but effective:
* the bounding box of all vertices + their normals is compared against * the bounding box of all vertices + their normals is compared against
* the volume of the bounding box of all vertices without their normals. * the volume of the bounding box of all vertices without their normals.
@ -196,7 +199,7 @@ enum aiPostProcessSteps
aiProcess_FixInfacingNormals = 0x2000, aiProcess_FixInfacingNormals = 0x2000,
/** This step splits meshes with more than one primitive type in /** <hr>This step splits meshes with more than one primitive type in
* homogeneous submeshes. * homogeneous submeshes.
* *
* The step is executed after the triangulation step. After the step * The step is executed after the triangulation step. After the step
@ -209,28 +212,44 @@ enum aiPostProcessSteps
*/ */
aiProcess_SortByPType = 0x8000, aiProcess_SortByPType = 0x8000,
/** This step searches all meshes for degenerated primitives and /** <hr>This step searches all meshes for degenerated primitives and
* converts them to proper lines or points. * converts them to proper lines or points.
* *
* A face is degenerated if one or more of its points are identical. * A face is degenerated if one or more of its points are identical.
* To have the degenerated not only detected and collapsed but also * To have the degenerated stuff not only detected and collapsed but
* removed use the following procedure: * also removed, try one of the following procedures:
* <br><b>1.</b> (if you support lines&points for rendering but don't
* want the degenerates)</br>
* <ul> * <ul>
* <li>Specify the aiProcess_FindDegenerates flag. * <li>Specify the #aiProcess_FindDegenerates flag.
* </li> * </li>
* <li>Specify the aiProcess_SortByPType flag. This moves line and * <li>Set the <tt>AI_CONFIG_PP_FD_REMOVE</tt> option to 1. This will
* point primitives to separate meshes * cause the step to remove degenerated triangles rom the import
* as soon as they're detected. They won't pass any further
* pipeline steps.
* </li> * </li>
* <li>Set the AI_CONFIG_PP_SBP_REMOVE option to aiPrimitiveType_POINTS * </ul>
* | aiPrimitiveType_LINES to cause SortByPType to reject point * <br><b>2.</b>(if you don't support lines&points at all ...)</br>
* <ul>
* <li>Specify the #aiProcess_FindDegenerates flag.
* </li>
* <li>Specify the #aiProcess_SortByPType flag. This moves line and
* point primitives to separate meshes.
* </li>
* <li>Set the <tt>AI_CONFIG_PP_SBP_REMOVE</tt> option to
* @code aiPrimitiveType_POINTS | aiPrimitiveType_LINES
* @endcode to cause SortByPType to reject point
* and line meshes from the scene. * and line meshes from the scene.
* </li> * </li>
* </ul> * </ul>
* * @note Degenerated polygons are not necessarily evil and that's why
* they're not removed by default. There are several file formats which
* don't support lines or points ... some exporters bypass the
* format specification and write them as degenerated triangle instead.
*/ */
aiProcess_FindDegenerates = 0x10000, aiProcess_FindDegenerates = 0x10000,
/** This step searches all meshes for invalid data, such as zeroed /** <hr>This step searches all meshes for invalid data, such as zeroed
* normal vectors or invalid UV coords and removes them. * normal vectors or invalid UV coords and removes them.
* *
* This is especially useful for normals. If they are invalid, and * This is especially useful for normals. If they are invalid, and
@ -240,7 +259,7 @@ enum aiPostProcessSteps
*/ */
aiProcess_FindInvalidData = 0x20000, aiProcess_FindInvalidData = 0x20000,
/** This step converts non-UV mappings (such as spherical or /** <hr>This step converts non-UV mappings (such as spherical or
* cylindrical) to proper UV mapping channels. * cylindrical) to proper UV mapping channels.
* *
* Most applications will support UV mapping only, so you will * Most applications will support UV mapping only, so you will
@ -248,7 +267,7 @@ enum aiPostProcessSteps
*/ */
aiProcess_GenUVCoords = 0x40000, aiProcess_GenUVCoords = 0x40000,
/** This step pre-transforms UV coordinates by the UV transformations /** <hr>This step pre-transforms UV coordinates by the UV transformations
* (such as scalings or rotations). * (such as scalings or rotations).
* *
* UV transformations are specified per-texture - see the * UV transformations are specified per-texture - see the
@ -263,7 +282,7 @@ enum aiPostProcessSteps
aiProcess_TransformUVCoords = 0x80000, aiProcess_TransformUVCoords = 0x80000,
/** This step searches for duplicate meshes and replaces duplicates /** <hr>This step searches for duplicate meshes and replaces duplicates
* with references to the first mesh. * with references to the first mesh.
* *
* todo ... add more doc * todo ... add more doc