More refactoring based on feedback - shader node registry now owned by app

raytranuk · raytranuk · commit b3e609b1873f · 2020-11-04T15:53:26.000Z
diff --git a/examples/examples.js b/examples/examples.js
@@ -48,7 +48,6 @@ var categories = [
             "post-effects",
             "render-to-texture",
             "shader-burn",
-            "shader-graph-chunks-builder",
             "shader-toon",
             "shader-wobble",
             "texture-basis",
diff --git a/examples/graphics/shader-graph-chunks-builder.html b/examples/graphics/shader-graph-chunks-builder.html
@@ -78,10 +78,10 @@
                     var coreNodeList = asset.resource;
                     
                     //register loaded core nodes
-                    pc.shaderNodes.register(coreNodeList);
+                    app.shaderNodes.register(coreNodeList);
 
                     //create a shader graph builder
-                    var builder = new pc.ShaderGraphBuilder();
+                    var builder = new pc.ShaderGraphBuilder(app);
 
                     //add input parameters
                     var timeParam = builder.addParam('float', 'uTime', 0.0);
@@ -126,7 +126,7 @@
                     app.on("update", function (dt) {
                         time += dt;
                         shaderGraphMaterials.forEach(function (material) {
-                            material.setShaderGraphParameter('uTime', time);
+                            material.setParameter('uTime', time);
                             material.alphaTest = 1.0 - ((Math.sin(time * 4.0) + 1.7) * 0.5);
                         });
                     });
diff --git a/src/framework/application.js b/src/framework/application.js
@@ -80,6 +80,8 @@ import { BundleRegistry } from '../bundles/bundle-registry.js';
 
 import { ScriptRegistry } from '../script/script-registry.js';
 
+import { ShaderNodeRegistry } from '../graphics/shader-node-registry.js';
+
 import { I18n } from '../i18n/i18n.js';
 
 import { VrManager } from '../vr/vr-manager.js';
@@ -443,6 +445,8 @@ function Application(canvas, options) {
     this.scriptsOrder = options.scriptsOrder || [];
     this.scripts = new ScriptRegistry(this);
 
+    this.shaderNodes = new ShaderNodeRegistry(this);
+
     this.i18n = new I18n(this);
 
     this.scenes = new SceneRegistry(this);
diff --git a/src/graphics/program-lib/nodes/nodes.js b/src/graphics/program-lib/nodes/nodes.js
diff --git a/src/graphics/program-lib/utils.js b/src/graphics/program-lib/utils.js
@@ -9,9 +9,6 @@ import { shaderChunks } from './chunks/chunks.js';
 
 import { dummyFragmentCode, precisionCode, versionCode } from './programs/common.js';
 
-import { shaderNodes } from './nodes/nodes.js';
-import { ShaderGraphNode } from '../../scene/materials/shader-graph-node.js';
-
 var attrib2Semantic = {
     vertex_position: SEMANTIC_POSITION,
     vertex_normal: SEMANTIC_NORMAL,
@@ -97,19 +94,4 @@ shaderChunks.collectAttribs = collectAttribs;
 shaderChunks.createShader = createShader;
 shaderChunks.createShaderFromCode = createShaderFromCode;
 
-function registerCoreShaderGraphNodes(coreNodeList) {
-    var coreNodes = {};
-    if (coreNodeList) {
-        if (typeof coreNodeList === 'string') {
-            coreNodeList = JSON.parse(coreNodeList);
-        }
-        Object.keys(coreNodeList).forEach(function (key) {
-            coreNodes[key] = new ShaderGraphNode(coreNodeList[key].code);
-        });
-    }
-    shaderNodes._nodes = coreNodes;
-}
-
-shaderNodes.register = registerCoreShaderGraphNodes;
-
-export { collectAttribs, createShader, createShaderFromCode, registerCoreShaderGraphNodes };
+export { collectAttribs, createShader, createShaderFromCode };
diff --git a/src/graphics/shader-node-registry.js b/src/graphics/shader-node-registry.js
@@ -0,0 +1,43 @@
+import { ShaderGraphNode } from '../scene/materials/shader-graph-node.js';
+
+/**
+ * @private
+ * @class
+ * @name pc.ShaderNodeRegistry
+ * @classdesc Container for all Shader Graph Core Nodes available to this application.
+ * @description Create an instance of a pc.ShaderNodeRegistry.
+ * @param {pc.Application} app - Application to attach registry to.
+ */
+function ShaderNodeRegistry(app) {
+    this.app = app;
+    this._nodes = { };
+    this._list = [];
+}
+
+ShaderNodeRegistry.prototype.constructor = ShaderNodeRegistry;
+
+ShaderNodeRegistry.prototype.destroy = function () {
+    this.app = null;
+};
+
+/**
+ * @private
+ * @function
+ * @name pc.ShaderNodeRegistry#register
+ * @description Register core nodes with registry.
+ * @param {object|string} coreNodeList - core node list object or JSON string
+ */
+ShaderNodeRegistry.prototype.register = function (coreNodeList) {
+    if (coreNodeList) {
+        if (typeof coreNodeList === 'string') {
+            coreNodeList = JSON.parse(coreNodeList);
+        }
+        var self = this;
+        Object.keys(coreNodeList).forEach(function (key) {
+            self._nodes[key] = new ShaderGraphNode(coreNodeList[key].code);
+            self._list.push(self._nodes[key]);
+        });
+    }
+};
+
+export { ShaderNodeRegistry };
diff --git a/src/index.js b/src/index.js
@@ -53,7 +53,6 @@ export { prefilterCubemap, shFromCubemap } from './graphics/prefilter-cubemap.js
 export { reprojectTexture } from './graphics/reproject-texture.js';
 export { programlib } from './graphics/program-lib/program-lib.js';
 export { shaderChunks } from './graphics/program-lib/chunks/chunks.js';
-export { shaderNodes } from './graphics/program-lib/nodes/nodes.js';
 export { GraphicsDevice } from './graphics/device.js';
 export { IndexBuffer } from './graphics/index-buffer.js';
 export { PostEffect, drawFullscreenQuad } from './graphics/post-effect.js';
@@ -62,6 +61,7 @@ export { RenderTarget } from './graphics/render-target.js';
 export { ScopeId } from './graphics/scope-id.js';
 export { ScopeSpace } from './graphics/scope-space.js';
 export { Shader } from './graphics/shader.js';
+export { ShaderNodeRegistry } from './graphics/shader-node-registry.js';
 export { Texture } from './graphics/texture.js';
 export { TransformFeedback } from './graphics/transform-feedback.js';
 export { VertexBuffer } from './graphics/vertex-buffer.js';
diff --git a/src/scene/materials/shader-graph-builder.js b/src/scene/materials/shader-graph-builder.js
@@ -1,17 +1,19 @@
-import { shaderNodes } from '../../graphics/program-lib/nodes/nodes.js';
-
 import { ShaderGraphNode } from './shader-graph-node.js';
 
 var id = 0;
 
 /**
+ * @private
  * @class
  * @name pc.ShaderGraphBuilder
  * @classdesc A Shader Graph Builder class
+ * @param {pc.Application} app - Application with shader graph core nodes registered that will be used to build the shader graph
  */
-var ShaderGraphBuilder = function () {
+var ShaderGraphBuilder = function (app) {
     id++;
-    this._nodes = shaderNodes._nodes;
+
+    this.app = app;
+    this._nodes = this.app.shaderNodes._nodes;
 
     this._graph = new ShaderGraphNode();
     this._graph.name = 'graphRoot_' + id;
@@ -21,6 +23,7 @@ ShaderGraphBuilder.prototype.constructor = ShaderGraphBuilder;
 
 Object.assign(ShaderGraphBuilder.prototype, {
     /**
+     * @private
      * @function
      * @name pc.ShaderGraphBuilder#addParam
      * @description adds a parameter input to graph
@@ -34,6 +37,7 @@ Object.assign(ShaderGraphBuilder.prototype, {
         return ioPort;
     },
     /**
+     * @private
      * @function
      * @name pc.ShaderGraphBuilder#addNode
      * @description creates and adds a core node to the shader graph and connects up inputs
@@ -76,6 +80,7 @@ Object.assign(ShaderGraphBuilder.prototype, {
         return sgIndex;
     },
     /**
+     * @private
      * @function
      * @name pc.ShaderGraphBuilder#addOutput
      * @description connect a node port to graph material output
@@ -109,6 +114,7 @@ Object.assign(ShaderGraphBuilder.prototype, {
         }
     },
     /**
+     * @private
      * @function
      * @name pc.ShaderGraphBuilder#getShaderGraphChunk
      * @description get shader graph chunk
diff --git a/src/scene/materials/standard-node-material.js b/src/scene/materials/standard-node-material.js
@@ -7,6 +7,7 @@ import {
 import { StandardMaterial } from './standard-material.js';
 
 /**
+ * @private
  * @class
  * @name pc.StandardNodeMaterial
  * @augments pc.StandardMaterial
@@ -31,12 +32,6 @@ StandardNodeMaterial.prototype.constructor = StandardNodeMaterial;
 
 Object.assign(StandardNodeMaterial.prototype, {
 
-   /**
-    * @function
-    * @name pc.StandardNodeMaterial#clone
-    * @description Duplicates a Standard node material.
-    * @returns {pc.StandardNodeMaterial} A cloned Standard node material.
-    */
     clone: function () {
         var clone = new StandardNodeMaterial();
         StandardMaterial.prototype._cloneInternal.call(this, clone);
@@ -46,20 +41,15 @@ Object.assign(StandardNodeMaterial.prototype, {
         return clone;
     },
 
-   /**
-    * @function
-    * @name pc.StandardNodeMaterial#setShaderGraphParameter
-    * @description sets a shader graph parameter
-    * @param {string} name - name of the parameter
-    * @param {any} value - value of the parameter
-    */
-    setShaderGraphParameter: function (name, value) {
+    setParameter: function (name, data) {
+        StandardMaterial.prototype.setParameter.call(this, name, data);
+
         if (this._shaderGraphChunk) {
             var rootShaderGraph = this._shaderGraphChunk;
 
             var portName = 'IN_' + name + '_' + rootShaderGraph.id;
 
-            this.setParameter(portName, value);
+            StandardMaterial.prototype.setParameter.call(this, portName, data);
         }
     },
 
