Cmaterial

Describes a Maxwell material.

Inherits from

Cpointer.

Sub-classes

Citerator.

Enumerations

BLENDING_MODES.

Methods

Static Methods

Inherited Methods

isNull.

BLENDING_MODES

Blending modes available for multiple layers.

createCopy

Creates a full copy of the material and returns it. The copy doesn't belong to the scene.

free

Removes the material from the scene and destroys it.

Return value

0 = Error removing from the scene or destroying the material.

1 = Success.

extract

Removes the material from the scene.

Return value

0 = Error removing from the material from the scene..

1 = Success.

setName

Sets material name.

Return value

0 = Error setting material name.

1 = Success.

getName

Gets material name.

setReference

Sets the path to the MXM file referenced by this material. By default materials are not referenced but embeded in the scene.

Parameters

Return value

0 = Error setting reference path.

1 = Success.

getReference

Gets the path to the MXM file referenced by this material. By default materials are not referenced but embeded in the scene.

Parameters

Return value

C++

Path to the MXM file.

Python

Tuple containing 2 values: the path to the MXM file, and the reference state (0 or 1).

setDescription

Sets user description of the material.

Return value

0 = Error setting description.

1 = Success.

getDescription

Gets user description of the material.

Return value

0 = Error setting description.

1 = Success.

setUuid

Uuid that can be used for custom purposes.

Return value

0 = Error setting Uuid.

1 = Success.

getUuid

Uuid that can be used for custom purposes.

forceToWriteIntoScene

Write this material into the scene it belongs.

Return value

0 = Error forcing to write into scene.

1 = Success.

belongToScene

Checks whether the material belongs to the scene.

Return value

C++

0 = Error checking material belongs to scene.

1 = Success.

Python

True or False (belongs to the scene or not).

isEmpty

Checks whether the material is empty (no layers).

Return value

C++

0 = Error checking material is empty.

1 = Success.

Python

True or False (material is empty or not).

setEmpty

Sets material empty (not null but without layers).

Return value

0 = Error setting material empty.

1 = Success.

read

Reads a material from disk. pFileName is the full path to the MXM file.

Return value

0 = Error reading MXM material.

1 = Success.

write

Writes the material to disk. pFileName is the full path to the MXM file.

Return value

0 = Error writting MXM material.

1 = Success.

setDispersion

Sets dispersion state (Off by default).

Return value

0 = Error setting dispersion state.

1 = Success.

getDispersion

Gets dispersion state.

Return value

C++

0 = Error getting dispersion state.

1 = Success.

Python

True or False (dispersion is enabled or not).

setMatte

Sets matte state (Off by default).

Return value

0 = Error setting matte state.

1 = Success.

getMatte

Gets matte state.

Return value

C++

0 = Error getting matte state.

1 = Success.

Python

True or False (matte is enabled or not).

setMatteShadow

Sets matte shadow state (Off by default).

Return value

0 = Error setting matte shadow state.

1 = Success.

Examples

See the Python example Set shadows on.

getMatteShadow

Gets matte shadow state.

Return value

C++

0 = Error getting matte shadow state.

1 = Success.

Python

True or False (matte shadow is enabled or not).

addLayer

Adds a layer to the material.

Return value

Reference to the Cmaxwell::CmaterialLayer created.

getNumLayers

Return the number of layers in the material.

Return value

C++

0 = Error getting number of layers.

1 = Success.

Python

Number of layers in the material.

getLayer

Returns layer with the given index.

Return value

Reference to the Cmaxwell::CmaterialLayer requested.

setLayerDisplacement

Sets the layer that owns the active displacement.

Return value

0 = Error setting the layer that owns the active displacement.

1 = Success.

getLayerDisplacement

Gets the layer that owns the active displacement. getLayerDisplacement returns also a boolean that says if the index is valid. displacementOk returns true if the displacement of the layer with index "index" is valid, otherwise displacementOk returns false if there is not displacement in the layer or the map is NULL.

Return value

C++

0 = Error getting displacement layer.

1 = Success.

Python

Tuple containing 'index' and 'displacementOk' values.

setColor

Sets the global bump of the material.

Parameters

Return value

0 = Error setting color.

1 = Success.

Examples

Cmaxwell::CmultiValue::Cmap mvMap;
mvMap.type = Cmaxwell::CmultiValue::Cmap::TYPE_VALUE;
mvMap.value = 100.0;
material.setColor( "bump", mvMap );
material.setActiveColor( "bump", mvMap );

getColor

Gets the global bump of the material.

Parameters

Return value

C++

0 = Error getting global bump.

1 = Success.

Python

Cmap containing the global bump.

setActiveColor

Sets the active global bump of the material.

Parameters

Return value

0 = Error setting active color.

1 = Success.

Examples

Cmaxwell::CmultiValue::Cmap mvMap;
mvMap.type = Cmaxwell::CmultiValue::Cmap::TYPE_VALUE;
mvMap.value = 100.0;
material.setColor( "bump", mvMap );
material.setActiveColor( "bump", mvMap );

getActiveColor

Gets the active global bump of the material.

Parameters

Return value

C++

0 = Error getting active global bump.

1 = Success.

Python

Cmap containing the active global bump.

setNormalMapState

Enables/disables normal mapping for the global bump parameter.

Return value

0 = Error setting normal map state.

1 = Success.

getNormalMapState

Gets normal mapping state for the global bump parameter.

Return value

C++

0 = Error getting normal map state.

1 = Success.

Python

True or False (normal map is enabled or not).

setColorID

Sets the color used by this material in the Material ID render channel.

Return value

0 = Error setting the color ID.

1 = Success.

getColorID

Gets the color used by this material in the Material ID render channel.

Return value

C++

0 = Error getting the color ID.

1 = Success.

Python

Crgb  color ID.

setPreview

Sets the preview image stored in the material.

Parameters

Return value

0 = Error setting scene preview image.

1 = Success.

getPreview

Gets the preview image stored in the material.

Parameters

Return value

C++

Crgb8 pointer to the preview image. The memory pointed belongs to the material, so the programmer must not free it.

Python

NumPy array containing the RGB image. Array dimensions: (height, width, 3).

setTextureActive

Sets the active texture shown in the viewport of Maxwell Studio.

Return value

0 = Error setting the active texture.

1 = Success.

getTextureActive

Gets the active texture shown in the viewport of Maxwell Studio. If there is no active texture, the SDK returns the first map found. If there are no maps in the material, map.pFileName returns NULL.

Return value

C++

0 = Error getting the active texture.

1 = Success.

Python

Cmap  containing the active texture.

getNumberOfChannelsNeeded

Returns the number of UV channels needed for using this material.

getMaps

Returns an array with all the Cmaps used in this material. Internally it allocates an array of size nMaps. It is responsibility of the caller to destroy it later to avoid leaks (C++). If this material has a reference to another material, it does not take into account Cmaps of the referenced MXM. If addOnlyMapsWithBitmapsUsed is true, maps that contain bitmaps that are not used won't be added to the list (i.e if the active reflectance is set as a rgb color instead of as a bitmap, it won't be added to the list of maps).

Return value

C++

Cmaxwell::CmultiValue::Cmap array with nMaps elements.

Python

Cmap list.

getDependencies

Returns (by reference) an array of strings with all the extern depencencies of the material (textures, ior files, etc).

Parameters

Return value

C++

0 = Error getting the dependencies.

1 = Success.

Python

str list containing the dependencies.

getVersion

Returns the version number of the material in the MXM file.

Return value

C++

0 = Error getting version from MXM file.

1 = Success.

Python

Material version.