MaterialXConversionApp.MaterialXConversionApp Class Reference

Inheritance diagram for MaterialXConversionApp.MaterialXConversionApp:

Public Member Functions
	__init__ (self, homePage)
	Constructor.
	handle_page_loaded (self, data)
	Handle page load / startup feedback.
	handle_load_materialx (self, data)
	Handle loading in of MaterialX document.
	handle_render_materialx (self, data)
	Handle request to render MaterialX document.
	handle_convert_to_usd (self, data)
	Handle request to convert MaterialX to USD.
	handle_convert_to_glTF (self, data)
	Handle request to convert MaterialX to glTF Texture Procedural graph.
	handle_have_gltf_converter (self)
	Handle query to see if glTF converter is available.
Public Member Functions inherited from MaterialXConversionApp.MaterialXFlaskApp
	run (self, host, port, deployment_platform, debug=True)
	Run the Flask server with SocketIO.

Static Public Member Functions
	convert_png_to_base64 (file_path)
	Utility to load in png image from disk and return Base64 representation.

Public Attributes
dict	event_handlers
Public Attributes inherited from MaterialXConversionApp.MaterialXFlaskApp
	home = home
	app = Flask(__name__)
	socketio = SocketIO(self.app)
str	deployment_platform = 'Local'
	os_details = get_os_details()

Protected Member Functions
	_setup_event_handler_map (self)
	Set up dictionary of mapping event names to their handlers.
Protected Member Functions inherited from MaterialXConversionApp.MaterialXFlaskApp
	_register_routes (self)
	Register HTTP routes.
	_register_socket_events (self)
	Register SocketIO events.

Detailed Description

Definition at line 89 of file MaterialXConversionApp.py.

Constructor & Destructor Documentation

__init__()

MaterialXConversionApp.MaterialXConversionApp.__init__	(		self,
			homePage )

Constructor.

Reimplemented from MaterialXConversionApp.MaterialXFlaskApp.

Definition at line 92 of file MaterialXConversionApp.py.

    def __init__(self, homePage):
        '''
        Constructor
        '''
        super().__init__(homePage)
 

Member Function Documentation

_setup_event_handler_map()

MaterialXConversionApp.MaterialXConversionApp._setup_event_handler_map ( self )

protected

Set up dictionary of mapping event names to their handlers.

Reimplemented from MaterialXConversionApp.MaterialXFlaskApp.

Definition at line 98 of file MaterialXConversionApp.py.

    def _setup_event_handler_map(self):
        '''
        Set up dictionary of mapping event names to their handlers
        '''
        event_map = {}
        event_map['page_loaded'] = self.handle_page_loaded
 
        self.event_handlers = {
            'page_loaded': self.handle_page_loaded,
            'load_materialx': self.handle_load_materialx,
            'render_materialx': self.handle_render_materialx, 
            'convert_mtlx_to_usd': self.handle_convert_to_usd,
            'convert_mtlx_to_gltf': self.handle_convert_to_glTF,
            'query_have_gltf_converter': self.handle_have_gltf_converter,
        }
 

convert_png_to_base64()

MaterialXConversionApp.MaterialXConversionApp.convert_png_to_base64 ( file_path )

static

Utility to load in png image from disk and return Base64 representation.

Definition at line 234 of file MaterialXConversionApp.py.

    def convert_png_to_base64(file_path):
        '''
        Utility to load in png image from disk and return Base64 
        representation
        '''
        with open(file_path, "rb") as image_file:
            binary_data = image_file.read()
            return base64.b64encode(binary_data).decode('utf-8')
 

handle_convert_to_glTF()

MaterialXConversionApp.MaterialXConversionApp.handle_convert_to_glTF	(		self,
			data )

Handle request to convert MaterialX to glTF Texture Procedural graph.

Definition at line 202 of file MaterialXConversionApp.py.

    def handle_convert_to_glTF(self, data):
        '''
        Handle request to convert MaterialX to glTF Texture Procedural
        graph
        '''
        if not have_gltf_converter:
            emit('gltf_converted', {'document': '{}'}, broadcast=True)
            return
 
        materialx_string = data.get('materialxDocument', '')
        print('> Server: convert_to_glTF event received')
        stdlib, _ = MxGLTFPTUtil.load_standard_libraries()
        doc = MxGLTFPTUtil.create_working_document([stdlib])
        if len(materialx_string) == 0:
            return
        mx.readFromXmlString(doc, materialx_string)
        print('>> MaterialX document loaded')
        converter = MxGLTFPT.glTFMaterialXConverter()
        json_string, status = converter.materialX_to_glTF(doc)
        if not json_string:
            print('>> Error converting to glTF:', status)
            json_string = '{}'
        print('>> glTF JSON created:')
        emit('gltf_converted', {'document': json_string}, broadcast=True)
 

handle_convert_to_usd()

MaterialXConversionApp.MaterialXConversionApp.handle_convert_to_usd	(		self,
			data )

Handle request to convert MaterialX to USD.

Definition at line 179 of file MaterialXConversionApp.py.

    def handle_convert_to_usd(self, data):
        '''
        Handle request to convert MaterialX to USD
        '''
        if not have_usd_converter:
            emit('usd_converted', {'usdDocument': ''}, broadcast=True)
            return
 
        materialx_string = data.get('materialxDocument', '')
        print('> Server: convert-to-usd event received')
        doc = mx.createDocument()
        if len(materialx_string) == 0:
            return
        try:
            mx.readFromXmlString(doc, materialx_string)
            print('>> MaterialX document loaded')
            stage_string = convertMtlxToUsd(doc, True)
            print('>> USD stage created.')
            emit('usd_converted', {'usdDocument': stage_string}, broadcast=True)
        except Exception as e:
            print(f'>> Error during USD conversion: {e}')
            emit('usd_converted', {'usdDocument': ''}, broadcast=True)
 

handle_have_gltf_converter()

MaterialXConversionApp.MaterialXConversionApp.handle_have_gltf_converter

(

self

)

Handle query to see if glTF converter is available.

Definition at line 227 of file MaterialXConversionApp.py.

    def handle_have_gltf_converter(self):
        '''
        Handle query to see if glTF converter is available
        '''
        emit('have_gltf_converter', {'have_gltf_converter': have_gltf_converter}, broadcast=True)
 

handle_load_materialx()

MaterialXConversionApp.MaterialXConversionApp.handle_load_materialx	(		self,
			data )

Handle loading in of MaterialX document.

Definition at line 121 of file MaterialXConversionApp.py.

    def handle_load_materialx(self, data):
        '''
        Handle loading in of MaterialX document
        '''
        materialx_file = data.get('materialxFile', 'Default MaterialX File')
        print('> Server: load materialx event received. File:', materialx_file)
        materialx_content = data.get('content', 'MaterialX content')
        doc = mx.createDocument()
        if len(materialx_content) == 0:
            return
        mx.readFromXmlString(doc, materialx_content)
        print('>> MaterialX Document loaded')
        doc_string = mx.writeToXmlString(doc)
        emit('materialx_loaded', {'materialxDocument': doc_string}, broadcast=True)
 

handle_page_loaded()

MaterialXConversionApp.MaterialXConversionApp.handle_page_loaded	(		self,
			data )

Handle page load / startup feedback.

Definition at line 114 of file MaterialXConversionApp.py.

    def handle_page_loaded(self, data):
        '''
        Handle page load / startup feedback
        '''
        status = '> Using MaterialX version: ' + mx.getVersionString()
        emit('materialx_version', {'status': status}, broadcast=True)
 

handle_render_materialx()

MaterialXConversionApp.MaterialXConversionApp.handle_render_materialx	(		self,
			data )

Handle request to render MaterialX document.

Definition at line 136 of file MaterialXConversionApp.py.

    def handle_render_materialx(self, data):
        '''
        Handle request to render MaterialX document
        '''
        materialx_string = data.get('materialxDocument', 'MaterialX content')
        print('> Server: render_materialx event received')
 
        # Get environment variable: MATERIALX_DEFAULT_VIEWER
        ilm_viewer = os.getenv('MATERIALX_DEFAULT_VIEWER', '')
        if len(ilm_viewer) == 0:
            print('>> MATERIALX_DEFAULT_VIEWER environment variable not set')
            return
 
        doc = mx.createDocument()
        if len(materialx_string) == 0:
            return
 
        stdlib = mx.createDocument()
        mx.loadLibraries(mx.getDefaultDataLibraryFolders(), mx.getDefaultDataSearchPath(), stdlib)
        doc.importLibrary(stdlib)
        mx.readFromXmlString(doc, materialx_string)
 
        # Get platform temporary folder location
        temp_location = os.getenv('TEMP', '/tmp')
        if not os.path.exists(temp_location):
            temp_location = '/tmp'
        # Generate a temp file name based on the current date and time
        temp_name = datetime.datetime.now().strftime('%Y%m%d%H%M%S') + '.mtlx'
        temp_file = f'{temp_location}/{temp_name}'
        mx.writeToXmlFile(doc, temp_file)
        capture_filename = temp_file.replace(".mtlx", ".png")
        cmd = f'{ilm_viewer} --screenWidth 512 --screenHeight 512 '
        cmd += f' --captureFilename {capture_filename} --material {temp_file}'
        print('>> Rendering:', cmd)
        os.system(cmd)
        # Delete the temp files
        os.remove(temp_file)
 
        image_base64 = self.convert_png_to_base64(capture_filename)
        os.remove(capture_filename)
        print('>> Emit materialx_rendered event')
        emit('materialx_rendered', {'image': image_base64}, broadcast=True)
 

Member Data Documentation

event_handlers

dict MaterialXConversionApp.MaterialXConversionApp.event_handlers

Initial value:

=  {
            'page_loaded': self.handle_page_loaded,
            'load_materialx': self.handle_load_materialx,
            'render_materialx': self.handle_render_materialx, 
            'convert_mtlx_to_usd': self.handle_convert_to_usd,
            'convert_mtlx_to_gltf': self.handle_convert_to_glTF,
            'query_have_gltf_converter': self.handle_have_gltf_converter,
        }

Definition at line 105 of file MaterialXConversionApp.py.

---

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

• MaterialXConversionApp.py