Assimp  v3.1.1 (June 2014)
jassimp.AiConfigOptions Enum Reference

Lists all possible configuration options. More...

Public Attributes

 IMPORT_MDL_COLORMAP =("IMPORT_MDL_COLORMAP")
 Sets the colormap (= palette) to be used to decode embedded textures in MDL (Quake or 3DGS) files. More...
 
 PP_CT_MAX_SMOOTHING_ANGLE =("PP_CT_MAX_SMOOTHING_ANGLE")
 Specifies the maximum angle that may be between two vertex tangents that their tangents and bi-tangents are smoothed. More...
 
 PP_CT_TEXTURE_CHANNEL_INDEX =("PP_CT_TEXTURE_CHANNEL_INDEX")
 Source UV channel for tangent space computation. More...
 
 PP_FD_REMOVE =("PP_FD_REMOVE")
 Configures the AiPostProcessSteps#FIND_DEGENERATES step to remove degenerated primitives from the import - immediately. More...
 
 PP_GSN_MAX_SMOOTHING_ANGLE =("PP_GSN_MAX_SMOOTHING_ANGLE")
 Specifies the maximum angle that may be between two face normals at the same vertex position that their are smoothed together. More...
 
 PP_PTV_KEEP_HIERARCHY =("PP_PTV_KEEP_HIERARCHY")
 Configures the AiPostProcessSteps#PRE_TRANSFORM_VERTICES step to keep the scene hierarchy. More...
 
 PP_PTV_NORMALIZE =("PP_PTV_NORMALIZE")
 Configures the AiPostProcessSteps#PRE_TRANSFORM_VERTICES step to normalize all vertex components into the [-1,1] range. More...
 
 PP_RRM_EXCLUDE_LIST =("PP_RRM_EXCLUDE_LIST")
 Configures the aiProcess_RemoveRedundantMaterials step to keep materials matching a name in a given list. More...
 
 PP_SBBC_MAX_BONES =("PP_SBBC_MAX_BONES")
 Maximum bone count per mesh for the SplitbyBoneCount step. More...
 

Detailed Description

Lists all possible configuration options.

This class is work-in-progress

Member Data Documentation

jassimp.AiConfigOptions.IMPORT_MDL_COLORMAP =("IMPORT_MDL_COLORMAP")

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.

jassimp.AiConfigOptions.PP_CT_MAX_SMOOTHING_ANGLE =("PP_CT_MAX_SMOOTHING_ANGLE")

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

jassimp.AiConfigOptions.PP_CT_TEXTURE_CHANNEL_INDEX =("PP_CT_TEXTURE_CHANNEL_INDEX")

Source UV channel for tangent space computation.

The specified channel must exist or an error will be raised.

Property type: integer. Default value: 0

jassimp.AiConfigOptions.PP_FD_REMOVE =("PP_FD_REMOVE")

Configures the AiPostProcessSteps#FIND_DEGENERATES 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 AiPostProcessSteps#FIND_DEGENERATES 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.

jassimp.AiConfigOptions.PP_GSN_MAX_SMOOTHING_ANGLE =("PP_GSN_MAX_SMOOTHING_ANGLE")

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 CONFIG_FAVOUR_SPEED flag is set but the output quality may be reduced.

jassimp.AiConfigOptions.PP_PTV_KEEP_HIERARCHY =("PP_PTV_KEEP_HIERARCHY")

Configures the AiPostProcessSteps#PRE_TRANSFORM_VERTICES 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.

jassimp.AiConfigOptions.PP_PTV_NORMALIZE =("PP_PTV_NORMALIZE")

Configures the AiPostProcessSteps#PRE_TRANSFORM_VERTICES 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.

Property type: bool. Default value: false.

jassimp.AiConfigOptions.PP_RRM_EXCLUDE_LIST =("PP_RRM_EXCLUDE_LIST")

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.

jassimp.AiConfigOptions.PP_SBBC_MAX_BONES =("PP_SBBC_MAX_BONES")

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. This limit is imposed by the native jassimp library and typically is 60.

Property data type: integer.


The documentation for this enum was generated from the following file: