Inheritance diagram for materialx_ocio_app.materialx_ocio_app:

Public Member Functions
	__init__ (self, homePage)
	Initialize the Flask application and the MaterialX loader.

	handle_get_config_info (self, data)
	Handle event and send back server information.

	get_materialx_info (self, targetColorSpace, createGraphs)

	handle_get_materialx_info (self, data)
	Handle event and send back server message 2.

	handle_get_version_info (self, data)

Public Member Functions inherited from materialx_ocio_app.MaterialXFlaskApp
	run (self, host, port, debug=True)
	Run the Flask server with SocketIO.

Public Attributes
	OCIO_version = OCIO.GetVersion()

	materialx_version = mx.getVersionString()

	generator = mxocio.OCIOMaterialaxGenerator()

	configs

	aconfig = self.generator.getBuiltinConfigs()

	config_info = self.generator.printConfigs(self.configs)

dict	event_handlers

Public Attributes inherited from materialx_ocio_app.MaterialXFlaskApp
	home = home

	app = Flask(__name__)

	socketio = SocketIO(self.app)

Protected Member Functions
	_emit_status_message (self, message)
	Emit a status message to the client.

	_setup_event_handler_map (self)
	Set up dictionary of mapping event names to their handlers.

Protected Member Functions inherited from materialx_ocio_app.MaterialXFlaskApp
	_register_routes (self)
	Register HTTP routes.

	_register_socket_events (self)
	Register SocketIO events.

Detailed Description

Definition at line 58 of file materialx_ocio_app.py.

Constructor & Destructor Documentation

◆ init()

materialx_ocio_app.materialx_ocio_app.__init__	(		self,
			homePage )

Initialize the Flask application and the MaterialX loader.

Reimplemented from materialx_ocio_app.MaterialXFlaskApp.

Definition at line 61 of file materialx_ocio_app.py.

    def __init__(self, homePage):
        """
        Initialize the Flask application and the MaterialX loader.
        """
        super().__init__(homePage)
 
        # Check OCIO version
        self.OCIO_version = OCIO.GetVersion()
        ocioVersion = self.OCIO_version.split('.')
        if len(ocioVersion) < 2:
            print('> OCIO version is not in the expected format.')
        if int(ocioVersion[0]) < 2 or int(ocioVersion[1]) < 2:
            print('> OCIO version 2.2 or greater is required.')
    
        print('> Using OCIO version:', self.OCIO_version)
 
        self.materialx_version = mx.getVersionString()
        print('> Using MaterialX version:', self.materialx_version)
 
        self.generator = mxocio.OCIOMaterialaxGenerator()
        #self.configs, self.aconfig = self.generator.getBuiltinConfigs()
 

Member Function Documentation

◆ _emit_status_message()

materialx_ocio_app.materialx_ocio_app._emit_status_message	(		self,
			message )

protected

Emit a status message to the client.

Definition at line 83 of file materialx_ocio_app.py.

    def _emit_status_message(self, message):
        """
        Emit a status message to the client.
        """
        emit('status_message', { 'message': message }, broadcast=True)
 

◆ _setup_event_handler_map()

materialx_ocio_app.materialx_ocio_app._setup_event_handler_map ( self )

protected

Set up dictionary of mapping event names to their handlers.

Reimplemented from materialx_ocio_app.MaterialXFlaskApp.

Definition at line 205 of file materialx_ocio_app.py.

    def _setup_event_handler_map(self):
        """
        Set up dictionary of mapping event names to their handlers
        """
        self.event_handlers = {
            'client_event_get_version_info': self.handle_get_version_info,
            'client_event_get_config_info': self.handle_get_config_info,
            'client_event_get_materialx_info': self.handle_get_materialx_info,
        }
 
# Main entry point

◆ get_materialx_info()

materialx_ocio_app.materialx_ocio_app.get_materialx_info	(	self,
		targetColorSpace,
		createGraphs )

Definition at line 99 of file materialx_ocio_app.py.

    def get_materialx_info(self, targetColorSpace, createGraphs):
        configs, aconfig = self.generator.getBuiltinConfigs()
        
        generator = self.generator
 
        # Generate MaterialX definitions and implementations for all color spaces
        # found in the ACES Cg Config and ACES Studio Config configurations.
        nodedef_string = ''
        nodedef_doc = mx.createDocument()
        impl_string = ''
        impl_doc = mx.createDocument()
        source_string = ''
        for c in configs:
            config = configs[c][0]
            for colorSpace in config.getColorSpaces():
                aliases = colorSpace.getAliases()
                trySource = ''
                for alias in aliases:
                    # Get alias if it does not contain a space
                    if ' ' not in alias:
                        trySource = alias
                if not trySource:
                    trySource = colorSpace.getName()
                if trySource:
                    sourceColorSpace = trySource
 
                    # Skip if the source and target are the same
                    if sourceColorSpace == targetColorSpace:
                        continue
 
                    print('--- Generate transform for source color space:', trySource, '---')
 
                    # Generate source code
                    if not createGraphs:
                        definitionDoc = mx.createDocument()
                        implDoc = mx.createDocument()
 
                        definition, transformName, code, extension, target = generator.generateOCIO(aconfig, definitionDoc, implDoc, sourceColorSpace, targetColorSpace, 'color4')
 
                        # Write the definition, implementation and source code files 
                        if definition:
 
                            #filename = outputPath / mx.FilePath(definition.getName() + '.' + 'mtlx')
                            #print('Write MaterialX definition file:', filename.asString())
                            #nodedef_string += mx.writeToXmlString(definitionDoc)
                            nodedef_doc.copyContentFrom(definitionDoc)                                
 
                            # Write the implementation document
                            #implFileName = outputPath / mx.FilePath('IM_' + transformName + '.' + 'mtlx')
                            #print('Write MaterialX implementation file:', implFileName.asString())
                            nodedef_doc.copyContentFrom(implDoc)
                            #implementationString = mx.writeToXmlString(implDoc)
 
                            #impl_string += implementationString
 
                            source_string += code
                    else:
                        # Generate node graph
                        outputType = 'color3'
                        graphDoc = generator.generateOCIOGraph(aconfig, sourceColorSpace, targetColorSpace, outputType)
                        if graphDoc:
                            nodedef_doc.copyContentFrom(graphDoc)                                
 
                            transformName = generator.createTransformName(sourceColorSpace, targetColorSpace, outputType, 'mxgraph_')
                            #filename = outputPath / mx.FilePath(transformName + '.' + 'mtlx')
                            #print('Write MaterialX node graph definition file:', filename.asString())
                            #nodedef_string = mx.writeToXmlString(nodedef_doc)
 
                else:
                    print('Could not find suitable color space name to use: ' + colorSpace.getName())
        
        nodedef_string = mx.writeToXmlString(nodedef_doc)
        if len(impl_doc.getChildren()) > 0:
            impl_string = mx.writeToXmlString(impl_doc)
        else:
            impl_string = None
        return nodedef_string, impl_string, source_string
 

◆ handle_get_config_info()

materialx_ocio_app.materialx_ocio_app.handle_get_config_info	(		self,
			data )

Handle event and send back server information.

Definition at line 89 of file materialx_ocio_app.py.

    def handle_get_config_info(self, data):
        '''
        Handle event and send back server information
        '''
        event_data = data.get('message', 'Message')
        self.configs, self.aconfig = self.generator.getBuiltinConfigs()
        self.config_info = self.generator.printConfigs(self.configs)
 
        emit('server_message_get_config_info', { 'message': self.config_info }, broadcast=True)
 

◆ handle_get_materialx_info()

materialx_ocio_app.materialx_ocio_app.handle_get_materialx_info	(		self,
			data )

Handle event and send back server message 2.

Definition at line 177 of file materialx_ocio_app.py.

    def handle_get_materialx_info(self, data):
        '''
        Handle event and send back server message 2
        '''
        createGraphs = data.get('nodegraphs', 'Node Graphs')
        
        targetColorSpace = 'lin_rec709'
        #createGraphs = True
        nodedef_string, impl_string, source_string = self.get_materialx_info(targetColorSpace, createGraphs)
 
        print('> Generatated MaterialX', nodedef_string != None)
        
        #server_message_get_mtlx_info = 'Using OCIO Version: ' + self.OCIO_version + '. MaterialX Version: ' + self.materialx_version
        emit('server_message_get_mtlx_info', 
             {  'nodedef_string': nodedef_string,
                'impl_string': impl_string,
                'source_string': source_string
              }, broadcast=True)
 

◆ handle_get_version_info()

materialx_ocio_app.materialx_ocio_app.handle_get_version_info	(		self,
			data )

Definition at line 196 of file materialx_ocio_app.py.

    def handle_get_version_info(self, data):
        print('> Get version information')
        emit('server_message_version_info', 
            {   
                'ocio_version': self.OCIO_version,
                'materialx_version':  self.materialx_version 
            },
            broadcast=True)
 

Member Data Documentation

◆ aconfig

materialx_ocio_app.materialx_ocio_app.aconfig = self.generator.getBuiltinConfigs()

Definition at line 94 of file materialx_ocio_app.py.

◆ config_info

materialx_ocio_app.materialx_ocio_app.config_info = self.generator.printConfigs(self.configs)

Definition at line 95 of file materialx_ocio_app.py.

◆ configs

materialx_ocio_app.materialx_ocio_app.configs

Definition at line 94 of file materialx_ocio_app.py.

◆ event_handlers

dict materialx_ocio_app.materialx_ocio_app.event_handlers

Initial value:

=  {
            'client_event_get_version_info': self.handle_get_version_info,
            'client_event_get_config_info': self.handle_get_config_info,
            'client_event_get_materialx_info': self.handle_get_materialx_info,
        }

Definition at line 209 of file materialx_ocio_app.py.

◆ generator

materialx_ocio_app.materialx_ocio_app.generator = mxocio.OCIOMaterialaxGenerator()

Definition at line 80 of file materialx_ocio_app.py.

◆ materialx_version

materialx_ocio_app.materialx_ocio_app.materialx_version = mx.getVersionString()

Definition at line 77 of file materialx_ocio_app.py.

◆ OCIO_version

materialx_ocio_app.materialx_ocio_app.OCIO_version = OCIO.GetVersion()

Definition at line 68 of file materialx_ocio_app.py.

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

materialx_ocio_app.py

Public Member Functions

Public Attributes

Protected Member Functions