materialxjson.core.Util Class Reference

Utility class for MaterialX JSON. More...

Static Public Member Functions
dict	readJson (str fileName)
	Read a JSON file.
dict	jsonStringToJson (str jsonString)
	Convert a JSON string to a JSON document.
str	jsonToJSONString (dict jsonObject, indentation=2)
	Convert a JSON document to a JSON string.
str	documentToXMLString (mx.Document doc)
	Convert a MaterialX document to XML string.
None	xmlStringToDocument (mx.Document doc, str xmlString)
	Convert an XML string to a MaterialX document.
None	writeJson (dict jsonObject, str fileName, indentation=2)
	Write a JSON document to file.
list	getFiles (str rootPath, str extension)
	Get all files with the given extension from the given root path.
tuple	loadLibraries (mx.FileSearchPath searchPath, list libraryFolders)
	Load all libraries from the given search path and library folders.
mx.Document	jsonFileToXml (str fileName, JsonReadOptions readOptions=None)
	Convert a JSON file to an XML file.
bool	jsonFileToXmlFile (str fileName, str outputFilename, JsonReadOptions readOptions=None)
	Convert a JSON file to an XML file.
None	xmlFileToJsonFile (str xmlFileName, str jsonFileName, JsonWriteOptions writeOptions=None)
	Convert an MaterialX XML file to a JSON file.

Detailed Description

Utility class for MaterialX JSON.

Definition at line 244 of file core.py.

Member Function Documentation

documentToXMLString()

str materialxjson.core.Util.documentToXMLString ( mx.Document doc )

static

Convert a MaterialX document to XML string.

Parameters

doc	The MaterialX document to convert

Returns

The XML string

Definition at line 284 of file core.py.

    def documentToXMLString(doc: mx.Document) -> str:
        '''
        @brief Convert a MaterialX document to XML string
        @param doc The MaterialX document to convert
        @return The XML string
        '''
        return mx.writeToXmlString(doc)
    

getFiles()

list materialxjson.core.Util.getFiles ( str rootPath, str extension )

static

Get all files with the given extension from the given root path.

Parameters

rootPath	The root path to search from
extension	The extension to search for

Returns

A list of file paths

Definition at line 312 of file core.py.

    def getFiles(rootPath: str, extension: str) -> list:
        '''
        @brief Get all files with the given extension from the given root path
        @param rootPath The root path to search from
        @param extension The extension to search for
        @return A list of file paths
        '''
        filelist = []
        exts = (extension, extension.upper() )
        for subdir, dirs, files in os.walk(rootPath):
            for file in files:
                if file.lower().endswith(exts):
                    filelist.append(os.path.join(subdir, file)) 
        return filelist
 

jsonFileToXml()

mx.Document materialxjson.core.Util.jsonFileToXml ( str fileName, JsonReadOptions readOptions = None )

static

Convert a JSON file to an XML file.

Parameters

fileName	The file name to read from
readOptions	The read options to use. Default is None

Returns

The MaterialX document if successful, None otherwise

Definition at line 346 of file core.py.

    def jsonFileToXml(fileName: str, readOptions: JsonReadOptions = None) -> mx.Document:
        '''
        @brief Convert a JSON file to an XML file
        @param fileName The file name to read from
        @param readOptions The read options to use. Default is None
        @return The MaterialX document if successful, None otherwise
        '''
        mtlxjson = MaterialXJson()
 
        jsonFile = open(fileName, 'r')
        if not jsonFile:
            return None
        jsonObject = json.load(jsonFile)
        if not jsonObject:
            return None
 
        newDoc = mx.createDocument() 
        readDoc = mtlxjson.documentFromJSON(jsonObject, newDoc, readOptions)
        if readDoc:
            return newDoc
 
        return None
 

jsonFileToXmlFile()

bool materialxjson.core.Util.jsonFileToXmlFile ( str fileName, str outputFilename, JsonReadOptions readOptions = None )

static

Convert a JSON file to an XML file.

Parameters

fileName	The file name to read from
outputFilename	The file name to write to
readOptions	The read options to use. Default is None

Returns

True if successful, false otherwise

Definition at line 370 of file core.py.

    def jsonFileToXmlFile(fileName: str, outputFilename: str, readOptions: JsonReadOptions = None) -> bool:
        '''
        @brief Convert a JSON file to an XML file
        @param fileName The file name to read from
        @param outputFilename The file name to write to
        @param readOptions The read options to use. Default is None
        @return True if successful, false otherwise
        '''
        jsonFile = open(fileName, 'r')
        if not jsonFile:
            return None
        jsonObject = json.load(jsonFile)
        if not jsonObject:
            return None
 
        #newDoc = mx.createDocument() 
        mtlxjson = MaterialXJson()
        newDoc = mx.createDocument()
        created = mtlxjson.documentFromJSON(jsonObject, newDoc, readOptions)
 
        if newDoc.getChildren():
            mx.writeToXmlFile(newDoc, outputFilename)    
            return True
 
        return False
 

jsonStringToJson()

dict materialxjson.core.Util.jsonStringToJson ( str jsonString )

static

Convert a JSON string to a JSON document.

Parameters

jsonString

The JSON string to convert

Returns

The JSON document

Definition at line 266 of file core.py.

    def jsonStringToJson(jsonString: str) -> dict:
        '''
        @brief Convert a JSON string to a JSON document
        @param jsonString The JSON string to convert
        @return The JSON document
        '''
        return json.loads(jsonString)
    

jsonToJSONString()

str materialxjson.core.Util.jsonToJSONString ( dict jsonObject, indentation = 2 )

static

Convert a JSON document to a JSON string.

Parameters

jsonObject

The JSON document to convert

Returns

The JSON string

Definition at line 275 of file core.py.

    def jsonToJSONString(jsonObject: dict, indentation = 2) -> str:
        '''
        @brief Convert a JSON document to a JSON string
        @param jsonObject The JSON document to convert
        @return The JSON string
        '''
        return json.dumps(jsonObject, indent=indentation)
    

loadLibraries()

tuple materialxjson.core.Util.loadLibraries ( mx.FileSearchPath searchPath, list libraryFolders )

static

Load all libraries from the given search path and library folders.

Parameters

searchPath	The search path to use
libraryFolders	The library folders to use

Returns

A tuple containing the library document and a status string

Definition at line 328 of file core.py.

    def loadLibraries(searchPath: mx.FileSearchPath, libraryFolders: list) -> tuple:
        '''
        @brief Load all libraries from the given search path and library folders
        @param searchPath The search path to use
        @param libraryFolders The library folders to use
        @return A tuple containing the library document and a status string
        '''
        status = ''
        lib = mx.createDocument()
        try:
            libFiles = mx.loadLibraries(libraryFolders, searchPath, lib)
            status = '- Loaded %d library definitions from %d files' % (len(lib.getNodeDefs()), len(libFiles))
        except mx.Exception as err:
            status = '- Failed to load library definitions: "%s"' % err
 
        return lib, status
    

readJson()

dict materialxjson.core.Util.readJson ( str fileName )

static

Read a JSON file.

Parameters

fileName

The file name to read

Returns

The JSON document

Definition at line 249 of file core.py.

    def readJson(fileName: str) -> dict:
        '''
        @brief Read a JSON file
        @param fileName The file name to read
        @return The JSON document
        '''
        jsonFile = open(fileName, 'r')
        if not jsonFile:
            return False
 
        jsonObject = json.load(jsonFile)
        if not jsonObject:
            return False
 
        return jsonObject
    

writeJson()

None materialxjson.core.Util.writeJson ( dict jsonObject, str fileName, indentation = 2 )

static

Write a JSON document to file.

Parameters

jsonObject	The JSON document to write
fileName	The file name to write to

Definition at line 302 of file core.py.

    def writeJson(jsonObject: dict, fileName: str, indentation = 2) -> None:
        '''
        @brief Write a JSON document to file
        @param jsonObject The JSON document to write
        @param fileName The file name to write to
        '''
        with open(fileName, 'w') as outfile:
            json.dump(jsonObject, outfile, indent=indentation)
 

xmlFileToJsonFile()

None materialxjson.core.Util.xmlFileToJsonFile ( str xmlFileName, str jsonFileName, JsonWriteOptions writeOptions = None )

static

Convert an MaterialX XML file to a JSON file.

Parameters

xmlFileName	The XML file to read from
jsonFileName	The JSON file to write to
writeOptions	The write options to use. Default is None

Definition at line 397 of file core.py.

    def xmlFileToJsonFile(xmlFileName: str, jsonFileName: str, writeOptions: JsonWriteOptions = None) -> None:
        '''
        Convert an MaterialX XML file to a JSON file
        @param xmlFileName The XML file to read from
        @param jsonFileName The JSON file to write to
        @param writeOptions The write options to use. Default is None
        '''
        mtlxjson = MaterialXJson()
 
        doc = mx.createDocument()
        mx.readFromXmlFile(doc, xmlFileName)
        if doc:
            # Convert entire document to JSON
            doc_result = mtlxjson.documentToJSON(doc, writeOptions)
 
            # Write JSON to file
            with open(jsonFileName, 'w') as outfile:
                indentation = 2
                sep = (',', ': ')
                if writeOptions:
                    indentation = writeOptions.indent
                    sep = writeOptions.separators
                json.dump(doc_result, outfile, indent=indentation, separators=sep)
 

xmlStringToDocument()

None materialxjson.core.Util.xmlStringToDocument ( mx.Document doc, str xmlString )

static

Convert an XML string to a MaterialX document.

Parameters

doc	The MaterialX document to write to
xmlString	The XML string to convert

Definition at line 293 of file core.py.

    def xmlStringToDocument(doc: mx.Document, xmlString: str) -> None:
        '''
        @brief Convert an XML string to a MaterialX document
        @param doc The MaterialX document to write to
        @param xmlString The XML string to convert
        '''
        mx.readFromXmlString(doc, xmlString)
 

---

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

• core.py