Classes
class	glTFEnginePage
	Custom web engine page for the glTF viewer. More...

class	GLTFHighlighter
	Highlighter for glTF text. More...

class	QuiltiX_glTF_serializer
	glTF serializer for MaterialX More...

Functions
	load_qt_modules ()
	Function to delay loading of Qt modules until after the QuiltiX UI is initialized.

	after_ui_init ("quiltix.QuiltiXWindow" editor)
	After UI initialization, add the MaterialX glTF serializer to the editor.

str	plugin_name ()
	Get the name of the plugin.

bool	is_valid ()
	Check if the plugin is valid.

	__init__ (self)
	Initialize the JSON highlighter.

	highlight (self, text)
	Highlight the given JSON text.

Variables
bool	have_highliting = True

	logger = logging.getLogger(__name__)

bool	haveGLTF = False

bool	has_materialxjsoncore = True

	lexer = JsonLexer()

	formatter = HtmlFormatter(linenos=False, style='github-dark')

bool	use_pygments = False

bool	have_support_modules = True

Function Documentation

◆ init()

plugin.__init__ ( self )

Initialize the JSON highlighter.

Definition at line 43 of file materialxjson/plugin.py.

    def __init__(self):
        '''
        @brief Initialize the JSON highlighter
        '''
        self.lexer = JsonLexer()
        # We don't add line numbers since this get's copied with
        # copy-paste.
        self.formatter = HtmlFormatter(linenos=False, style='github-dark')
 

◆ after_ui_init()

plugin.after_ui_init ( "quiltix.QuiltiXWindow" editor )

After UI initialization, add the MaterialX glTF serializer to the editor.

Definition at line 609 of file materialxgltf/plugin.py.

def after_ui_init(editor: "quiltix.QuiltiXWindow"):
    '''
    @brief After UI initialization, add the MaterialX glTF serializer to the editor.
    '''
    logger.info("Adding MaterialX glTF serializer")
    loaded_qt = load_qt_modules()
    if loaded_qt:
        editor.gltf_serializer = QuiltiX_glTF_serializer(editor, constants.ROOT)
 

◆ highlight()

plugin.highlight	(		self,
			text )

Highlight the given JSON text.

Parameters

text	The JSON text to highlight

Returns: The highlighted HTML

Definition at line 52 of file materialxjson/plugin.py.

    def highlight(self, text):
        '''
        @brief Highlight the given JSON text
        @param text The JSON text to highlight
        @return The highlighted HTML
        '''
        highlighted_html = highlight(text, self.lexer, self.formatter)
        styles = (
            f"<style>"
            f"{self.formatter.get_style_defs('.highlight')}"
            f"pre {{ line-height: 1.0; margin: 0; }}"
            f"</style>"
        )
        full_html = f"<html><head>{styles}</head><body>{highlighted_html}</body></html>"     
        return full_html
 

◆ is_valid()

bool plugin.is_valid ( )

Check if the plugin is valid.

That is the glTF serializer module is installed.

Returns: True if the plugin is valid), False otherwise.

Definition at line 626 of file materialxgltf/plugin.py.

def is_valid() -> bool:
    '''
    @brief Check if the plugin is valid. That is the glTF serializer module is installed.
    @return True if the plugin is valid), False otherwise.
    '''
    return haveGLTF

◆ load_qt_modules()

plugin.load_qt_modules ( )

Function to delay loading of Qt modules until after the QuiltiX UI is initialized.

Definition at line 21 of file materialxgltf/plugin.py.

def load_qt_modules():
    global QtCore, QAction, QTextEdit, QDockWidget, QVBoxLayout, QWidget
    try:
        from qtpy import QtCore  # type: ignore
        from qtpy.QtWidgets import QAction, QDockWidget, QVBoxLayout, QTextEdit, QWidget    
        logger.info("qtpy modules loaded successfully")
        return True
    except ImportError as e:
        logger.error(f"Failed to import qtpy modules: {e}")
        return False
 

◆ plugin_name()

str plugin.plugin_name ( )

Get the name of the plugin.

Returns: The name of the plugin.

Definition at line 618 of file materialxgltf/plugin.py.

def plugin_name() -> str:
    '''
    @brief Get the name of the plugin.
    @return The name of the plugin.'''
    if haveGLTF:
        return "MaterialX glTF Serializer"
    return ""
 

Variable Documentation

◆ formatter

plugin.formatter = HtmlFormatter(linenos=False, style='github-dark')

Definition at line 50 of file materialxjson/plugin.py.

◆ has_materialxjsoncore

bool plugin.has_materialxjsoncore = True

Definition at line 27 of file materialxjson/plugin.py.

◆ have_highliting

bool plugin.have_highliting = True

Definition at line 11 of file materialxgltf/plugin.py.

◆ have_support_modules

bool plugin.have_support_modules = True

Definition at line 46 of file materialxslx/plugin.py.

◆ haveGLTF

bool plugin.haveGLTF = False

Definition at line 47 of file materialxgltf/plugin.py.

◆ lexer

plugin.lexer = JsonLexer()

Definition at line 47 of file materialxjson/plugin.py.

◆ logger

plugin.logger = logging.getLogger(__name__)

Definition at line 42 of file materialxgltf/plugin.py.

◆ use_pygments

bool plugin.use_pygments = False

Definition at line 17 of file materialxslx/plugin.py.

Classes

Functions

Variables