OgreImporter: Rewrote documentation for AI_CONFIG_IMPORT_OGRE_MATERIAL_FILE and AI_CONFIG_IMPORT_OGRE_TEXTURETYPE_FROM_FILENAME to reflect the current logic. And to be honest the earlier one was very confusing english and was not very clear what is happening with these config options.

pull/266/head
Jonne Nauha 2014-05-01 16:35:34 +03:00
parent f98584cdea
commit 6ea07f39e1
1 changed files with 21 additions and 13 deletions

View File

@ -801,29 +801,37 @@ enum aiComponent
#define AI_CONFIG_IMPORT_IRR_ANIM_FPS \
"IMPORT_IRR_ANIM_FPS"
// ---------------------------------------------------------------------------
/** @brief Ogre Importer will try to load this Materialfile.
/** @brief Ogre Importer will try to find referenced materials from this file.
*
* Ogre Meshes contain only the MaterialName, not the MaterialFile. If there
* is no material file with the same name as the material, Ogre Importer will
* try to load this file and search the material in it.
* Ogre meshes reference with material names, this does not tell Assimp the file
* where it is located in. Assimp will try to find the source file in the following
* order: <material-name>.material, <mesh-filename-base>.material and
* lastly the material name defined by this config property.
* <br>
* Property type: String. Default value: guessed.
* Property type: String. Default value: n/a.
*/
#define AI_CONFIG_IMPORT_OGRE_MATERIAL_FILE "IMPORT_OGRE_MATERIAL_FILE"
#define AI_CONFIG_IMPORT_OGRE_MATERIAL_FILE \
"IMPORT_OGRE_MATERIAL_FILE"
// ---------------------------------------------------------------------------
/** @brief Ogre Importer detect the texture usage from its filename
/** @brief Ogre Importer detect the texture usage from its filename.
*
* Normally, a texture is loaded as a colormap, if no target is specified in the
* materialfile. Is this switch is enabled, texture names ending with _n, _l, _s
* are used as normalmaps, lightmaps or specularmaps.
* Ogre material texture units do not define texture type, the textures usage
* depends on the used shader or Ogres fixed pipeline. If this config property
* is true Assimp will try to detect the type from the textures filename postfix:
* _n, _nrm, _nrml, _normal, _normals and _normalmap for normal map, _s, _spec,
* _specular and _specularmap for specular map, _l, _light, _lightmap, _occ
* and _occlusion for light map, _disp and _displacement for displacement map.
* The matching is case insensitive. Post fix is taken between last "_" and last ".".
* Default behavior is to detect type from lower cased texture unit name by
* matching against: normalmap, specularmap, lightmap and displacementmap.
* For both cases if no match is found aiTextureType_DIFFUSE is used.
* <br>
* Property type: Bool. Default value: false.
*/
#define AI_CONFIG_IMPORT_OGRE_TEXTURETYPE_FROM_FILENAME "IMPORT_OGRE_TEXTURETYPE_FROM_FILENAME"
#define AI_CONFIG_IMPORT_OGRE_TEXTURETYPE_FROM_FILENAME \
"IMPORT_OGRE_TEXTURETYPE_FROM_FILENAME"
/** @brief Specifies whether the IFC loader skips over IfcSpace elements.
*