MxZipUtils Class Reference

Utility class for unzipping ZIP which contain MaterialX files and dependent images . More...

Public Member Functions
	constructor ()
	Constructor.

Static Public Member Functions
static async	unzipMaterialXData (zipData)
	Unzips the given ZIP data and returns the MaterialX documents and textures.
static async	unzipMaterialXUrl (zipUrl)
	Fetch the ZIP file on initial load.

Detailed Description

Utility class for unzipping ZIP which contain MaterialX files and dependent images .

Assumes fflate has been imported. Simple way in an htm files is to include: <script src="https://cdn.jsdelivr.net/npm/fflate/umd/index.js"></script>

Definition at line 9 of file JsMaterialXZipUtils.js.

Member Function Documentation

constructor()

MxZipUtils::constructor

(

)

Constructor.

Will check if fflate is available. If not available, an error will be logged.

Definition at line 15 of file JsMaterialXZipUtils.js.

                  {
        // Check if fflate is available
        if (typeof fflate === 'undefined') {
            console.error("fflate is not available. Please include fflate in your HTML file.");
        }
    }

unzipMaterialXData()

static async MxZipUtils::unzipMaterialXData ( zipData )

static

Unzips the given ZIP data and returns the MaterialX documents and textures.

Parameters

zipData

The ZIP data to unzip.

Returns

The unzipped documents and textures in an array.

Definition at line 27 of file JsMaterialXZipUtils.js.

                                             {
        let documents = [];
        let textures = [];
 
        // Unzip the file using fflate
        fflate.unzip(zipData, (err, files) => {
            if (err) {
                console.error("Error unzipping file:", err);
                return;
            }
 
            // Iterate through files in the ZIP
            for (let fileName in files) {
                const fileType = fileName.split('.').pop().toLowerCase();
 
                if (['mtlx'].includes(fileType)) {
 
                    // Handle text files using TextDecoder
                    const fileContent = new TextDecoder("utf-8").decode(files[fileName]);
                    //console.log(`File: ${fileName} (${fileContent.length} )`);
                    documents.push({ name: fileName, content: fileContent });
 
                } else {
                    // Get mime type based on extension
                    const standardMimeTypes = {
                        'png': 'image/png',
                        'jpg': 'image/jpeg',
                        'jpeg': 'image/jpeg',
                        'gif': 'image/gif',
                        'bmp': 'image/bmp',
                        'svg': 'image/svg+xml',
                        'webp': 'image/webp',
                        'exr': 'image/exr',
                        'hdr': 'image/vnd.radiance'
                    };
 
                    let mimeType = 'image/' + fileType;
                    if (fileType in standardMimeTypes) {
                        mimeType = standardMimeTypes[fileType];
 
                        const blob = new Blob([files[fileName]], { type: mimeType });
                        const url = URL.createObjectURL(blob);
 
                        textures.push({ name: fileName, url: url });
                        //console.log(`Texture: ${fileName} (${url})`);
 
                    } 
                    else {
                        // Check if it's a folder
                        if (files[fileName].length === 0) {
                            console.log(`Folder: ${fileName}`);
                        } else {
                            console.log(`Unsupported file type: ${fileName}`);
                        }
                    }
                }
            }
        });
 
        return [documents, textures];
    }

unzipMaterialXUrl()

static async MxZipUtils::unzipMaterialXUrl ( zipUrl )

static

Fetch the ZIP file on initial load.

Parameters

zipUrl

The URL of the ZIP file to fetch.

Returns

The unzipped documents and textures in an array

Definition at line 95 of file JsMaterialXZipUtils.js.

                                           {
        const response = await fetch(zipUrl);
        const data = await response.arrayBuffer();
        const zipData = new Uint8Array(data); // Convert to Uint8Array
        const result = await MxZipUtils.unzipMaterialXData(zipData);
        return result;
    }

---

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

• JsMaterialXZipUtils.js