Class for handling read and write of MaterialX from and to JSON. More...

Public Member Functions
dict	elementToJSON (self, mx.Element elem, dict jsonParent, JsonWriteOptions writeOptions=None)
	Convert an MaterialX XML element to JSON.

dict	documentToJSON (self, mx.Document doc, JsonWriteOptions writeOptions=None)
	Convert an MaterialX XML document to JSON.

str	documentToJSONString (self, mx.Document doc, JsonWriteOptions writeOptions=None)
	Convert an MaterialX XML document to JSON string.

None	elementFromJSON (self, dict node, mx.Element elem, JsonReadOptions readOptions=None)
	Convert an JSON element to MaterialX.

bool	documentFromJSON (self, dict jsonDoc, mx.Document doc, JsonReadOptions readOptions=None)
	Convert a JSON document to MaterialX.

bool	documentFromJSONString (self, str jsonString, mx.Document doc, JsonReadOptions readOptions=None)
	Convert a JSON document to MaterialX.

Detailed Description

Class for handling read and write of MaterialX from and to JSON.

Definition at line 63 of file core.py.

Member Function Documentation

◆ documentFromJSON()

bool materialxjson.core.MaterialXJson.documentFromJSON	(		self,
		dict	jsonDoc,
		mx.Document	doc,
		JsonReadOptions	readOptions = None )

Convert a JSON document to MaterialX.

Parameters

jsonDoc	The JSON document to read
doc	The MaterialX document to write to
readOptions	The read options to use. Default is None

Definition at line 205 of file core.py.

    def documentFromJSON(self, jsonDoc: dict, doc: mx.Document, readOptions: JsonReadOptions = None) -> bool:
        '''
        @brief Convert a JSON document to MaterialX
        @param jsonDoc The JSON document to read
        @param doc The MaterialX document to write to 
        @param readOptions The read options to use. Default is None
        '''
        readDoc = False
        # Check mimetype and existence of MaterialX root element
        if JSON_MIMETYPE_KEY in jsonDoc and jsonDoc[JSON_MIMETYPE_KEY] == JSON_MIMETYPE:
            if MATERIALX_DOCUMENT_ROOT in jsonDoc:
                self.elementFromJSON(jsonDoc['materialx'], doc, readOptions)
                readDoc = True
            else:
                print('JSON document is missing a MaterialX root element')
        else:
            print('JSON document is not a MaterialX document')
 
        if readDoc:
            # Upgrade to latest version if requested
            if readOptions and readOptions.upgradeVersion:
                doc.upgradeVersion()
 
        return readDoc
 

◆ documentFromJSONString()

bool materialxjson.core.MaterialXJson.documentFromJSONString	(		self,
		str	jsonString,
		mx.Document	doc,
		JsonReadOptions	readOptions = None )

Convert a JSON document to MaterialX.

Parameters

jsonString	The JSON string to read
doc	The MaterialX document to write to
readOptions	The read options to use. Default is None

Returns: True if successful, false otherwise

Definition at line 230 of file core.py.

    def documentFromJSONString(self, jsonString: str, doc: mx.Document, readOptions: JsonReadOptions = None) -> bool:
        '''
        @brief Convert a JSON document to MaterialX
        @param jsonString The JSON string to read
        @param doc The MaterialX document to write to 
        @param readOptions The read options to use. Default is None
        @return True if successful, false otherwise
        '''
        jsonDoc = json.loads(jsonString)
        readDoc = False
        if jsonDoc:
            readDoc = self.documentFromJSON(jsonDoc, doc, readOptions)
        return readDoc
 

◆ documentToJSON()

dict materialxjson.core.MaterialXJson.documentToJSON	(		self,
		mx.Document	doc,
		JsonWriteOptions	writeOptions = None )

Convert an MaterialX XML document to JSON.

Parameters

doc	The MaterialX document to convert
writeOptions	The write options to use. Default is None

Returns: The JSON document

Definition at line 120 of file core.py.

    def documentToJSON(self, doc: mx.Document, writeOptions: JsonWriteOptions = None) -> dict:
        '''
        Convert an MaterialX XML document to JSON
        @param doc The MaterialX document to convert
        @param writeOptions The write options to use. Default is None
        @return The JSON document
        '''
        root = {}
        # Set the mimetype
        root[JSON_MIMETYPE_KEY] = JSON_MIMETYPE
 
        # Create the document
        documentRoot = {}
 
        # Add document level attributes
        for attrName in doc.getAttributeNames():
            documentRoot[attrName] = doc.getAttribute(attrName)
 
        # Add children
        children = []
        for elem in doc.getChildren():
            self.elementToJSON(elem, children, writeOptions)
        documentRoot['children'] = children
 
        # Set 'materialx' root element 
        root[MATERIALX_DOCUMENT_ROOT] = documentRoot
 
        return root
    

◆ documentToJSONString()

str materialxjson.core.MaterialXJson.documentToJSONString	(		self,
		mx.Document	doc,
		JsonWriteOptions	writeOptions = None )

Convert an MaterialX XML document to JSON string.

Parameters

doc	The MaterialX document to convert
writeOptions	The write options to use. Default is None

Returns: The JSON string

Definition at line 149 of file core.py.

    def documentToJSONString(self, doc: mx.Document, writeOptions: JsonWriteOptions = None) -> str:
        '''
        Convert an MaterialX XML document to JSON string
        @param doc The MaterialX document to convert
        @param writeOptions The write options to use. Default is None
        @return The JSON string
        '''
        result = self.documentToJSON(doc, writeOptions)
        json_string = ''
        if result:
            indentation = 2
            sep = (',', ': ')
            if writeOptions:
                indentation = writeOptions.indent
                sep = writeOptions.separators
            json_string = json.dumps(result, indent=indentation, separators=sep)
 
        return json_string
 

◆ elementFromJSON()

None materialxjson.core.MaterialXJson.elementFromJSON	(		self,
		dict	node,
		mx.Element	elem,
		JsonReadOptions	readOptions = None )

Convert an JSON element to MaterialX.

Parameters

node	The JSON element to read
elem	The MaterialX element to write to
readOptions	The read options to use. Default is None

Definition at line 168 of file core.py.

    def elementFromJSON(self, node: dict, elem: mx.Element, readOptions: JsonReadOptions = None) -> None:
        '''
        @brief Convert an JSON element to MaterialX
        @param node The JSON element to read
        @param elem The MaterialX element to write to
        @param readOptions The read options to use. Default is None
        '''
        for key in node:
            value = node[key]
 
            # Set attributes            
            if isinstance(value, str):
                if key not in ['name', 'category']:
                    elem.setAttribute(key, str(value))
 
            # Traverse children
            elif key == INPUTS_STRING:
                for child in value:
                    category = 'input'
                    name = child['name']
                    childElem = elem.addChildOfCategory(category, name)
                    self.elementFromJSON(child, childElem)
                
            elif key == CHILDREN_STRING:
                for child in value:
                    category = child['category']
                    name = child['name']
                    childElem = elem.addChildOfCategory(category, name)
                    self.elementFromJSON(child, childElem)
 
            elif key == OUTPUTS_STRING:
                for child in value:
                    category = 'output'
                    name = child['name']
                    childElem = elem.addChildOfCategory(category, name)
                    self.elementFromJSON(child, childElem)
 

◆ elementToJSON()

dict materialxjson.core.MaterialXJson.elementToJSON	(		self,
		mx.Element	elem,
		dict	jsonParent,
		JsonWriteOptions	writeOptions = None )

Convert an MaterialX XML element to JSON.

Will recursively traverse the parent/child Element hierarchy.

Parameters

elem	The MaterialX element to convert
jsonParent	The JSON element append to
writeOptions	The write options to use. Default is None

Definition at line 67 of file core.py.

    def elementToJSON(self, elem: mx.Element, jsonParent: dict, writeOptions: JsonWriteOptions = None) -> dict:
        '''
        @brief Convert an MaterialX XML element to JSON.
        Will recursively traverse the parent/child Element hierarchy.
        @param elem The MaterialX element to convert
        @param jsonParent The JSON element append to
        @param writeOptions The write options to use. Default is None
        '''
        if (writeOptions and writeOptions.elementPredicate and not writeOptions.elementPredicate(elem)):
            return
 
        if (elem.getSourceUri() != ""):
            return
        
        # Create a new JSON element for the MaterialX element
        jsonElem = {}
        jsonElem['name'] = elem.getName()
        category = elem.getCategory()
        # It is redundant but not incorrect to add in the category
        # For now always add in the category
        if (writeOptions and writeOptions.addInputOutputCategories) or (category not in ['input', 'output']):
            jsonElem['category'] = category
        
        # Add attributes
        for attrName in elem.getAttributeNames():
            jsonElem[attrName] = elem.getAttribute(attrName)
 
        # Add children. Split based on category: input, output or other
        inputs = []
        outputs = []
        non_input_outputs = []
        for child in elem.getChildren():
            category = child.getCategory()
            if category == 'input':
                self.elementToJSON(child, inputs)
            elif category == 'output':
                self.elementToJSON(child, outputs)
            else:
                self.elementToJSON(child, non_input_outputs)
        
        # Add inputs, outputs and other children
        if len(inputs) > 0:
            jsonElem[INPUTS_STRING] = inputs
        if len(non_input_outputs) > 0:
            jsonElem[CHILDREN_STRING] = non_input_outputs
        if len(outputs) > 0:
            jsonElem[OUTPUTS_STRING] = outputs
 
        # Add the JSON element to the parent            
        jsonParent.append(jsonElem)
 
        return jsonParent
 

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

core.py

Public Member Functions

Detailed Description

Member Function Documentation

◆ documentFromJSON()

◆ documentFromJSONString()

◆ documentToJSON()

◆ documentToJSONString()

◆ elementFromJSON()

◆ elementToJSON()