MxMaterialXMonitor Class Reference

Custom monitor class for MaterialX graph. More...

Inheritance diagram for MxMaterialXMonitor:

Public Member Functions
	constructor (name)
	onDocumentChange (attribute, value, prevValue)
	onConnectionChange (node, parentGraph)
	onNodeRemoved (node, parentGraph)
	onNodeRenamed (node, newName)
	onPropertyInfoChanged (nodeName, propertyName, propertyInfoName, newValue, previousValue, node)
	onPropertyChanged (nodeName, propertyName, newValue, previousValue, node)
Public Member Functions inherited from MxGraphMonitor
	constructor (name)
	debugMessage (text, path)
	Output a debug message to the console.
	getPath (node, parentGraph)
	Get a '/' separated path.
	onDocumentChange (attribute, value, prevValue)
	Callback for when a scene / document level change is made.
	onConnectionChange (node, parentGraph)
	Callback for when a connection changes in the graph.
	onConnectOutput (slot, input_type, input, target_node, target_slot, node)
	Callback for connection to output.
	onConnectInput (target_slot, output_type, output, source, slot, node)
	Callback for connection to output.
	onNodeAdded (node, parentGraph)
	Callback for when a node is added to the graph.
	onNodeRemoved (node, parentGraph)
	Callback for when a node is removed from the graph.
	getParentPath (node)
	Get the parent path of a node.
	onNodeRenamed (node, newName)
	Callback for when a node is renamed in the graph.
	onNodeSelected (node, parentGraph)
	Callback for when a node is selected in the graph.
	onNodeDeselected (node, parentGraph)
	Callback for when a node is deselected in the graph.
	onPropertyChanged (nodeName, propertyName, newValue, previousValue, node)
	Callback for when a property changes on a node in the graph.
	onPropertyInfoChanged (nodeName, propertyName, propertyInfoName, newValue, previousValue, node)
	Callback for when a property info changes on a node in the graph.
	getName ()
	Get the name of the monitor.
	setRenderer (theRenderer)
	Set the renderer for the monitor.
	getRenderer ()
	Get the renderer for the monitor.
	setMonitoring (monitor)
	Set the monitoring state of the monitor.
	getMonitoring ()
	Get the monitoring state of the monitor.
	setOnConnectionChange (callback)
	Set connection change callback.
	setOnNodeAdded (callback)
	Set node added callback.
	setOnNodeRemoved (callback)
	Set node removed callback.
	setOnNodeRenamed (callback)
	Set node renamed callback.
	setOnNodeSelected (callback)
	Set node selected callback.
	setOnNodeDeselected (callback)
	Set node deselected callback.
	setOnPropertyChanged (callback)
	Set property changed callback.
	monitorGraph (theGraph, monitor)
	Core monitoring of graph changes.

Detailed Description

Custom monitor class for MaterialX graph.

Allows updates to be passed to any renderer used.

Definition at line 23 of file node_editor.js.

Member Function Documentation

constructor()

MxMaterialXMonitor::constructor

(

name

)

Definition at line 24 of file node_editor.js.

                      {
        super(name);
    }

onConnectionChange()

MxMaterialXMonitor::onConnectionChange	(		node,
			parentGraph )

Definition at line 48 of file node_editor.js.

                                          {
        if (!this.monitoring) {
            return;
        }
 
        if (this.renderer)
            {
                toggleRequireUpdateUI();
        }
        if (this.debug) {
            this.debugMessage('Monitor> Connection change: ', this.getPath(node, parentGraph));
        }
    }

onDocumentChange()

MxMaterialXMonitor::onDocumentChange	(		attribute,
			value,
			prevValue )

Definition at line 28 of file node_editor.js.

                                                  {
        // To avoid toggle a change when the colorspace is not set
        if (attribute == 'colorspace' && !value)
        {
            value = 'lin_rec709';
        }    
 
        if (!this.monitoring || (prevValue == value)) {
            return;
        }
 
        if (this.renderer)
        {
            toggleRequireUpdateUI();
        }
        if (this.debug) {
            this.debugMessage('Monitor> Document attribute "' + attribute + '" changed from: ' + prevValue + ' to: ' + value, '');
        }
    }

onNodeRemoved()

MxMaterialXMonitor::onNodeRemoved	(		node,
			parentGraph )

Definition at line 62 of file node_editor.js.

                                     {
        if (!this.monitoring) {
            return;
        }
 
        if (this.renderer)
        {
            toggleRequireUpdateUI();
        }
        if (this.debug) {
            this.debugMessage('Monitor> Node removed: ', this.getPath(node, parentGraph));
        }
    }

onNodeRenamed()

MxMaterialXMonitor::onNodeRenamed	(		node,
			newName )

Definition at line 76 of file node_editor.js.

                                 {
        if (!this.monitoring) {
            return;
        }
 
        if (this.renderer)
        {
            toggleRequireUpdateUI();
        }
    
        if (this.debug) {
            let parentPath = this.getParentPath(node);
            let path = parentPath + node.title;
            let newpath = parentPath + newName;
            this.debugMessage('Monitor> Node renamed: ', path + ' to: ' + newpath);
        }
    }

onPropertyChanged()

MxMaterialXMonitor::onPropertyChanged	(		nodeName,
			propertyName,
			newValue,
			previousValue,
			node )

Definition at line 113 of file node_editor.js.

                                                                             {
        if (!this.monitoring || (previousValue == newValue)) {
            return;
        }
 
        let path = this.getParentPath(node) + nodeName;
 
        if (this.renderer) {
            if (typeof newValue == 'string') {
                toggleRequireUpdateUI();
                if (this.debug) {
                    console.log('Renderer> Build required for string change:', path, '. Property: ' + propertyName +
                        '. Value: ' + newValue + '. Previous Value: ' + previousValue + '. Node: ' + node.nodedef_node);
                }
            }
            else {
                if (node.nodedef_node != 'input')
                    path = path + '/' + propertyName;
                this.renderer.updateShader(path, newValue);
            }
        }
        else {
            if (this.debug) {
                console.log('Monitor> Property changed:', path, '. Property: ' + propertyName +
                    '. Value: ' + newValue + '. Previous Value: ' + previousValue + '. Node: ' + node.nodedef_node);
            }
        }
    }

onPropertyInfoChanged()

MxMaterialXMonitor::onPropertyInfoChanged	(		nodeName,
			propertyName,
			propertyInfoName,
			newValue,
			previousValue,
			node )

Definition at line 94 of file node_editor.js.

                                                                                                   {
        if (!this.monitoring || (previousValue == newValue)) {
            return;
        }
 
        if (this.renderer)
        {
            toggleRequireUpdateUI();
        }
    
 
        if (this.debug) {
            let path = this.getParentPath(node) + nodeName;
            console.log('Monitor> Property Info changed:', path, '. Property: ' + propertyName +
                '. Property Info: ' + propertyInfoName +
                '. Value: ' + newValue + '. Previous Value: ' + previousValue, '. Category:', node.nodedef_node);
        }
    }

---

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

• node_editor.js