materialxgltf.core.Util Class Reference

Basic I/O Utilities. More...

Static Public Member Functions
tuple[mx.Document, list]	createMaterialXDoc ()
	Utility to create a MaterialX document with the default libraries loaded.
bool	skipLibraryElement (elem)
	Utility to skip library elements when iterating over elements in a document.
	writeMaterialXDoc (doc, filename, predicate=skipLibraryElement)
	Utility to write a MaterialX document to a file.
	writeMaterialXZip (doc, mtlx_filename, zip_filename, image_references, predicate=skipLibraryElement)
	Utility to write a MaterialX document and its referenced images to a zip file.
	writeMaterialXStringZip (mtlx_str, mtlx_filename, zip_filename, image_references, predicate=skipLibraryElement)
	Utility to write a MaterialX document and its referenced images to a zip file.
	writeMaterialXDocString (doc, predicate=skipLibraryElement)
	Utility to write a MaterialX document to string.
list	makeFilePathsRelative (doc, docPath)
	Utility to make file paths relative to a document path.

Detailed Description

Basic I/O Utilities.

Definition at line 34 of file core.py.

Member Function Documentation

createMaterialXDoc()

tuple[mx.Document, list] materialxgltf.core.Util.createMaterialXDoc ( )

static

Utility to create a MaterialX document with the default libraries loaded.

Returns

The created MaterialX document and the list of loaded library filenames.

Definition at line 37 of file core.py.

    def createMaterialXDoc() -> tuple[mx.Document, list]:
        '''
        @brief Utility to create a MaterialX document with the default libraries loaded.
        @return The created MaterialX document and the list of loaded library filenames.
        '''
        doc = mx.createDocument()
        stdlib = mx.createDocument()
        libFiles = []
        searchPath = mx.getDefaultDataSearchPath()
        libFiles = mx.loadLibraries(mx.getDefaultDataLibraryFolders(), searchPath, stdlib)
        doc.importLibrary(stdlib)
 
        return doc, libFiles
 

makeFilePathsRelative()

list materialxgltf.core.Util.makeFilePathsRelative ( doc, docPath )

static

Utility to make file paths relative to a document path.

Parameters

doc	The MaterialX document to update.
docPath	The path to make file paths relapy -tive to.

Returns

List of tuples of unresolved and resolved file paths.

Definition at line 122 of file core.py.

    def makeFilePathsRelative(doc, docPath) -> list:
        '''
        @brief Utility to make file paths relative to a document path
        @param doc The MaterialX document to update.
        @param docPath The path to make file paths relapy -tive to.
        @return List of tuples of unresolved and resolved file paths.
        '''
        result = []
 
        for elem in doc.traverseTree():
                valueElem = None
                if elem.isA(mx.ValueElement):
                    valueElem = elem
                if not valueElem or valueElem.getType() != mx.FILENAME_TYPE_STRING:
                    continue
 
                unresolvedValue = mx.FilePath(valueElem.getValueString())
                if unresolvedValue.isEmpty():
                    continue
 
                elementResolver = valueElem.createStringResolver()
                if unresolvedValue.isAbsolute():
                    elementResolver.setFilePrefix('')
                resolvedValue = valueElem.getResolvedValueString(elementResolver)
                resolvedValue = mx.FilePath(resolvedValue).getBaseName()
                valueElem.setValueString(resolvedValue)
 
                if unresolvedValue != resolvedValue:
                    result.append([unresolvedValue.asString(mx.FormatPosix), resolvedValue])
 
        return result  
 

skipLibraryElement()

bool materialxgltf.core.Util.skipLibraryElement ( elem )

static

Utility to skip library elements when iterating over elements in a document.

Returns

True if the element is not in a library, otherwise False.

Definition at line 52 of file core.py.

    def skipLibraryElement(elem) -> bool:
        '''
        @brief Utility to skip library elements when iterating over elements in a document.
        @return True if the element is not in a library, otherwise False.
        '''
        return not elem.hasSourceUri()
 

writeMaterialXDoc()

materialxgltf.core.Util.writeMaterialXDoc ( doc, filename, predicate = skipLibraryElement )

static

Utility to write a MaterialX document to a file.

Parameters

doc	The MaterialX document to write.
filename	The name of the file to write to.
predicate	A predicate function to determine if an element should be written. Default is to skip library elements.

Definition at line 60 of file core.py.

    def writeMaterialXDoc(doc, filename, predicate=skipLibraryElement):
        '''
        @brief Utility to write a MaterialX document to a file.
        @param doc The MaterialX document to write.
        @param filename The name of the file to write to.
        @param predicate A predicate function to determine if an element should be written. Default is to skip library elements.
        '''
        writeOptions = mx.XmlWriteOptions()
        writeOptions.writeXIncludeEnable = False
        writeOptions.elementPredicate = predicate
 
        if filename:
            mx.writeToXmlFile(doc, filename, writeOptions)
 

writeMaterialXDocString()

materialxgltf.core.Util.writeMaterialXDocString ( doc, predicate = skipLibraryElement )

static

Utility to write a MaterialX document to string.

Parameters

doc	The MaterialX document to write.
predicate	A predicate function to determine if an element should be written. Default is to skip library elements.

Returns

The XML string representation of the MaterialX document.

Definition at line 107 of file core.py.

    def writeMaterialXDocString(doc, predicate=skipLibraryElement):
        '''
        @brief Utility to write a MaterialX document to string.
        @param doc The MaterialX document to write.
        @param predicate A predicate function to determine if an element should be written. Default is to skip library elements.
        @return The XML string representation of the MaterialX document.
        '''
        writeOptions = mx.XmlWriteOptions()
        writeOptions.writeXIncludeEnable = False
        writeOptions.elementPredicate = predicate
 
        result =  mx.writeToXmlString(doc, writeOptions)
        return result
    

writeMaterialXStringZip()

materialxgltf.core.Util.writeMaterialXStringZip ( mtlx_str, mtlx_filename, zip_filename, image_references, predicate = skipLibraryElement )

static

Utility to write a MaterialX document and its referenced images to a zip file.

Parameters

mtlx_str	The MaterialX document string to write.
mtlx_filename	The name of the MaterialX file to write within the zip file.
zip_filename	The name of the zip file to write to.
image_references	The list of image file references to include in the zip file.
predicate	A predicate function to determine if an element should be written. Default is to skip library elements.

Definition at line 88 of file core.py.

    def writeMaterialXStringZip(mtlx_str, mtlx_filename, zip_filename, image_references, predicate=skipLibraryElement):
        '''
        @brief Utility to write a MaterialX document and its referenced images to a zip file.
        @param mtlx_str The MaterialX document string to write.
        @param mtlx_filename The name of the MaterialX file to write within the zip file.
        @param zip_filename The name of the zip file to write to.
        @param image_references The list of image file references to include in the zip file.
        @param predicate A predicate function to determine if an element should be written. Default is to skip library elements.
        '''
        with zipfile.ZipFile(zip_filename, "w") as zipf:
            # Write MaterialX file
            zipf.writestr(mtlx_filename, mtlx_str)
            # Write texture files
            for path in image_references:
                zipf.write(path, os.path.basename(path))
        zipf.close( )
 
 

writeMaterialXZip()

materialxgltf.core.Util.writeMaterialXZip ( doc, mtlx_filename, zip_filename, image_references, predicate = skipLibraryElement )

static

Utility to write a MaterialX document and its referenced images to a zip file.

Parameters

doc	The MaterialX document to write.
mtlx_filename	The name of the MaterialX file to write within the zip file.
zip_filename	The name of the zip file to write to.
image_references	The list of image file references to include in the zip file.
predicate	A predicate function to determine if an element should be written. Default is to skip library elements.

Definition at line 75 of file core.py.

    def writeMaterialXZip(doc, mtlx_filename, zip_filename, image_references, predicate=skipLibraryElement):
        '''
        @brief Utility to write a MaterialX document and its referenced images to a zip file.
        @param doc The MaterialX document to write.
        @param mtlx_filename The name of the MaterialX file to write within the zip file.
        @param zip_filename The name of the zip file to write to.
        @param image_references The list of image file references to include in the zip file.
        @param predicate A predicate function to determine if an element should be written. Default is to skip library elements.
        '''
        mtlx_str = Util.writeMaterialXDocString(doc, predicate)
        Util.writeMaterialXStringZip(mtlx_str, mtlx_filename, zip_filename, image_references)
 

---

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

• core.py