This class provides a monitoring interface for the graph editor. More...

Inheritance diagram for MxGraphMonitor:

Public Member Functions
	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.

	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

This class provides a monitoring interface for the graph editor.

It will monitor the following changes to the graph:

Connection changed
Node added
Node removed
Node renamed
Node selected
Node deselected
Property changed
Property info changed

Definition at line 25 of file JsMaterialXNodeEditor.js.

Member Function Documentation

◆ constructor()

MxGraphMonitor::constructor ( name )

Definition at line 27 of file JsMaterialXNodeEditor.js.

    {
        this.name = name;
        this.debug = true;
        this.monitoring = true;
        this.renderer = null;
    }

◆ debugMessage()

MxGraphMonitor::debugMessage	(		text,
			path )

Output a debug message to the console.

Parameters

text	- The text to output.
path	- The path to output.

Returns: {void}

Definition at line 41 of file JsMaterialXNodeEditor.js.

    {
        if (this.debug) {
            console.log(text + path);
        }
    }

◆ getMonitoring()

MxGraphMonitor::getMonitoring ( )

Get the monitoring state of the monitor.

Returns: The monitoring state of the monitor.

Definition at line 382 of file JsMaterialXNodeEditor.js.

    {
        return this.monitoring;
    }

◆ getName()

MxGraphMonitor::getName ( )

Get the name of the monitor.

Returns: The name of the monitor.

Definition at line 350 of file JsMaterialXNodeEditor.js.

    {
        return this.name;
    }

◆ getParentPath()

MxGraphMonitor::getParentPath ( node )

Get the parent path of a node.

Parameters

node	- The node to get the parent path for.

Returns: The parent path of the node.

Definition at line 215 of file JsMaterialXNodeEditor.js.

    {
        let path = '';
        var is_subgraph = graphcanvas.graph._is_subgraph;
        if (is_subgraph) {
            path = graphcanvas.graph._subgraph_node.title + '/';
        }
        else
        {
            if (node.graph)
            {
                is_subgraph = node.graph._is_subgraph;
                if (is_subgraph) {
                    path = node.graph._subgraph_node.title + '/';
                }                            
            }
        }
        return path;
    }

◆ getPath()

MxGraphMonitor::getPath	(		node,
			parentGraph )

Get a '/' separated path.

Parameters

node	- The node to get the path for.
parentGraph	- The parent graph of the node.

Returns: The path of the node.

Definition at line 54 of file JsMaterialXNodeEditor.js.

                               {
 
        let path = '';
        if (parentGraph.length > 0)
            path = path + parentGraph + '/'            
        path += node.title;
        return path;
    }

◆ monitorGraph()

MxGraphMonitor::monitorGraph	(		theGraph,
			monitor )

Core monitoring of graph changes.

Parameters

theGraph	- The graph to monitor.
monitor	- The monitoring state.

Definition at line 491 of file JsMaterialXNodeEditor.js.

    {
        // Update monitor state
        this.monitoring = monitor;
    
        if (!theGraph)
            return;
 
        theGraph.onConnectionChange = null;
        theGraph.onNodeAdded = null;
        theGraph.onNodeRemoved = null;
 
        if (monitor) {
 
            console.log('> Monitor graph: ', graph.title? graph.title : 'ROOT')
 
            var that = this;
 
            theGraph.onConnectionChange = function (node) {
                let parentGraph = '';
                var is_subgraph = node.graph._is_subgraph;
                if (is_subgraph)
                    parentGraph = graphcanvas.graph._subgraph_node.title;
                that.onConnectionChange(node, parentGraph);
 
                var selected = graphcanvas.selected_nodes;
                for (var s in selected) {
                    //console.log('update selected node:', selected[s].title);
                    MxShadingGraphEditor.theEditor.updatePropertyPanel(selected[s]);
                    break;
                }
            }
 
            theGraph.onNodeAdded = function (node) {
                let parentGraph = '';
 
                if (node.type == 'graph/subgraph') {
                    // Use MaterialX naming for subgraphs
 
                    // Scan the subgraph for any nodes which are not in the node inputs list.
                    var node_subgraph = node.subgraph;
                    var node_graph = node.graph;
                    if (node_subgraph) {
                        //console.log('** Scan subgraph: ', node_subgraph)
                        for (var i in node_subgraph._nodes) {
                            let theNode = node_subgraph._nodes[i];
                            if (!node_graph.findNodeByTitle(theNode.title)) {
                                if (theNode.nodedef_node == 'input') {
                                    node.addInput(theNode.title, theNode.nodedef_type);
                                    //console.log('--> Promote input node to subgraph node.', theNode.title);
                                }
                                else if (theNode.nodedef_node == 'output') {
                                    //console.log('--> Promote output node to subgraph node.', theNode.title);
                                    node.addOutput(theNode.title, theNode.nodedef_type);
                                }
                            }
                        }
                    }
                }
 
                node.title = MxShadingGraphEditor.theEditor.handler.createValidName(node.title)
                node.setSize(node.computeSize());
                //console.log('-> Node Added:', node, '. Type:', node.type, '. Graph:', node.graph._2458graph);
 
                // Expose node as an input or output on the subgraph
                var is_subgraph = node.graph._is_subgraph;
                if (is_subgraph) {
                    parentGraph = graphcanvas.graph._subgraph_node.title;
 
                    if (node.nodedef_node == 'input') {
                        //console.log('Adding input node to subgraph.', node.title, node.graph);
                        node.graph.addInput(node.title, node.nodedef_type);
                    }
                    else if (node.nodedef_node == 'output') {
                        //console.log('Adding output node to subgraph.');
                        node.graph.addOutput(node.title, node.nodedef_type);
                    }
                }
 
                if (node.type == 'graph/subgraph') {
                    that.monitorGraph(node.subgraph, monitor);
                }
 
                that.onNodeAdded(node, parentGraph);
            }
 
            //console.log('Monitor graph remove:', theGraph.title);
            theGraph.onNodeRemoved = function (node) {
 
                let parentGraph = '';
                /* This is too late the graph reference has already been removed */
                var is_subgraph = graphcanvas.graph._is_subgraph;
                if (is_subgraph) {
                    parentGraph = graphcanvas.graph._subgraph_node.title;
                    if (node.nodedef_node == 'input') {
                        //console.log('Removing input node from subgraph.', parentGraph);
                        graphcanvas.graph.removeInput(node.title);
                    }
                    else if (node.nodedef_node == 'output') {
                        //console.log('Removing output node from subgraph.', parentGraph);
                        graphcanvas.graph.removeOutput(node.title);
                    }
                }
 
                that.onNodeRemoved(node, parentGraph);
            }
 
            for (var i in theGraph._nodes) {
                var node = theGraph._nodes[i];
                if (node.type == 'graph/subgraph') {
                    console.log('> Monitor subgraph:', node.title);
                    that.monitorGraph(node.subgraph, monitor);
                    node.onConnectInput = MxShadingGraphEditor.theEditor.onConnectInput;
                }
            }
        }            
    }

◆ onConnectInput()

MxGraphMonitor::onConnectInput	(	target_slot,
		output_type,
		output,
		source,
		slot,
		node )

Callback for connection to output.

Parameters

target_slot	- The target slot that was connected.
output_type	- The type of the output.
output	- The output that was connected.
source	- The source node of the connection.
slot	- The slot of the source node.
node	- The node where the connection was made.

Returns: {void}

Definition at line 140 of file JsMaterialXNodeEditor.js.

                                                                         {
 
        if (!this.monitoring)
        {
            return;
        }
 
        // checker -> input
        if (this.debug) {
            let sourcePath = this.getPath(source, this.getParentPath(source));
            let sourceOutput = output.name;
            let targetPath = this.getPath(node, this.getParentPath(node));
            let targetInput = node.inputs[target_slot].name;
 
            this.debugMessage('Monitor> Input connection change: ' +
                sourcePath + "[" + slot + "]." + sourceOutput + ' to: ' +
                targetPath + "[" + target_slot + "]." + targetInput + " (" + output_type + ")", "");
        }    
    }           

◆ onConnectionChange()

MxGraphMonitor::onConnectionChange	(		node,
			parentGraph )

Callback for when a connection changes in the graph.

Parameters

node	- The node where the connection changed.
parentGraph	- The parent graph of the node.

Returns: {void}

Definition at line 88 of file JsMaterialXNodeEditor.js.

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

◆ onConnectOutput()

MxGraphMonitor::onConnectOutput	(	slot,
		input_type,
		input,
		target_node,
		target_slot,
		node )

Callback for connection to output.

Parameters

slot	- The slot that was connected.
input_type	- The type of the input.
input	- The input that was connected.
target_node	- The target node of the connection.
target_slot	- The target slot of the connection.
node	- The node where the connection was made.

Returns: {void}

Definition at line 110 of file JsMaterialXNodeEditor.js.

    {
        if (!this.monitoring)
        {
            return;
        }
 
        if (this.debug) {
            let targetPath = this.getPath(node, this.getParentPath(node));
            let targetOutput = node.outputs[slot].name;
            let sourcePath = this.getPath(target_node, this.getParentPath(target_node));
            let sourceInput = input.name;
 
            this.debugMessage('Monitor> Output connection change: ' +
                targetPath + "[" + slot + "]." + targetOutput + ' to: ' +
                sourcePath + "[" + target_slot + "]." + sourceInput + " (" + input_type + ")", "");
        }
    }

◆ onDocumentChange()

MxGraphMonitor::onDocumentChange	(	attribute,
		value,
		prevValue )

Callback for when a scene / document level change is made.

Parameters

attribute	- The attribute that changed.
value	- The new value of the attribute.
prevValue	- The previous value of the attribute.

Returns: {void}

Definition at line 70 of file JsMaterialXNodeEditor.js.

    {
        if (!this.monitoring)
        {
            return;
        }
 
        if (this.debug) {
            this.debugMessage('Monitor> Document attribute "' + attribute + '" changed from: ' + prevValue + ' to: ' + value, '');
        }
    }

◆ onNodeAdded()

MxGraphMonitor::onNodeAdded	(		node,
			parentGraph )

Callback for when a node is added to the graph.

Parameters

node	- The node that was added.
parentGraph	- The parent graph of the node.

Definition at line 167 of file JsMaterialXNodeEditor.js.

    {
        if (!this.monitoring)
        {
            return;
        }
 
        // Go through all inputs on the node and remove hidden attribute
        // Needed to allow cut-paste of nodes which were loaded in with
        // hidden inputs.
        /* for (let i = 0; i < node.inputs.length; i++) {
            let input = node.inputs[i];
            if (input.hidden) {
                // Remove hidden attribute
                delete input.hidden;
            }
        } */
 
        if (this.debug) {
            this.debugMessage('Monitor> Node added: ', this.getPath(node, parentGraph));
        }
    }

◆ onNodeDeselected()

MxGraphMonitor::onNodeDeselected	(		node,
			parentGraph )

Callback for when a node is deselected in the graph.

Parameters

node	- The node that was deselected.
parentGraph	- The parent graph of the node.

Returns: {void}

Definition at line 283 of file JsMaterialXNodeEditor.js.

    {
        if (!this.monitoring)
        {
            return;
        }
 
        if (this.debug) {
            //this.debugMessage('-> Node unselected at path: ', this.getPath(node, parentGraph));
        }
    }

◆ onNodeRemoved()

MxGraphMonitor::onNodeRemoved	(		node,
			parentGraph )

Callback for when a node is removed from the graph.

Parameters

node	- The node that was removed.
parentGraph	- The parent graph of the node.

Returns: {void}

Definition at line 197 of file JsMaterialXNodeEditor.js.

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

◆ onNodeRenamed()

MxGraphMonitor::onNodeRenamed	(		node,
			newName )

Callback for when a node is renamed in the graph.

Parameters

node	- The node that was renamed.
newName	- The new name of the node.

Returns: {void}

Definition at line 242 of file JsMaterialXNodeEditor.js.

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

◆ onNodeSelected()

MxGraphMonitor::onNodeSelected	(		node,
			parentGraph )

Callback for when a node is selected in the graph.

Parameters

node	- The node that was selected.
parentGraph	- The parent graph of the node.

Returns: {void}

Definition at line 264 of file JsMaterialXNodeEditor.js.

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

◆ onPropertyChanged()

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

Callback for when a property changes on a node in the graph.

Parameters

nodeName	- The name of the node.
propertyName	- The name of the property that changed.
newValue	- The new value of the property.
previousValue	- The previous value of the property.
node	- The node where the property changed.

Returns: {void}

Definition at line 305 of file JsMaterialXNodeEditor.js.

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

◆ onPropertyInfoChanged()

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

Callback for when a property info changes on a node in the graph.

Parameters

nodeName	- The name of the node.
propertyName	- The name of the property that changed.
propertyInfoName	- The name of the property info that changed.
newValue	- The new value of the property info.
previousValue	- The previous value of the property info.
node	- The node where the property info changed.

Returns: {void}

Definition at line 330 of file JsMaterialXNodeEditor.js.

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

◆ setMonitoring()

MxGraphMonitor::setMonitoring ( monitor )

Set the monitoring state of the monitor.

Parameters

monitor - The monitoring state to set.

Returns: {void}

Definition at line 372 of file JsMaterialXNodeEditor.js.

    {
        this.monitoring = monitor;
    }

◆ setOnConnectionChange()

MxGraphMonitor::setOnConnectionChange ( callback )

Set connection change callback.

Parameters

callback - The callback to set.

Returns: {void}

Definition at line 393 of file JsMaterialXNodeEditor.js.

    {
        if (callback)
        {
            this.onConnectionChange = callback;
        }
    }

◆ setOnNodeAdded()

MxGraphMonitor::setOnNodeAdded ( callback )

Set node added callback.

Parameters

callback - The callback to set.

Returns: {void}

Definition at line 407 of file JsMaterialXNodeEditor.js.

    {
        if (callback)
        {
            this.onNodeAdded = callback;
        }
    }

◆ setOnNodeDeselected()

MxGraphMonitor::setOnNodeDeselected ( callback )

Set node deselected callback.

Parameters

callback - The callback to set.

Returns: {void}

Definition at line 463 of file JsMaterialXNodeEditor.js.

    {
        if (callback)
        {
            this.onNodeDeselected = callback;            
        }
    }

◆ setOnNodeRemoved()

MxGraphMonitor::setOnNodeRemoved ( callback )

Set node removed callback.

Parameters

callback - The callback to set.

Returns: {void}

Definition at line 421 of file JsMaterialXNodeEditor.js.

    {
        if (callback)
        {
            this.onNodeRemoved = callback;
        }
    }   

◆ setOnNodeRenamed()

MxGraphMonitor::setOnNodeRenamed ( callback )

Set node renamed callback.

Parameters

callback - The callback to set.

Returns: {void}

Definition at line 435 of file JsMaterialXNodeEditor.js.

    {
        if (callback)
        {
            this.onNodeRenamed = callback;
        }
    }

◆ setOnNodeSelected()

MxGraphMonitor::setOnNodeSelected ( callback )

Set node selected callback.

Parameters

callback - The callback to set.

Returns: {void}

Definition at line 449 of file JsMaterialXNodeEditor.js.

    {
        if (callback)
        {
            this.onNodeSelected = callback;
        }
    }

◆ setOnPropertyChanged()

MxGraphMonitor::setOnPropertyChanged ( callback )

Set property changed callback.

Parameters

callback - The callback to set.

Returns: {void}

Definition at line 477 of file JsMaterialXNodeEditor.js.

    {
        if (callback)
        {
            this.onPropertyChanged = callback;            
        }    
    }

◆ setRenderer()

MxGraphMonitor::setRenderer ( theRenderer )

Set the renderer for the monitor.

Parameters

theRenderer - The renderer to set.

Returns: {void}

Definition at line 361 of file JsMaterialXNodeEditor.js.

    {
        this.renderer = theRenderer
    }

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

JsMaterialXNodeEditor.js

Public Member Functions

Detailed Description

Member Function Documentation

◆ constructor()

◆ debugMessage()

◆ getMonitoring()

◆ getName()

◆ getParentPath()

◆ getPath()

◆ monitorGraph()

◆ onConnectInput()

◆ onConnectionChange()

◆ onConnectOutput()

◆ onDocumentChange()

◆ onNodeAdded()

◆ onNodeDeselected()

◆ onNodeRemoved()

◆ onNodeRenamed()

◆ onNodeSelected()

◆ onPropertyChanged()

◆ onPropertyInfoChanged()

◆ setMonitoring()

◆ setOnConnectionChange()

◆ setOnNodeAdded()

◆ setOnNodeDeselected()

◆ setOnNodeRemoved()

◆ setOnNodeRenamed()

◆ setOnNodeSelected()

◆ setOnPropertyChanged()

◆ setRenderer()