AmbientCGLoader Class Reference

Public Member Functions
	constructor (mxModule, mxStdlib=null)
	Class to load materials from the AmbientCG site.
	setDebugging (debug=true)
	getMaterialNames (key='assetId')
	writeMaterialList (materialList, filename)
	buildDownloadAttribute (imageFormat='PNG', imageResolution='1')
	getDownloadedMaterialInformation ()
	clearDownloadMaterial ()
	writeDownloadedMaterialToFile (path='')
async	downloadMaterialAsset (assetId, imageFormat='PNG', imageResolution='1', downloadAttributeKey='downloadAttribute', downloadLinkKey='downloadLink')
	findMaterial (assetId, key='assetId')
	loadMaterialsList (fileName)
async	downloadMaterialsList ()
	getDataBase ()
	getDataBaseMaterialList ()
async	downloadAssetDatabase ()
	writeDatabaseToFile (filename)
	validateMaterialXDocument (doc)
	addComment (doc, commentString)
	getMaterialXString (doc)

Detailed Description

Definition at line 7 of file JsAmbientCGLoader.js.

Member Function Documentation

addComment()

AmbientCGLoader::addComment	(		doc,
			commentString )

Add a comment to the MaterialX document.

Parameters

{Object}	doc - The MaterialX document to add the comment to.
{string}	commentString - The comment string to add.

Definition at line 311 of file JsAmbientCGLoader.js.

                                   {
 
        const comment = doc.addChildOfCategory('comment');
        comment.setDocString(commentString);
    }

buildDownloadAttribute()

AmbientCGLoader::buildDownloadAttribute	(		imageFormat = 'PNG',
			imageResolution = '1' )

Build the download attribute string for a given image format and resolution.

Parameters

{string}	imageFormat - The image format to download.
{string}	imageResolution - The image resolution to download.

Returns

{string} The download attribute string.

Definition at line 81 of file JsAmbientCGLoader.js.

                                                                       {
 
        return `${imageResolution}K-${imageFormat}`;
    }

clearDownloadMaterial()

AmbientCGLoader::clearDownloadMaterial

(

)

Clear any cached current material asset.

Definition at line 102 of file JsAmbientCGLoader.js.

                            {
 
        if (this.downloadMaterial) {
            this.downloadMaterial = null;
        }
        this.downloadMaterialFileName = '';
    }

constructor()

AmbientCGLoader::constructor	(		mxModule,
			mxStdlib = null )

Class to load materials from the AmbientCG site.

The class can convert the materials to MaterialX format for given target shading models.

Parameters

{Object}	mxModule - The MaterialX module. Required.
{Object}	mxStdlib - The MaterialX standard library. Optional.

Definition at line 14 of file JsAmbientCGLoader.js.

                                           {
        this.logger = console;
        this.database = {};
        this.assets = {};
        this.materials = null;
        this.materialNames = [];
        this.csvMaterials = null;
        this.downloadMaterial = null;
        this.downloadMaterialFileName = '';
        this.mx = mxModule;
        this.stdlib = mxStdlib;
        this.supportOpenPBR = false;
 
        if (!mxModule) {
            this.logger.error('MaterialX module not specified.');
            return;
        }
 
        // Check for OpenPBR support (placeholder logic)
        const version = this.mx.getVersionIntegers();
        this.logger.info(`Using MaterialX version: ${version.join('.')}`);
        if (version[0] >= 1 && version[1] >= 39) || version[0] > 1) {
            this.logger.debug('OpenPBR shading model supported');
            this.supportOpenPBR = true;
        }
 
        // Load the MaterialX standard library if not provided
        if (!this.stdlib) {
            this.stdlib = this.mx.createDocument();
            const libFiles = this.mx.loadLibraries(this.mx.getDefaultDataLibraryFolders(), this.mx.getDefaultDataSearchPath(), this.stdlib);
            this.logger.debug(`Loaded standard library: ${libFiles}`);
        }
    }

downloadAssetDatabase()

async AmbientCGLoader::downloadAssetDatabase

(

)

Download the asset database for materials from the ambientCG site.

Returns

{Object} The downloaded database.

Definition at line 245 of file JsAmbientCGLoader.js.

                                  {
 
        this.database = {};
        this.assets = null;
 
        const url = 'https://ambientcg.com/api/v2/full_json';
        const headers = { Accept: 'application/json' };
        const params = {
            method: 'PBRPhotogrammetry',
            type: 'Material',
            sort: 'Alphabet',
        };
 
        try {
            const response = await axios.get(url, { headers, params });
            if (response.status === 200) {
                this.database = response.data;
                this.assets = this.database.foundAssets;
            } else {
                this.logger.error(`Status: ${response.status}, ${response.data}`);
            }
        } catch (error) {
            this.logger.error(`Error downloading asset database: ${error}`);
        }
 
        return this.database;
    }

downloadMaterialAsset()

async AmbientCGLoader::downloadMaterialAsset	(		assetId,
			imageFormat = 'PNG',
			imageResolution = '1',
			downloadAttributeKey = 'downloadAttribute',
			downloadLinkKey = 'downloadLink' )

Download a material with a given id and format + resolution for images.

Parameters

{string}	assetId - The string id of the material.
{string}	imageFormat - The image format to download. Default is PNG.
{string}	imageResolution - The image resolution to download. Default is 1.
{string}	downloadAttributeKey - The download attribute key. Default is 'downloadAttribute'.
{string}	downloadLinkKey - The download link key. Default is 'downloadLink'.

Returns

{string} File name of downloaded content.

Definition at line 128 of file JsAmbientCGLoader.js.

                                                                                                                                                                   {
 
        this.clearDownloadMaterial();
 
        const items = this.findMaterial(assetId);
        const target = this.buildDownloadAttribute(imageFormat, imageResolution);
        let url = '';
        let downloadAttribute = '';
 
        items.forEach(item => {
            downloadAttribute = item[downloadAttributeKey];
            if (downloadAttribute === target) {
                url = item[downloadLinkKey];
                this.logger.info(`Found Asset: ${assetId}. Download Attribute: ${downloadAttribute} -> ${url}`);
            }
        });
 
        if (!url) {
            this.logger.error(`No download link found for asset: ${assetId}, attribute: ${target}`);
            return '';
        }
 
        this.downloadMaterialFileName = url.split('file=')[1];
 
        try {
            const response = await axios.get(url, { responseType: 'arraybuffer' });
            this.downloadMaterial = Buffer.from(response.data, 'binary');
            this.logger.info(`Material file downloaded: ${this.downloadMaterialFileName}`);
        } catch (error) {
            this.downloadMaterialFileName = '';
            this.logger.error(`Error occurred while downloading the file: ${error}`);
        }
 
        return this.downloadMaterialFileName;
    }

downloadMaterialsList()

async AmbientCGLoader::downloadMaterialsList

(

)

Download the list of materials from the ambientCG site.

Returns

{Array} Materials list.

Definition at line 196 of file JsAmbientCGLoader.js.

                                  {
 
        const url = 'https://ambientCG.com/api/v2/downloads_csv';
        const headers = { Accept: 'application/csv' };
        const params = {
            method: 'PBRPhotogrammetry',
            type: 'Material',
            sort: 'Alphabet',
        };
 
        this.logger.info('Downloading materials CSV list...');
        try {
            const response = await axios.get(url, { headers, params });
            if (response.status === 200) {
                const csvContent = response.data;
                this.csvMaterials = csvContent;
                //this.materials = parse(csvContent, { columns: true });
                this.logger.info('Downloaded CSV material list as JSON.');
            } else {
                this.materials = null;
                this.logger.warning(`Failed to fetch the CSV material content. HTTP status code: ${response.status}`);
            }
        } catch (error) {
            this.materials = null;
            this.logger.error(`Error downloading materials list: ${error}`);
        }
 
        return this.materials;
    }

findMaterial()

AmbientCGLoader::findMaterial	(		assetId,
			key = 'assetId' )

Get the list of materials matching a material identifier.

Parameters

{string}	assetId - Material string identifier.
{string}	key - The key to lookup asset identifiers. Default is 'assetId'.

Returns

{Array} List of materials, or empty array if not found.

Definition at line 172 of file JsAmbientCGLoader.js.

                                           {
 
        if (this.materials) {
            return this.materials.filter(item => item[key] === assetId);
        }
        return [];
    }

getDataBase()

AmbientCGLoader::getDataBase

(

)

Get asset database.

Returns

{Object} Asset database.

Definition at line 229 of file JsAmbientCGLoader.js.

                  {
 
        return this.database;
    }

getDataBaseMaterialList()

AmbientCGLoader::getDataBaseMaterialList

(

)

Get asset database material list.

Returns

{Array} Material list.

Definition at line 237 of file JsAmbientCGLoader.js.

                              {
 
        return this.assets;
    }

getDownloadedMaterialInformation()

AmbientCGLoader::getDownloadedMaterialInformation

(

)

Get the current downloaded material information.

Returns

{Object} The downloaded material information.

Definition at line 91 of file JsAmbientCGLoader.js.

                                       {
 
        return {
            filename: this.downloadMaterialFileName,
            content: this.downloadMaterial
        };
    }

getMaterialNames()

AmbientCGLoader::getMaterialNames

(

key = 'assetId'

)

Get the list of material names.

Parameters

{string}

key - The key to use for the material name. Default is 'assetId'.

Returns

{Array} The list of material names.

Definition at line 56 of file JsAmbientCGLoader.js.

                                      {
 
        this.materialNames = [];
        const uniqueNames = new Set();
        if (this.materials) {
            this.materials.forEach(item => uniqueNames.add(item[key]));
        }
        this.materialNames = Array.from(uniqueNames).sort();
        return this.materialNames;
    }

getMaterialXString()

AmbientCGLoader::getMaterialXString

(

doc

)

Convert the MaterialX document to a string.

Parameters

{Object}

doc - The MaterialX document to convert.

Returns

{string} The MaterialX document as a string.

Definition at line 321 of file JsAmbientCGLoader.js.

                            {
 
        if (!this.mx) {
            this.logger.error('MaterialX module is required');
            return;
        }
 
        const writeOptions = this.mx.XmlWriteOptions();
        writeOptions.writeXIncludeEnable = false;
        writeOptions.elementPredicate = this.skipLibraryElement;
        return this.mx.writeToXmlString(doc, writeOptions);
    }

loadMaterialsList()

AmbientCGLoader::loadMaterialsList

(

fileName

)

Load in the list of downloadable materials from file.

Parameters

{string}

fileName - Name of JSON containing list.

Returns

{Array} Materials list.

Definition at line 185 of file JsAmbientCGLoader.js.

                                {
 
        this.materials = JSON.parse(fs.readFileSync(fileName, 'utf8'));
        this.logger.info(`Loaded materials list from: ${fileName}`);
        return this.materials;
    }

setDebugging()

AmbientCGLoader::setDebugging

(

debug = true

)

Set the debugging level for the logger.

Parameters

{boolean}

debug - True to set the logger to debug level, otherwise False.

Definition at line 48 of file JsAmbientCGLoader.js.

                               {
 
        this.logger.level = debug ? 'debug' : 'info';
    }

validateMaterialXDocument()

AmbientCGLoader::validateMaterialXDocument

(

doc

)

Validate the MaterialX document.

Parameters

{Object}

doc - The MaterialX document to validate.

Returns

{Array} A tuple of (valid, errors) where valid is True if the document is valid, and errors is a list of errors if the document is invalid.

Definition at line 291 of file JsAmbientCGLoader.js.

                                   {
 
        if (!this.mx) {
            this.logger.error('MaterialX module is required');
            return [false, ''];
        }
 
        if (!doc) {
            this.logger.warning('MaterialX document is required');
            return [false, ''];
        }
 
        const valid = doc.validate();
        return [valid, valid ? '' : 'Validation failed'];
    }

writeDatabaseToFile()

AmbientCGLoader::writeDatabaseToFile

(

filename

)

Write the database file.

Parameters

{string}

filename - The filename to write the JSON file to.

Returns

{boolean} True if the file was written successfully, otherwise False.

Definition at line 276 of file JsAmbientCGLoader.js.

                                  {
 
        if (!this.database) {
            this.logger.warning('No database to write');
            return false;
        }
 
        fs.writeFileSync(filename, JSON.stringify(this.database, null, 4));
        return true;
    }

writeDownloadedMaterialToFile()

AmbientCGLoader::writeDownloadedMaterialToFile

(

path = ''

)

Write the currently downloaded file to file.

Parameters

{string}

path - The output path for the material. Default is empty.

Definition at line 112 of file JsAmbientCGLoader.js.

                                             {
 
        const haveDownload = this.downloadMaterialFileName && this.downloadMaterial;
        if (!haveDownload) {
            this.logger.warning('No current material downloaded');
            return;
        }
 
        const filename = `${path}/${this.downloadMaterialFileName}`;
        fs.writeFileSync(filename, this.downloadMaterial);
        this.logger.info(`Saved downloaded material to: ${filename}`);
    }

writeMaterialList()

AmbientCGLoader::writeMaterialList	(		materialList,
			filename )

Write the material list in JSON format to a file.

Parameters

{Array}	materialList - The list of materials to write.
{string}	filename - The file path to write the list to.

Definition at line 71 of file JsAmbientCGLoader.js.

                                              {
 
        this.logger.info(`Writing material list to file: ${filename}`);
        fs.writeFileSync(filename, JSON.stringify(materialList, null, 4));
    }

---

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

• JsAmbientCGLoader.js