Interface MaterialManagerInterface

The MaterialManagerInterface interface allows the coloring of the DMU.

This interface is used to create and set materials for geometric instances from their geometric instance ids. All materials are accessed by their material id, there is no specific "material objects" to handle.

WARNING : there is a fixed limit for the total number of different materials that may be in use.

Original materials refer to the materials loaded from the DMU and custom materials refer to the API created materials. Depending on the number of original materials of the DMU, there may be a different number of custom materials that may be created. The number of custom materials that may be created is given by getAvailableCustomMaterialsCount. Only custom materials can be created, modified or removed; original materials of the DMU can only be queried but not modified.

A single geometric instance may have multiple original materials, in case of a multi material geometry. For these geometries, it is NOT possible to change the coloring of each individual sub-geometry. In case of a custom material application, the whole geometry color will be changed.

The MaterialManagerInterface is a member of the InfiniteEngineInterface, accessed through InfiniteEngineInterface.getMaterialManager.

/** 
 * Sample to illustrate the change of colors of `geometric instance` (MaterialManagerInterface).
 */
import { InfiniteEngineInterface, MaterialManagerInterface, Vector3 } from 'generated_files/documentation/appinfiniteapi';

// created previously
let lInfiniteEngine : InfiniteEngineInterface;
// the `geometric instance id` to check
let lGeometricInstanceId : number;
// get the material manager
const lMaterialManager : MaterialManagerInterface = lInfiniteEngine.getMaterialManager();

// warning, in case of multi materials, multiple materials may be retrieved
const lNbMaterials : number = lMaterialManager.getOriginalMaterialsOfInstanceCount(lGeometricInstanceId);
const lOriginalMaterials : number[] = [];

if ((!lMaterialManager.getOriginalMaterialsOfInstance(lGeometricInstanceId, lOriginalMaterials)) || (lOriginalMaterials.length === 0))
{
    console.log('Error while fetching original materials');
}
console.assert(lNbMaterials === (lOriginalMaterials.length));

// get the diffuse color of the given `geometric instance`
const lOriginalColor : Vector3 = new Vector3();
if (!lMaterialManager.getMaterialDiffuse(lOriginalMaterials[0], lOriginalColor))
{
    console.log('Error while fetching original material color');
}

// colors are expressed as Vector3 red,green,blue (in this order), in the range [0:1]
// 
const lGreenColor : Vector3 = new Vector3(0, 1, 0);
const lRedColor : Vector3 = new Vector3(1, 0, 0);
const lBlueColor : Vector3 = new Vector3(0, 0, 1);
const lWhiteColor : Vector3 = new Vector3(1, 1, 1);

// create an array of colors to cycle through
const lColors : Vector3 [] = [lGreenColor, lRedColor, lBlueColor, lWhiteColor];
// where are we in the array ?
let lCurrentColorOffset : number = 0;

// create a custom material, but instead of creating multiple materials, use one and 
// modify it
const lCustomMaterialId : number = lMaterialManager.createNewMaterial(lRedColor);

// callback to be called on mouse down
const onChangeMaterial = () : void =>
{
    // should we set a color or restore it ?
    if (lCurrentColorOffset < lColors.length)
    {
        // modify the custom material
        lMaterialManager.modifyMaterial(lCustomMaterialId, lColors[lCurrentColorOffset]);
        if (lMaterialManager.getMaterialOfInstance(lGeometricInstanceId) !== lCustomMaterialId)
        {
            // and change the current material if relevant
            lMaterialManager.changeMaterialOfInstance(lGeometricInstanceId, lCustomMaterialId);
        }
        // next color for next time
        lCurrentColorOffset += 1;
    }
    else
    {
        // we should restore the material for the element
        if (lMaterialManager.getMaterialOfInstance(lGeometricInstanceId) === lCustomMaterialId)
        {
            // but only if relevant
            lMaterialManager.restoreOriginalMaterialOfInstance(lGeometricInstanceId);
        }
        // go back to the start of tests
        lCurrentColorOffset = 0;
    }
};

// when should we change the colors of the given `geometric instance` ?
// => mouse down
document.addEventListener('mousedown', onChangeMaterial);

Copy

See

InfiniteEngineInterface