materialx_serializer.MaterialXToProtobuf Class Reference

Converter class to transform MaterialX document objects into Protobuf MaterialXDocument messages. More...

Public Member Functions
	convert (self, doc)
	Convert a MaterialX document object to a Protobuf MaterialXDocument message.

Protected Member Functions
	_convert_element (self, mx_elem)
	Recursively convert a MaterialX element to a Protobuf MaterialXElement.

Detailed Description

Converter class to transform MaterialX document objects into Protobuf MaterialXDocument messages.

• Traverses the MaterialX document structure and constructs the corresponding Protobuf message hierarchy.
• Handles attributes and child elements recursively.
• Usage: converter = MaterialXToProtobuf() pb_doc = converter.convert(mx_doc)
• Where mx_doc is a MaterialX document object.

Member Function Documentation

_convert_element()

materialx_serializer.MaterialXToProtobuf._convert_element ( self, mx_elem )

protected

Recursively convert a MaterialX element to a Protobuf MaterialXElement.

Parameters

mx_elem

The MaterialX element to convert.

Returns

The resulting Protobuf MaterialXElement message.

    def _convert_element(self, mx_elem):
        """
        @brief Recursively convert a MaterialX element to a Protobuf MaterialXElement.
        @param mx_elem The MaterialX element to convert.
        @return The resulting Protobuf MaterialXElement message.
        """
        pb_elem = pb.MaterialXElement()
        pb_elem.name = mx_elem.getName()
        pb_elem.type = mx_elem.getCategory()
        
        # Copy all attributes preserving order
        for name in mx_elem.getAttributeNames():
            attr = pb_elem.attributes.add()
            attr.key = name
            attr.value = mx_elem.getAttribute(name)
        
        # Recursively convert children
        for child in mx_elem.getChildren():
            pb_child = self._convert_element(child)
            pb_elem.children.append(pb_child)
            
        return pb_elem
 

convert()

materialx_serializer.MaterialXToProtobuf.convert	(		self,
			doc )

Convert a MaterialX document object to a Protobuf MaterialXDocument message.

Parameters

doc	The MaterialX document object to convert.

Returns

The resulting Protobuf MaterialXDocument message.

    def convert(self, doc):
        """
        @brief Convert a MaterialX document object to a Protobuf MaterialXDocument message.
        @param doc The MaterialX document object to convert.
        @return The resulting Protobuf MaterialXDocument message.
        """
        pb_doc = pb.MaterialXDocument()
        
        # Set schema version
        pb_doc.schema_version.major = SCHEMA_VERSION_MAJOR
        pb_doc.schema_version.minor = SCHEMA_VERSION_MINOR
        pb_doc.schema_version.patch = SCHEMA_VERSION_PATCH
        
        # Store MaterialX version if available
        try:
            import MaterialX as mx
        except:
            pass
        
        for name in doc.getAttributeNames():
            attr = pb_doc.attributes.add()
            attr.key = name
            attr.value = doc.getAttribute(name)
        
        # Convert all root-level elements
        for child in doc.getChildren():
            pb_element = self._convert_element(child)
            pb_doc.elements.append(pb_element)
            
        return pb_doc
    

---

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

• materialx_serializer.py