Assimp: config.h File Reference

Specifies whether the Android JNI asset extraction is supported.

Turn on this option if you want to manage assets in native Android application without having to keep the internal directory and asset manager pointer.

Specifies the xfile use double for real values of float.

Property type: Bool. Default value: false.

A hint to assimp to favour speed against import quality.

Enabling this option may result in faster loading, but it needn't. It represents just a hint to loaders and post-processing steps to use faster code paths, if possible. This property is expected to be an integer, != 0 stands for true. The default value is 0.

Enables time measurements.

If enabled, measures the time needed for each part of the loading process (i.e. IO time, importing, postprocessing, ..) and dumps these timings to the DefaultLogger. See the Performance Page for more information on this topic.

Property type: bool. Default value: false.

Configures whether the AC loader evaluates subdivision surfaces ( indicated by the presence of the 'subdiv' attribute in the file).

By default, Assimp performs the subdivision using the standard Catmull-Clark algorithm

• Property type: bool. Default value: true.

Configures the AC loader to collect all surfaces which have the "Backface cull" flag set in separate meshes.

Property type: bool. Default value: true.

Configures the ASE loader to always reconstruct normal vectors basing on the smoothing groups loaded from the file.

Some ASE files have carry invalid normals, other don't.

• Property type: bool. Default value: true.

Specifies whether the Collada loader will ignore the provided up direction.

If this property is set to true, the up direction provided in the file header will be ignored and the file will be loaded as is. Property type: Bool. Default value: false.

Specifies whether the importer will drop empty animation curves or animation curves which match the bind pose transformation over their entire defined range.

The default value is true (1) Property type: bool

Set whether the fbx importer will preserve pivot points for transformations (as extra nodes).

If set to false, pivots and offsets will be evaluated whenever possible.

The default value is true (1) Property type: bool

Set whether the fbx importer will merge all geometry layers present in the source file or take only the first.

The default value is true (1) Property type: bool

Set whether the fbx importer will read all materials present in the source file or take only the referenced materials.

This is void unless IMPORT_FBX_READ_MATERIALS=1.

The default value is false (0) Property type: bool

Set whether the fbx importer will read animations.

The default value is true (1) Property type: bool

Set whether the fbx importer will read cameras.

The default value is true (1) Property type: bool

Set whether the fbx importer will read light sources.

The default value is true (1) Property type: bool

Set whether the fbx importer will read materials.

The default value is true (1) Property type: bool

Set whether the fbx importer will read embedded textures.

The default value is true (1) Property type: bool

Set whether the fbx importer will act in strict mode in which only FBX 2013 is supported and any other sub formats are rejected.

FBX 2013 is the primary target for the importer, so this format is best supported and well-tested.

The default value is false (0) Property type: bool

Set the vertex animation keyframe to be imported.

ASSIMP does not support vertex keyframes (only bone animation is supported). The library reads only one frame of models with vertex animations. By default this is the first frame.

Note

The default value is 0. This option applies to all importers. However, it is also possible to override the global setting for a specific loader. You can use the AI_CONFIG_IMPORT_XXX_KEYFRAME options (where XXX is a placeholder for the file format for which you want to override the global setting). Property type: integer.

Specifies whether the IFC loader will use its own, custom triangulation algorithm to triangulate wall and floor meshes.

If this property is set to false, walls will be either triangulated by aiProcess_Triangulate or will be passed through as huge polygons with faked holes (i.e. holes that are connected with the outer boundary using a dummy edge). It is highly recommended to set this property to true if you want triangulated data because aiProcess_Triangulate is known to have problems with the kind of polygons that the IFC loader spits out for complicated meshes. Property type: Bool. Default value: true.

Specifies whether the IFC loader skips over shape representations of type 'Curve2D'.

A lot of files contain both a faceted mesh representation and a outline with a presentation type of 'Curve2D'. Currently Assimp doesn't convert those, so turning this option off just clutters the log with errors.
Property type: Bool. Default value: true.

Specifies whether the IFC loader skips over IfcSpace elements.

IfcSpace elements (and their geometric representations) are used to represent, well, free space in a building storey.
Property type: Bool. Default value: true.

Defines the output frame rate of the IRR loader.

IRR animations are difficult to convert for Assimp and there will always be a loss of quality. This setting defines how many keys per second are returned by the converter.
Property type: integer. Default value: 100

Configures the LWO loader to load just one layer from the model.

LWO files consist of layers and in some cases it could be useful to load only one of them. This property can be either a string - which specifies the name of the layer - or an integer - the index of the layer. If the property is not set the whole LWO model is loaded. Loading fails if the requested layer is not available. The layer index is zero-based and the layer name may not be empty.
Property type: Integer. Default value: all layers are loaded.

Defines the begin of the time range for which the LWS loader evaluates animations and computes aiNodeAnim's.

Assimp provides full conversion of LightWave's envelope system, including pre and post conditions. The loader computes linearly subsampled animation chanels with the frame rate given in the LWS file. This property defines the start time. Note: animation channels are only generated if a node has at least one envelope with more tan one key assigned. This property. is given in frames, '0' is the first frame. By default, if this property is not set, the importer takes the animation start from the input LWS file ('FirstFrame' line)
Property type: Integer. Default value: taken from file.

See also

AI_CONFIG_IMPORT_LWS_ANIM_END - end of the imported time range

Configures the M3D loader to detect and process multi-part Quake player models.

These models usually consist of 3 files, lower.md3, upper.md3 and head.md3. If this property is set to true, Assimp will try to load and combine all three files if one of them is loaded. Property type: bool. Default value: true.

Specify the Quake 3 shader file to be used for a particular MD3 file.

This can also be a search path.

By default Assimp's behaviour is as follows: If a MD3 file any_path/models/any_q3_subdir/model_name/file_name.md3 is loaded, the library tries to locate the corresponding shader file in any_path/scripts/model_name.shader. This property overrides this behaviour. It can either specify a full path to the shader to be loaded or alternatively the path (relative or absolute) to the directory where the shaders for all MD3s to be loaded reside. Assimp attempts to open IMPORT_MD3_SHADER_SRC/model_name.shader first, IMPORT_MD3_SHADER_SRC/file_name.shader is the fallback file. Note that IMPORT_MD3_SHADER_SRC should have a terminal (back)slash. Property type: String. Default value: n/a.

Tells the MD3 loader which skin files to load.

When loading MD3 files, Assimp checks whether a file [md3_file_name]_[skin_name].skin is existing. These files are used by Quake III to be able to assign different skins (e.g. red and blue team) to models. 'default', 'red', 'blue' are typical skin names. Property type: String. Default value: "default".

Configures the MD5 loader to not load the MD5ANIM file for a MD5MESH file automatically.

The default strategy is to look for a file with the same name but the MD5ANIM extension in the same directory. If it is found, it is loaded and combined with the MD5MESH file. This configuration option can be used to disable this behaviour.

• Property type: bool. Default value: false.

Sets the colormap (= palette) to be used to decode embedded textures in MDL (Quake or 3DGS) files.

This must be a valid path to a file. The file is 768 (256*3) bytes large and contains RGB triplets for each of the 256 palette entries. The default value is colormap.lmp. If the file is not found, a default palette (from Quake 1) is used. Property type: string.

Global setting to disable generation of skeleton dummy meshes.

Skeleton dummy meshes are generated as a visualization aid in cases which the input data contains no geometry, but only animation data. Property data type: bool. Default value: false

Ogre Importer will try to find referenced materials from this file.

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.
Property type: String. Default value: Scene.material.

Ogre Importer detect the texture usage from its filename.

Ogre material texture units do not define texture type, the textures usage depends on the used shader or Ogre's 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 the last underscore and the last period. 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.
Property type: Bool. Default value: false.

Configures the terragen import plugin to compute uv's for terrains, if not given.

Furthermore a default texture is assigned.

UV coordinates for terrains are so simple to compute that you'll usually want to compute them on your own, if you need them. This option is intended for model viewers which want to offer an easy way to apply textures to terrains.

• Property type: bool. Default value: false.

Configures the UNREAL 3D loader to separate faces with different surface flags (e.g.

two-sided vs. single-sided).

• Property type: bool. Default value: true.

Specifies the maximum angle that may be between two vertex tangents that their tangents and bi-tangents are smoothed.

This applies to the CalcTangentSpace-Step. The angle is specified in degrees. The maximum value is 175. Property type: float. Default value: 45 degrees

Source UV channel for tangent space computation.

The specified channel must exist or an error will be raised. Property type: integer. Default value: 0

Require all bones qualify for deboning before removing any.

This is used by the aiProcess_Debone PostProcess-Step.

Note

The default value is 0 Property type: bool.

Lower the deboning threshold in order to remove more bones.

This is used by the aiProcess_Debone PostProcess-Step.

Note

The default value is AI_DEBONE_THRESHOLD Property type: float.

Configures the aiProcess_FindDegenerates step to remove degenerated primitives from the import - immediately.

The default behaviour converts degenerated triangles to lines and degenerated lines to points. See the documentation to the aiProcess_FindDegenerates step for a detailed example of the various ways to get rid of these lines and points if you don't want them. Property type: bool. Default value: false.

Input parameter to the aiProcess_FindInvalidData step: Specifies the floating-point accuracy for animation values.

The step checks for animation tracks where all frame values are absolutely equal and removes them. This tweakable controls the epsilon for floating-point comparisons - two keys are considered equal if the invariant abs(n0-n1)>epsilon holds true for all vector respectively quaternion components. The default value is 0.f - comparisons are exact then.

Specifies the maximum angle that may be between two face normals at the same vertex position that their are smoothed together.

Sometimes referred to as 'crease angle'. This applies to the GenSmoothNormals-Step. The angle is specified in degrees, so 180 is PI. The default value is 175 degrees (all vertex normals are smoothed). The maximum value is 175, too. Property type: float. Warning: setting this option may cause a severe loss of performance. The performance is unaffected if the AI_CONFIG_FAVOUR_SPEED flag is set but the output quality may be reduced.

Set the size of the post-transform vertex cache to optimize the vertices for.

This configures the aiProcess_ImproveCacheLocality step.

The size is given in vertices. Of course you can't know how the vertex format will exactly look like after the import returns, but you can still guess what your meshes will probably have.

Note

The default value is PP_ICL_PTCACHE_SIZE. That results in slight performance improvements for most nVidia/AMD cards since 2002. Property type: integer.

Set the maximum number of bones affecting a single vertex.

This is used by the aiProcess_LimitBoneWeights PostProcess-Step.

Note

The default value is AI_LBW_MAX_WEIGHTS Property type: integer.

Configures the aiProcess_OptimizeGraph step to preserve nodes matching a name in a given list.

This is a list of 1 to n strings, ' ' serves as delimiter character. Identifiers containing whitespaces must be enclosed in single quotation marks. For example: "keep-me and_me_to anotherNodeToBeKept \'name with whitespace\'". If a node matches on of these names, it will not be modified or removed by the postprocessing step.
This option might be useful if you are using some magic node names to pass additional semantics through the content pipeline. This ensures they won't be optimized away, but a general optimization is still performed for nodes not contained in the list. Property type: String. Default value: n/a

Note

Linefeeds, tabs or carriage returns are treated as whitespace. Node names are case sensitive.

Configures the aiProcess_PreTransformVertices step to use a users defined matrix as the scene root node transformation before transforming vertices.

Property type: bool. Default value: false.

Configures the aiProcess_PreTransformVertices step to keep the scene hierarchy.

Meshes are moved to worldspace, but no optimization is performed (read: meshes with equal materials are not joined. The total number of meshes won't change).

This option could be of use for you if the scene hierarchy contains important additional information which you intend to parse. For rendering, you can still render all meshes in the scene without any transformations. Property type: bool. Default value: false.

Configures the aiProcess_PreTransformVertices step to normalize all vertex components into the [-1,1] range.

That is, a bounding box for the whole scene is computed, the maximum component is taken and all meshes are scaled appropriately (uniformly of course!). This might be useful if you don't know the spatial dimension of the input data

Configures the aiProcess_PreTransformVertices step to use a users defined matrix as the scene root node transformation before transforming vertices.

This property correspond to the 'a1' component of the transformation matrix. Property type: aiMatrix4x4.

Configures the aiProcess_RemoveRedundantMaterials step to keep materials matching a name in a given list.

This is a list of 1 to n strings, ' ' serves as delimiter character. Identifiers containing whitespaces must be enclosed in single quotation marks. For example: "keep-me and_me_to anotherMaterialToBeKept \'name with whitespace\'". If a material matches on of these names, it will not be modified or removed by the postprocessing step nor will other materials be replaced by a reference to it.
This option might be useful if you are using some magic material names to pass additional semantics through the content pipeline. This ensures they won't be optimized away, but a general optimization is still performed for materials not contained in the list. Property type: String. Default value: n/a

Note

Linefeeds, tabs or carriage returns are treated as whitespace. Material names are case sensitive.

Input parameter to the aiProcess_RemoveComponent step: Specifies the parts of the data structure to be removed.

See the documentation to this step for further details. The property is expected to be an integer, a bitwise combination of the aiComponent flags defined above in this header. The default value is 0. Important: if no valid mesh is remaining after the step has been executed (e.g you thought it was funny to specify ALL of the flags defined above) the import FAILS. Mainly because there is no data to work on anymore ...

Maximum bone count per mesh for the SplitbyBoneCount step.

Meshes are split until the maximum number of bones is reached. The default value is AI_SBBC_DEFAULT_MAX_BONES, which may be altered at compile-time. Property data type: integer.

Input parameter to the aiProcess_SortByPType step: Specifies which primitive types are removed by the step.

This is a bitwise combination of the aiPrimitiveType flags. Specifying all of them is illegal, of course. A typical use would be to exclude all line and point meshes from the import. This is an integer property, its default value is 0.

Set the maximum number of triangles in a mesh.

This is used by the "SplitLargeMeshes" PostProcess-Step to determine whether a mesh must be split or not.

Note

The default value is AI_SLM_DEFAULT_MAX_TRIANGLES Property type: integer.

Set the maximum number of vertices in a mesh.

This is used by the "SplitLargeMeshes" PostProcess-Step to determine whether a mesh must be split or not.

Note

The default value is AI_SLM_DEFAULT_MAX_VERTICES Property type: integer.

Input parameter to the aiProcess_TransformUVCoords step: Specifies which UV transformations are evaluated.

This is a bitwise combination of the AI_UVTRAFO_XXX flags (integer property, of course). By default all transformations are enabled (AI_UVTRAFO_ALL).

Default value for the AI_CONFIG_PP_ICL_PTCACHE_SIZE property.

Enumerates components of the aiScene and aiMesh data structures that can be excluded from the import using the aiProcess_RemoveComponent step.

See the documentation to aiProcess_RemoveComponent for more details.