materialx_ocio_app.MaterialXFlaskApp Class Reference

Inheritance diagram for materialx_ocio_app.MaterialXFlaskApp:

Public Member Functions
	__init__ (self, home)
	run (self, host, port, debug=True)
	Run the Flask server with SocketIO.

Public Attributes
	home = home
	app = Flask(__name__)
	socketio = SocketIO(self.app)

Protected Member Functions
	_register_routes (self)
	Register HTTP routes.
	_setup_event_handler_map (self)
	Pure virtual method: Must be implemented by subclasses.
	_register_socket_events (self)
	Register SocketIO events.

Detailed Description

Definition at line 13 of file materialx_ocio_app.py.

Constructor & Destructor Documentation

__init__()

materialx_ocio_app.MaterialXFlaskApp.__init__	(		self,
			home )

Reimplemented in materialx_ocio_app.materialx_ocio_app.

Definition at line 14 of file materialx_ocio_app.py.

    def __init__(self, home):
        self.home = home
 
        # Initialize Flask and SocketIO
        self.app = Flask(__name__)
        self.socketio = SocketIO(self.app)
 
        # Register routes and events
        self._register_routes()
        self._setup_event_handler_map()
        self._register_socket_events()
 

Member Function Documentation

_register_routes()

materialx_ocio_app.MaterialXFlaskApp._register_routes ( self )

protected

Register HTTP routes.

Definition at line 26 of file materialx_ocio_app.py.

    def _register_routes(self):
        """
        Register HTTP routes.
        """
        @self.app.route('/')
        def home():
            """
            Render the home page.
            """
            #status_message = f'Startup: Using MaterialX version: {mx.getVersionString()}'
            #self._emit_status_message(status_message)
            return render_template(self.home)
 

_register_socket_events()

materialx_ocio_app.MaterialXFlaskApp._register_socket_events ( self )

protected

Register SocketIO events.

Definition at line 43 of file materialx_ocio_app.py.

    def _register_socket_events(self):
        """
        Register SocketIO events.
        """
        # Dynamically register event handlers
        for event_name, handler in self.event_handlers.items():
            self.socketio.on_event(event_name, handler)        
 

_setup_event_handler_map()

materialx_ocio_app.MaterialXFlaskApp._setup_event_handler_map ( self )

protected

Pure virtual method: Must be implemented by subclasses.

Reimplemented in materialx_ocio_app.materialx_ocio_app.

Definition at line 39 of file materialx_ocio_app.py.

    def _setup_event_handler_map(self):
        """Pure virtual method: Must be implemented by subclasses."""
        raise NotImplementedError("Subclasses must implement _setup_event_handler_map")
 

run()

materialx_ocio_app.MaterialXFlaskApp.run	(		self,
			host,
			port,
			debug = True )

Run the Flask server with SocketIO.

Definition at line 51 of file materialx_ocio_app.py.

    def run(self, host, port, debug=True):
        """
        Run the Flask server with SocketIO.
        """
        self.socketio.run(self.app, host, port, debug=debug)
 
 

Member Data Documentation

app

materialx_ocio_app.MaterialXFlaskApp.app = Flask(__name__)

Definition at line 18 of file materialx_ocio_app.py.

home

materialx_ocio_app.MaterialXFlaskApp.home = home

Definition at line 15 of file materialx_ocio_app.py.

socketio

materialx_ocio_app.MaterialXFlaskApp.socketio = SocketIO(self.app)

Definition at line 19 of file materialx_ocio_app.py.

---

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

• materialx_ocio_app.py