Merge pull request #112 from vidartf/blackbox

Add custom object Blackbox

Author: vidartf

js/scripts/generate-wrappers.js

@@ -41,6 +41,7 @@ var CUSTOM_CLASSES = [
     'geometries/PlainGeometry.js',
     'geometries/PlainBufferGeometry.js',
     'objects/CloneArray.js',
+    'objects/Blackbox.js',
 ];
 
 

js/scripts/three-class-config.js

@@ -354,6 +354,10 @@ module.exports = {
         },
         propsDefinedByThree: [ 'type' ]
     },
+    Blackbox: {
+        superClass: 'Object3D',
+        relativePath: './objects/Blackbox'
+    },
     Raycaster: {
         relativePath: './core/Raycaster',
         properties: {

js/src/objects/Blackbox.js

@@ -0,0 +1,41 @@
+var _ = require('underscore');
+var BlackboxAutogen = require('./Blackbox.autogen').BlackboxModel;
+
+/**
+ * This object is intended as an extension point. It differs from
+ * a normal Object3D in that it does not sync back child objects to
+ * the models. This allows extensions to build sub-scene graphs that
+ * might not be possible/feasible/desirable to sync.
+ *
+ * To implement an extended object based on this:
+ *  - Extend this model
+ *  - Override defaults/serializers as normal for a widget. Remember
+ *    to call the super methods!
+ *  - Override initialize method. Call super, and then put any
+ *    extension code that relies on the THREE object inside
+ *    a "then" to `initPromise:
+ *
+ *      this.initPromise.then(() => {
+ *        // Do your stuff here
+ *      });
+ *  - If you do not want a basic Object3D as the "root" of your black
+ *    box, you need to override constructThreeObject[Async].
+ */
+var BlackboxModel = BlackboxAutogen.extend({
+
+    defaults: function() {
+        var superdef = BlackboxAutogen.prototype.defaults.call(this);
+        delete superdef['children'];
+        return superdef;
+    },
+
+
+    createPropertiesArrays: function() {
+
+        BlackboxAutogen.prototype.createPropertiesArrays.call(this);
+        delete this.three_array_properties['children'];
+        delete this.property_converters['children'];
+
+    }
+
+});

pythreejs/objects/Blackbox.py

@@ -0,0 +1,14 @@
+from .Blackbox_autogen import Blackbox as BaseBlackbox
+
+
+class Blackbox(BaseBlackbox):
+    """A widget with unsynced children.
+
+    This widget allows extension authors to expose scene control
+    of a given three object, without attempting to sync its
+    children. This makes it possible for a library to give
+    access to an outer object, without exposing the full object
+    three, and can be useful in avoiding possibly heavy sync
+    operations.
+    """
+    children = None