Fix uniform colors

Author: vidartf

examples/Shaders.ipynb

@@ -14,7 +14,7 @@
    "outputs": [],
    "source": [
     "from pythreejs import *\n",
-    "import ipywidgets\n",
+    "import ipywidgets as widgets\n",
     "from IPython.display import display"
    ]
   },
@@ -51,11 +51,13 @@
    "outputs": [],
    "source": [
     "fragment_shader = \"\"\"\n",
+    "uniform vec3 user_color;\n",
+    "\n",
     "void main() {\n",
-    "    #ifdef OVERRIDE_COLOR\n",
-    "    gl_FragColor = vec4(0, 0.5, 0, 1.0);\n",
-    "    #else\n",
+    "    #ifdef FIX_COLOR\n",
     "    gl_FragColor = vec4(0.5, 0, 0, 1.0);\n",
+    "    #else\n",
+    "    gl_FragColor = vec4(user_color, 1.0);\n",
     "    #endif\n",
     "}\n",
     "\"\"\""
@@ -71,10 +73,11 @@
     "    uniforms=dict(\n",
     "        time=dict(value=0.0),\n",
     "        resolution=dict(value=(1, 1)),\n",
+    "        user_color=dict(value='green'),\n",
     "        **UniformsLib['lights']\n",
     "    ),\n",
     "    defines=dict(\n",
-    "        OVERRIDE_COLOR=1,\n",
+    "        FIX_COLOR=1,\n",
     "    ),\n",
     "    vertexShader=vertex_shader,\n",
     "    fragmentShader=fragment_shader,\n",
@@ -97,6 +100,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "# Disable fixed color from defines:\n",
     "material.defines = dict()\n",
     "material.needsUpdate = True"
    ]
@@ -107,28 +111,30 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "def update_time(time):\n",
+    "# Uniform editors:\n",
+    "picker = widgets.ColorPicker(value=material.uniforms['user_color']['value'])\n",
+    "time_slider = widgets.FloatSlider(value=material.uniforms['time']['value'], min=-15, max=15)\n",
+    "\n",
+    "# Interactive code:\n",
+    "def update_uniforms(change):\n",
     "    uniforms = dict(**material.uniforms)\n",
-    "    uniforms.update(time=dict(value=time))\n",
+    "    uniforms.update(\n",
+    "        time=dict(value=time_slider.value),\n",
+    "        user_color=dict(value=picker.value),\n",
+    "    )\n",
     "    material.uniforms = uniforms\n",
-    "    material.needsUpdate = True"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "update_time(-15)"
+    "    material.needsUpdate = True\n",
+    "\n",
+    "picker.observe(update_uniforms)\n",
+    "time_slider.observe(update_uniforms)\n",
+    "\n",
+    "# Present \"dashboard\" in VBox:\n",
+    "widgets.VBox([\n",
+    "    Preview(material),\n",
+    "    picker,\n",
+    "    time_slider,\n",
+    "])"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
@@ -147,7 +153,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.5.4"
+   "version": "3.6.3"
   }
  },
  "nbformat": 4,

js/scripts/prop-types.js

@@ -389,6 +389,12 @@ class DictType extends BaseType {
     }
 }
 
+class UniformDict extends DictType {
+    getPropertyConverterFn() {
+        return 'convertUniformDict';
+    }
+}
+
 class FunctionType extends BaseType {
     constructor(fn) {
         super();
@@ -562,6 +568,7 @@ module.exports = {
     Array: ArrayType,
     ArrayBuffer: ArrayBufferType,
     Dict: DictType,
+    UniformDict: UniformDict,
     Function: FunctionType,
     Vector2: Vector2,
     Vector3: Vector3,

js/scripts/three-class-config.js

@@ -857,7 +857,7 @@ module.exports = {
         relativePath: './materials/ShaderMaterial',
         superClass: 'Material',
         properties: {
-            uniforms:           new Types.Dict(),
+            uniforms:           new Types.UniformDict(),
             clipping:           new Types.Bool(false),
             extensions:         new Types.Dict(),
             fog:                new Types.Bool(false),

js/src/_base/Three.js

@@ -670,6 +670,23 @@ var ThreeModel = widgets.WidgetModel.extend({
         Object.assign(obj[key], value);
     },
 
+    convertUniformDictModelToThree: function(modelDict) {
+        // Convert any strings to THREE.Color
+        // Just modify dict in-place, as it should serialize the same
+        Object.keys(modelDict).forEach(function(k) {
+            var value = modelDict[k].value;
+            if (value && (typeof value === 'string' || value instanceof String)) {
+                modelDict[k].value = new THREE.Color(value);
+            }
+        });
+        return modelDict;
+    },
+
+    convertUniformDictThreeToModel: function(threeDict) {
+        // No-op
+        return threeDict;
+    },
+
     // ThreeTypeArray
     convertThreeTypeArrayModelToThree: function(modelArr, propName) {
         if (!Array.isArray(modelArr)) {