JsMaterialXGraph.js File Reference

Go to the source code of this file.

Classes
class	MxGraphBuilder
	Class which will build node graph connectivity information from a MaterialX document. More...
class	MxMermaidGraphExporter
	Class which will export a graph to Mermaid format. More...
class	MxDefinitionCreator
	Class which will create a MaterialX definition from a node graph. More...

Functions
function	createMermaidGraphFromDocument (doc, opts)
	Create a Mermaid graph from a MaterialX document.
function	createMaterialXDefinitionFromNodeGraph (doc, nodeGraphName, options=null)
	Utility to create a MaterialX definition from a node graph.

Function Documentation

createMaterialXDefinitionFromNodeGraph()

function createMaterialXDefinitionFromNodeGraph	(		doc,
			nodeGraphName,
			options = null )

Utility to create a MaterialX definition from a node graph.

Parameters

{doc	MaterialX document
nodeGraphName	Name of the node graph
options	Options for the definition creation. Default value is null.

Returns

{MaterialX document with the definition

Definition at line 931 of file JsMaterialXGraph.js.

{
    let graph = doc.getDescendant(nodeGraphName)
    console.log('Creating MaterialX definition from NodeGraph...', 
        graph.getName())
    let creator = new MxDefinitionCreator(graph);
    if (options)
        creator.options = options;
    return creator.execute();
}

createMermaidGraphFromDocument()

function createMermaidGraphFromDocument	(		doc,
			opts )

Create a Mermaid graph from a MaterialX document.

Parameters

{doc	MaterialX document
opts	Write options. This includes: saveJSON: Save the graph to JSON file inputFileName: Input file name orientation: Orientation of the graph emitCategory: Emit the category of the node emitType: Emit the type of the node graphs: Write sub graphs

Returns

Mermaid graph and JSON string

Definition at line 674 of file JsMaterialXGraph.js.

{
    let graphBuilder = new MxGraphBuilder(doc);
    //graphBuilder.importFromJSON(filename);
    graphBuilder.setIncludeGraphs(opts.graphs)
    console.log('Creating graph from MaterialX document...')
    graphBuilder.execute()
    if (opts.saveJSON)
    {
        console.log('Exporting graph to JSON (graph.json)...')
        graphBuilder.exportToJSON('graph.json', opts.inputFileName)
    }
    jsonString = graphBuilder.getJSON(opts.inputFileName)
 
    //console.log('Dictionary\n', graphBuilder.getDictionary())
    //console.log('COnnetions\n', graphBuilder.getConnections())
 
    let exporter = new MxMermaidGraphExporter(
        graphBuilder.getDictionary(),
        graphBuilder.getConnections()
    );
 
    console.log('Creating Mermaid from graph...')
    exporter.setOrientation(opts.orientation);
    exporter.setEmitCategory(opts.emitCategory);
    exporter.setEmitType(opts.emitType);
    exporter.execute();
    
    result = exporter.getGraph(false)
    return [result, jsonString];
}