merge (#51)

* Apply JavaScript formatting This changelist applies automated formatting to the MaterialX JavaScript codebase, aligning it with the 4-space indentation and Allman braces used in MaterialX C++. * Add missing classification of VolumeShader nodes (AcademySoftwareFoundation#1675) ShaderNodes.cpp had missing classification information for Volume Shaders. This PR is a simple addition of that classification. * Add invert node to specification (AcademySoftwareFoundation#1676) The node exists in the standard library code, but is missing from the specification. * Improvements to facingratio - Fix syntax of input default values. - Use the invert node in facingratio for compactness. - Clarify the edge brighten example material. * Always build GLFW as a static library (AcademySoftwareFoundation#1680) Currently the embedded glfw build for MaterialXGraphEditor inherits the value of BUILD_SHARED_LIBS from MATERIALX_BUILD_SHARED_LIBS, but we're not installing libglfw, per AcademySoftwareFoundation#1245 the intention was to statically link. --------- Co-authored-by: Jonathan Stone <[email protected]> Co-authored-by: Dhruv Govil <[email protected]> Co-authored-by: ld-kerley <[email protected]>
kwokcb · Jan 30, 2024 · c4f81ed · c4f81ed
1 parent 5b801bf
commit c4f81ed
Show file tree

Hide file tree

Showing 23 changed files with 883 additions and 628 deletions.
diff --git a/documents/Specification/MaterialX.Specification.md b/documents/Specification/MaterialX.Specification.md
@@ -1084,6 +1084,12 @@ Math nodes have one or two spatially-varying inputs, and are used to perform a m
     * `in1` (float or color<em>N</em> or vector<em>N</em>): the value or nodename for the primary input
     * `in2` (same type as `in1` or float): the modulo value or nodename to divide by, cannot be 0 in any channel; default is 1.0 in all channels, which effectively returns the fractional part of a float value
 
+<a id="node-invert"> </a>
+
+* **`invert`**: subtract the incoming float/color/vector from "amount" in all channels, outputting: `amount - in`.
+    * `in` (float or color<em>N</em> or vector<em>N</em>): the value or nodename for the primary input
+    * `amount` (same type as `in` or float): the value or nodename to subtract from; default is 1.0 in all channels
+
 <a id="node-absval"> </a>
 
 * **`absval`**: the per-channel absolute value of the incoming float/color/vector.

diff --git a/javascript/MaterialXTest/browser/esslShaderGenerator.spec.js b/javascript/MaterialXTest/browser/esslShaderGenerator.spec.js
@@ -1,6 +1,6 @@
 // MaterialX is served through a script tag in the test setup.
 
-function createStandardSurfaceMaterial(mx) 
+function createStandardSurfaceMaterial(mx)
 {
     const doc = mx.createDocument();
     const ssName = 'SR_default';
@@ -15,19 +15,21 @@ function createStandardSurfaceMaterial(mx)
     return doc;
 }
 
-describe('Generate ESSL Shaders', function () 
+describe('Generate ESSL Shaders', function ()
 {
     let mx;
     const canvas = document.createElement('canvas');
     const gl = canvas.getContext('webgl2');
-    
+
     this.timeout(60000);
 
-    before(async function () {
+    before(async function ()
+    {
         mx = await MaterialX();
     });
 
-    it('Compile Shaders', () => {
+    it('Compile Shaders', () =>
+    {
         const doc = createStandardSurfaceMaterial(mx);
 
         const gen = new mx.EsslShaderGenerator();
@@ -37,7 +39,7 @@ describe('Generate ESSL Shaders', function ()
         doc.importLibrary(stdlib);
 
         const elem = mx.findRenderableElement(doc);
-        try 
+        try
         {
             const mxShader = gen.generate(elem.getNamePath(), elem, genContext);
 
@@ -47,7 +49,7 @@ describe('Generate ESSL Shaders', function ()
             const glVertexShader = gl.createShader(gl.VERTEX_SHADER);
             gl.shaderSource(glVertexShader, vShader);
             gl.compileShader(glVertexShader);
-            if (!gl.getShaderParameter(glVertexShader, gl.COMPILE_STATUS)) 
+            if (!gl.getShaderParameter(glVertexShader, gl.COMPILE_STATUS))
             {
                 console.error("-------- VERTEX SHADER FAILED TO COMPILE: ----------------");
                 console.error("--- VERTEX SHADER LOG ---");
@@ -61,7 +63,7 @@ describe('Generate ESSL Shaders', function ()
             const glPixelShader = gl.createShader(gl.FRAGMENT_SHADER);
             gl.shaderSource(glPixelShader, fShader);
             gl.compileShader(glPixelShader);
-            if (!gl.getShaderParameter(glPixelShader, gl.COMPILE_STATUS)) 
+            if (!gl.getShaderParameter(glPixelShader, gl.COMPILE_STATUS))
             {
                 console.error("-------- PIXEL SHADER FAILED TO COMPILE: ----------------");
                 console.error("--- PIXEL SHADER LOG ---");
@@ -75,7 +77,7 @@ describe('Generate ESSL Shaders', function ()
         catch (errPtr)
         {
             console.error("-------- Failed code generation: ----------------");
-            console.error(mx.getExceptionMessage(errPtr));   
+            console.error(mx.getExceptionMessage(errPtr));
         }
     });
 });
diff --git a/javascript/MaterialXTest/browser/karma.conf.js b/javascript/MaterialXTest/browser/karma.conf.js
@@ -1,10 +1,11 @@
-module.exports = function(config) {
+module.exports = function (config)
+{
     config.set({
         basePath: '../', // base is the javascript folder
         files: [
             { pattern: '_build/JsMaterialXGenShader.js', watched: false, included: true, served: true },
             { pattern: '_build/JsMaterialXGenShader.wasm', watched: false, included: false, served: true },
-             {pattern: '_build/JsMaterialXGenShader.data', watched: false, included: false, served: true, nocache: true },
+            { pattern: '_build/JsMaterialXGenShader.data', watched: false, included: false, served: true, nocache: true },
             { pattern: 'browser/*.spec.js', watched: true, included: true, served: true },
         ],
         mime: {

diff --git a/javascript/MaterialXTest/codeExamples.spec.js b/javascript/MaterialXTest/codeExamples.spec.js
@@ -2,8 +2,10 @@ import { expect } from 'chai';
 import Module from './_build/JsMaterialXCore.js';
 import { getMtlxStrings } from './testHelpers';
 
-describe('Code Examples', () => {
-    it('Building a MaterialX Document', async () => {
+describe('Code Examples', () =>
+{
+    it('Building a MaterialX Document', async () =>
+    {
         const mx = await Module();
         // Create a document.
         const doc = mx.createDocument();
@@ -76,7 +78,8 @@ describe('Code Examples', () => {
         // expect(roughness.getBoundValue(material).getValueString()).to.equal('0.5');
     });
 
-    it('Traversing a Document Tree', async () => {
+    it('Traversing a Document Tree', async () =>
+    {
         const xmlStr = getMtlxStrings(
             ['standard_surface_greysphere_calibration.mtlx'],
             '../../resources/Materials/Examples/StandardSurface'
@@ -92,13 +95,16 @@ describe('Code Examples', () => {
         let elementCount = 0;
         let nodeCount = 0;
         let fileCount = 0;
-        for(let elem of elements) {
+        for (let elem of elements)
+        {
             elementCount++;
             // Display the filename of each image node.
-            if (elem.isANode('image')) {
+            if (elem.isANode('image'))
+            {
                 nodeCount++;
                 const input = elem.getInput('file');
-                if (input) {
+                if (input)
+                {
                     fileCount++;
                     const filename = input.getValueString();
                     expect(elem.getName()).to.equal('image1');
@@ -111,7 +117,8 @@ describe('Code Examples', () => {
         expect(fileCount).to.equal(1);
     });
 
-    it('Building a MaterialX Document', async () => {
+    it('Building a MaterialX Document', async () =>
+    {
         const xmlStr = getMtlxStrings(['standard_surface_marble_solid.mtlx'], '../../resources/Materials/Examples/StandardSurface')[0];
         const mx = await Module();
 

diff --git a/javascript/MaterialXTest/customBindings.spec.js b/javascript/MaterialXTest/customBindings.spec.js
@@ -2,15 +2,18 @@ import { expect } from 'chai';
 import Module from './_build/JsMaterialXCore.js';
 import { getMtlxStrings } from './testHelpers';
 
-describe('Custom Bindings', () => {
+describe('Custom Bindings', () =>
+{
     const examplesPath = '../../resources/Materials/Examples/StandardSurface';
 
-    let mx; 
-    before(async () => {
+    let mx;
+    before(async () =>
+    {
         mx = await Module();
     });
 
-    it('Optional parameters work as expected', () => {
+    it('Optional parameters work as expected', () =>
+    {
         const doc = mx.createDocument();
         // Call a method without optional argument
         const nodeGraph = doc.addNodeGraph();
@@ -29,7 +32,8 @@ describe('Custom Bindings', () => {
         expect(() => { nodeGraph.addNode(); }).to.throw;
     });
 
-    it('Vector <-> Array conversion', () => {
+    it('Vector <-> Array conversion', () =>
+    {
         // Functions that return vectors in C++ should return an array in JS
         const doc = mx.createDocument();
         const nodeGraph = doc.addNodeGraph();
@@ -66,7 +70,8 @@ describe('Custom Bindings', () => {
         expect(nodes[2].getName()).to.equal('anotherNode'); // Name set explicitly at creation time
     });
 
-    it('C++ exception handling', () => {
+    it('C++ exception handling', () =>
+    {
         // Exceptions that are thrown and caught in C++ shouldn't bubble up to JS
         const doc = mx.createDocument();
         const nodeGraph1 = doc.addNodeGraph();
@@ -79,15 +84,18 @@ describe('Custom Bindings', () => {
         // Exceptions that are not caught in C++ should throw with an exception pointer
         nodeGraph1.addNode('node', 'node1');
         expect(() => { nodeGraph1.addNode('node', 'node1'); }).to.throw;
-        try {
+        try
+        {
             nodeGraph1.addNode('node', 'node1');
-        } catch (errPtr) {
+        } catch (errPtr)
+        {
             expect(errPtr).to.be.a('number');
             expect(mx.getExceptionMessage(errPtr)).to.be.a('string');
         }
     });
 
-    it('getReferencedSourceUris', async () => {
+    it('getReferencedSourceUris', async () =>
+    {
         const doc = mx.createDocument();
         const filename = 'standard_surface_look_brass_tiled.mtlx';
         await mx.readFromXmlFile(doc, filename, examplesPath);
@@ -98,7 +106,8 @@ describe('Custom Bindings', () => {
         expect(sourceUris.includes('standard_surface_brass_tiled.mtlx')).to.be.true;
     });
 
-    it('Should invoke correct instance of \'validate\'', () => {
+    it('Should invoke correct instance of \'validate\'', () =>
+    {
         // We check whether the correct function is called by provoking an error message that is specific to the
         // function that we expect to be called.
         const message = {};
@@ -126,7 +135,8 @@ describe('Custom Bindings', () => {
         expect(message.message).to.include('Unit type definition does not exist in document')
     });
 
-    it('StringResolver name substitution getters', () => {
+    it('StringResolver name substitution getters', () =>
+    {
         const fnTestData = {
             fnKey: 'fnValue',
             fnKey1: 'fnValue1'
@@ -156,7 +166,8 @@ describe('Custom Bindings', () => {
         expect(gnSubs).to.deep.equal(gnTestData);
     });
 
-    it('getShaderNodes', async () => {
+    it('getShaderNodes', async () =>
+    {
         const doc = mx.createDocument();
         const fileNames = ['standard_surface_marble_solid.mtlx'];
         const mtlxStrs = getMtlxStrings(fileNames, examplesPath);
@@ -175,14 +186,16 @@ describe('Custom Bindings', () => {
         expect(shaderNodes.length).to.equal(0);
     });
 
-    it('createValidName', () => {
+    it('createValidName', () =>
+    {
         const testString = '_Note_:Please,turn.this+-into*1#valid\nname for_me';
         const replaceRegex = /[^a-zA-Z0-9_:]/g
         expect(mx.createValidName(testString)).to.equal(testString.replace(replaceRegex, '_'));
         expect(mx.createValidName(testString, '-')).to.equal(testString.replace(replaceRegex, '-'));
     });
 
-    it('getVersionIntegers', () => {
+    it('getVersionIntegers', () =>
+    {
         const versionStringArr = mx.getVersionString().split('.').map((value) => parseInt(value, 10));
 
         // Global getVersionIntegers

diff --git a/javascript/MaterialXTest/document.spec.js b/javascript/MaterialXTest/document.spec.js
@@ -1,30 +1,37 @@
 import { expect } from 'chai';
 import Module from './_build/JsMaterialXCore.js';
 
-describe('Document', () => {
+describe('Document', () =>
+{
     let mx, doc;
-    before(async () => {
+    before(async () =>
+    {
         mx = await Module();
         // Create a document.
         doc = mx.createDocument();
     });
 
-    function expectError(type, cb) {
-        try {
+    function expectError(type, cb)
+    {
+        try
+        {
             cb();
             throw new Error('Expected function to throw!');
-        } catch (exceptionPtr) {
+        } catch (exceptionPtr)
+        {
             const message = mx.getExceptionMessage(exceptionPtr);
             expect(message.indexOf(type) !== -1).to.be.true;
         }
     }
 
     let nodeGraph;
-    it('Build document', () => {
+    it('Build document', () =>
+    {
         // Create a node graph with constant and image sources.
         nodeGraph = doc.addNodeGraph();
         expect(nodeGraph).to.exist;
-        expectError('Child name is not unique: nodegraph1', () => {
+        expectError('Child name is not unique: nodegraph1', () =>
+        {
             doc.addNodeGraph(nodeGraph.getName());
         });
         const constant = nodeGraph.addNode('constant');