MxDefinitionCreator Class Reference

Class which will create a MaterialX definition from a node graph. More...

Public Member Functions
	constructor (compoundGraph)
	Constructor.
	getDefaultOptions ()
	Get the default options for definition creation.
	sanitizeXMLString (docString)
	Sanitize a string to be safe to use with XML / HTML.
	setOptions (new_options)
	Set the options for definition creation.
	execute ()
	Create a new definition.

Detailed Description

Class which will create a MaterialX definition from a node graph.

Definition at line 710 of file JsMaterialXGraph.js.

Member Function Documentation

constructor()

MxDefinitionCreator::constructor

(

compoundGraph

)

Constructor.

Definition at line 715 of file JsMaterialXGraph.js.

                               {
        this.compoundGraph = compoundGraph;
        this.options = this.getDefaultOptions();
 
        this.DEFINITION_NAME = 'definitionName';
        this.UI_NAME = 'uiName';
        this.NODEGROUP = 'nodeGroup';
        this.VERSION = 'version';
        this.DEFAULT_VERSION = 'defaultVersion';
        this.DEFINITION_PREFIX = 'definitionPrefix';
        this.NODEGRAPH_PREFIX = 'nodegraphPrefix';   
        this.DOCUMENTATION = 'documentation';
        this.NAMESPACE = 'namespace';     
    }

execute()

MxDefinitionCreator::execute

(

)

Create a new definition.

Returns

{MaterialX document with the definition, or null if no graph supplied

Definition at line 789 of file JsMaterialXGraph.js.

    {
        if (!this.compoundGraph) {
            return null;
        }
        //console.log('Options:', this.options)
        let nodeGraph = this.compoundGraph;
 
 
        let category = nodeGraph.getName();
        if (this.options['definitionName']) {
            category = this.options['definitionName'];
        }
 
        let identifier = "";
 
        let embedNamespace = true;
        // Due to lack of robust support for namespace metadata, we will add the namespace
        // as a prefix to the identifiers
        let namespace = mx.createValidName(this.options[this.NAMESPACE])
        // Replace : with _ to avoid issues with namespaces
        namespace = namespace.replace(':', '_')
        if (embedNamespace && namespace.length > 0)
        {
            category = namespace + '_' + category;
        }
        // If category starts with a number or '_' add a "c_" prefix
        if (category.match(/^[\d_]/)) {
            console.warn('Category starts with a number. Adding prefix "c_" to category name.')
            category = 'c' + category;
        }
        // Replace all '__' with '_'
        category = category.replace(/__/g, '_')
        
        identifier = category;
        if (this.options[this.VERSION])
            identifier = identifier + '_' + this.options['version'];
 
        let parameter_signature = '';
        let outputs = nodeGraph.getOutputs();
        for (let output of outputs) {
            let outputType = output.getType();
            parameter_signature = parameter_signature + '_' + outputType;
        }
        identifier = identifier + parameter_signature;
        identifier = mx.createValidName(identifier)
        // Replace all '__' with '_'
        identifier = identifier.replace(/__/g, '_')
 
        let nodeDefName = this.options[this.DEFINITION_PREFIX] + identifier;
        let nodegraphName = this.options[this.NODEGRAPH_PREFIX] + identifier;
        let uiName = this.options[this.UI_NAME];
        let defaultVersion = this.options[this.DEFAULT_VERSION];
        let nodeGroup = this.options[this.NODEGROUP];
        let version = this.options[this.VERSION]
 
        let definitionDoc = mx.createDocument();
 
        // Note that the pre 1.39 equivalent was removed. 
        let definition = definitionDoc.addNodeDefFromGraph(nodeGraph, nodeDefName, category, nodegraphName)
        if (version.length > 0)
        {
        definition.setVersionString(version);
        }
        if (defaultVersion)
            definition.setDefaultVersion(defaultVersion);
        if (nodeGroup.length > 0)
        {
        definition.setNodeGroup(nodeGroup); 
        }
        let functionalGraph = definitionDoc.getNodeGraph(nodegraphName);
 
        if (uiName.length)
        {
            uiName = this.sanitizeXMLString(uiName)
            definition.setAttribute('uiname', uiName);
        }
 
        if (!embedNamespace && namespace.length > 0)
        {
            namespace = mx.createValidName(namespace)
            definition.setNamespace(namespace);
            functionalGraph.setNamespace(namespace);
            // WARNING: Need to rename the nodedef reference
            functionalGraph.setNodeDefString(namespace + ":" + functionalGraph.getNodeDefString())
        }
 
        let docString = this.options[this.DOCUMENTATION]
        if (docString)
        {
            docString = this.sanitizeXMLString(docString)
            definition.setDocString(docString)
            functionalGraph.setDocString(docString)
        }
 
        /*
        // Cleanup the result
        let filterAttributes = ['nodegraph', 'nodename', 'channels', 'interfacename', 'xpos', 'ypos']
 
        // Transfer input interface from the graph to the nodedef
        for (let input of functionalGraph.getInputs()) {
            let nodeDefInput = definition.addInput(input.getName(), input.getType())
            if (nodeDefInput) {
                nodeDefInput.copyContentFrom(input)
                for (let filterAttribute of filterAttributes) {
                    nodeDefInput.removeAttribute(filterAttribute);
                }
                nodeDefInput.setSourceUri('')
                input.setInterfaceName(nodeDefInput.getName())
            }
        }
        for (let input of functionalGraph.getInputs()) {
            functionalGraph.removeInput(input.getName())
        }
 
        for (let output of nodeGraph.getOutputs()) {
            let nodeDefOutput = definition.getOutput(output.getName())
            if (nodeDefOutput)
                definition.removeOutput(output.getName())
            definition.addOutput(output.getName(), output.getType())
            if (nodeDefOutput)
                nodeDefOutput.copyContentFrom(output)
            for (let filterAttribute in filterAttributes)
                nodeDefOutput.removeAttribute(filterAttribute)
            nodeDefOutput.setSourceUri('')
        }
        for (let graphChild of functionalGraph.getChildren()) {
            graphChild.removeAttribute('xpos');
            graphChild.removeAttribute('ypos');
        }      
        */
        return definitionDoc;
    }

getDefaultOptions()

MxDefinitionCreator::getDefaultOptions

(

)

Get the default options for definition creation.

Returns

Default options

Definition at line 734 of file JsMaterialXGraph.js.

                        {
        let options = {};
        options[this.DEFINITION_NAME] = '';
        options[this.UI_NAME] = '';
        options[this.VERSION] = '1.0';
        options[this.DEFAULT_VERSION] = true;
        options[this.NODEGROUP] = 'procedural';
        options[this.DEFINITION_PREFIX] = 'ND_';
        options[this.NODEGRAPH_PREFIX] = 'NG_';
        options[this.DOCUMENTATION] = '';
        options[this.NAMESPACE] = '';
        return options;
    }

sanitizeXMLString()

MxDefinitionCreator::sanitizeXMLString

(

docString

)

Sanitize a string to be safe to use with XML / HTML.

Parameters

docString

Original string

Returns

Sanitized string

Definition at line 753 of file JsMaterialXGraph.js.

    {
        console.log('------------ sanitize: ', docString)
        // Sanitize the string so it's valid for XML and HTML 
        // by replacing special characters with their HTML entities
        //docString = docString.replace(/&/g, '&')
        docString = docString.replace(/</g, '&lt;')
        docString = docString.replace(/>/g, '&gt;')            
 
        // Remove any newlines
        docString = docString.replace(/(\r\n|\n|\r)/gm, " ");
 
        console.log('------------ sanitize 2: ', docString)
        return docString;
    }

setOptions()

MxDefinitionCreator::setOptions

(

new_options

)

Set the options for definition creation.

Parameters

new_options

Options to set

Returns

{void}

Definition at line 774 of file JsMaterialXGraph.js.

    {
        //console.log('Set options:', new_options)
        if (new_options) {
            this.options = {};
            for (let key in new_options) {
                this.options[key] = new_options[key];
            }
        }        
    }

---

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

• JsMaterialXGraph.js