Assimp  v3.0 (July 2012)
Public Member Functions | Static Public Member Functions | Public Attributes
aiMaterial Struct Reference

Data structure for a material. More...

List of all members.

Public Member Functions

aiReturn AddBinaryProperty (const void *pInput, unsigned int pSizeInBytes, const char *pKey, unsigned int type, unsigned int index, aiPropertyTypeInfo pType)
 Add a property with a given key and type info to the material structure.
aiReturn AddProperty (const aiString *pInput, const char *pKey, unsigned int type=0, unsigned int index=0)
 Add a string property with a given key and type info to the material structure.
template<class TYPE >
aiReturn AddProperty (const TYPE *pInput, unsigned int pNumValues, const char *pKey, unsigned int type=0, unsigned int index=0)
 Add a property with a given key to the material structure.
 aiMaterial ()
void Clear ()
 Removes all properties from the material.
template<typename Type >
aiReturn Get (const char *pKey, unsigned int type, unsigned int idx, Type *pOut, unsigned int *pMax) const
 Retrieve an array of Type values with a specific key from the material.
template<typename Type >
aiReturn Get (const char *pKey, unsigned int type, unsigned int idx, Type &pOut) const
 Retrieve a Type value with a specific key from the material.
aiReturn GetTexture (aiTextureType type, unsigned int index, aiString *path, aiTextureMapping *mapping=NULL, unsigned int *uvindex=NULL, float *blend=NULL, aiTextureOp *op=NULL, aiTextureMapMode *mapmode=NULL) const
 Helper function to get all parameters pertaining to a particular texture slot from a material.
unsigned int GetTextureCount (aiTextureType type) const
 Get the number of textures for a particular texture type.
aiReturn RemoveProperty (const char *pKey, unsigned int type=0, unsigned int index=0)
 Remove a given key from the list.
 ~aiMaterial ()

Static Public Member Functions

static void CopyPropertyList (aiMaterial *pcDest, const aiMaterial *pcSrc)
 Copy the property list of a material.

Public Attributes

unsigned int mNumAllocated
 Storage allocated.
unsigned int mNumProperties
 Number of properties in the data base.
aiMaterialProperty ** mProperties
 List of all material properties loaded.

Detailed Description

Data structure for a material.

Material data is stored using a key-value structure. A single key-value pair is called a 'material property'. C++ users should use the provided member functions of aiMaterial to process material properties, C users have to stick with the aiMaterialGetXXX family of unbound functions. The library defines a set of standard keys (AI_MATKEY_XXX).


Constructor & Destructor Documentation

aiMaterial::aiMaterial ( )
aiMaterial::~aiMaterial ( )

Member Function Documentation

aiReturn aiMaterial::AddBinaryProperty ( const void *  pInput,
unsigned int  pSizeInBytes,
const char *  pKey,
unsigned int  type,
unsigned int  index,
aiPropertyTypeInfo  pType 
)

Add a property with a given key and type info to the material structure.

Parameters:
pInputPointer to input data
pSizeInBytesSize of input data
pKeyKey/Usage of the property (AI_MATKEY_XXX)
typeSet by the AI_MATKEY_XXX macro
indexSet by the AI_MATKEY_XXX macro
pTypeType information hint
aiReturn aiMaterial::AddProperty ( const aiString pInput,
const char *  pKey,
unsigned int  type = 0,
unsigned int  index = 0 
)

Add a string property with a given key and type info to the material structure.

Parameters:
pInputInput string
pKeyKey/Usage of the property (AI_MATKEY_XXX)
typeSet by the AI_MATKEY_XXX macro
indexSet by the AI_MATKEY_XXX macro
template<class TYPE >
aiReturn aiMaterial::AddProperty ( const TYPE *  pInput,
unsigned int  pNumValues,
const char *  pKey,
unsigned int  type = 0,
unsigned int  index = 0 
)

Add a property with a given key to the material structure.

Parameters:
pInputPointer to the input data
pNumValuesNumber of values in the array
pKeyKey/Usage of the property (AI_MATKEY_XXX)
typeSet by the AI_MATKEY_XXX macro
indexSet by the AI_MATKEY_XXX macro
void aiMaterial::Clear ( )

Removes all properties from the material.

The data array remains allocated so adding new properties is quite fast.

static void aiMaterial::CopyPropertyList ( aiMaterial pcDest,
const aiMaterial pcSrc 
)
static

Copy the property list of a material.

Parameters:
pcDestDestination material
pcSrcSource material
template<typename Type >
aiReturn aiMaterial::Get ( const char *  pKey,
unsigned int  type,
unsigned int  idx,
Type *  pOut,
unsigned int *  pMax 
) const

Retrieve an array of Type values with a specific key from the material.

Parameters:
pKeyKey to search for. One of the AI_MATKEY_XXX constants.
type.. set by AI_MATKEY_XXX
idx.. set by AI_MATKEY_XXX
pOutPointer to a buffer to receive the result.
pMaxSpecifies the size of the given buffer, in Type's. Receives the number of values (not bytes!) read. NULL is a valid value for this parameter.
template<typename Type >
aiReturn aiMaterial::Get ( const char *  pKey,
unsigned int  type,
unsigned int  idx,
Type &  pOut 
) const

Retrieve a Type value with a specific key from the material.

 @param pKey Key to search for. One of the AI_MATKEY_XXX constants.
Parameters:
typeSpecifies the type of the texture to be retrieved ( e.g. diffuse, specular, height map ...)
idxIndex of the texture to be retrieved.
pOutReference to receive the output value
aiReturn aiMaterial::GetTexture ( aiTextureType  type,
unsigned int  index,
aiString path,
aiTextureMapping mapping = NULL,
unsigned int *  uvindex = NULL,
float *  blend = NULL,
aiTextureOp op = NULL,
aiTextureMapMode mapmode = NULL 
) const

Helper function to get all parameters pertaining to a particular texture slot from a material.

 This function is provided just for convenience, you could also
 read the single material properties manually.
 @param type Specifies the type of the texture to be retrieved (
   e.g. diffuse, specular, height map ...)
 @param index Index of the texture to be retrieved. The function fails
   if there is no texture of that type with this index. 
   #GetTextureCount() can be used to determine the number of textures
   per texture type.
 @param path Receives the path to the texture.
       NULL is a valid value.
Parameters:
mappingThe texture mapping. NULL is allowed as value.
uvindexReceives the UV index of the texture. NULL is a valid value.
blendReceives the blend factor for the texture NULL is a valid value.
opReceives the texture operation to be performed between this texture and the previous texture. NULL is allowed as value.
mapmodeReceives the mapping modes to be used for the texture. The parameter may be NULL but if it is a valid pointer it MUST point to an array of 3 aiTextureMapMode's (one for each axis: UVW order (=XYZ)).
unsigned int aiMaterial::GetTextureCount ( aiTextureType  type) const

Get the number of textures for a particular texture type.

Parameters:
typeTexture type to check for
Returns:
Number of textures for this type.
Note:
A texture can be easily queried using GetTexture()
aiReturn aiMaterial::RemoveProperty ( const char *  pKey,
unsigned int  type = 0,
unsigned int  index = 0 
)

Remove a given key from the list.

The function fails if the key isn't found

Parameters:
pKeyKey to be deleted

Member Data Documentation

unsigned int aiMaterial::mNumAllocated

Storage allocated.

unsigned int aiMaterial::mNumProperties

Number of properties in the data base.

aiMaterialProperty** aiMaterial::mProperties

List of all material properties loaded.


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