Adjust [Buffer]Geometry.from_geometry

New default is to clear the reference after using it to copy. This prevents conflicts when restoring saved state. It can still be kept around if asked explicitly for it.

Author: vidartf

js/scripts/three-class-config.js

@@ -365,6 +365,7 @@ module.exports = {
             skinWeights:    new Types.VectorArray(),
             skinIndices:    new Types.VectorArray(),
             _ref_geometry:  new Types.ThreeType('BaseGeometry'),
+            _store_ref:     new Types.Bool(false),
         },
     },
     BufferGeometry: {
@@ -379,6 +380,7 @@ module.exports = {
             //groups:             new Types.GeometryGroup(),
             //drawRange:          new Types.DrawRange(),
             _ref_geometry:      new Types.ThreeType(['BaseGeometry', 'BaseBufferGeometry']),
+            _store_ref:      new Types.Bool(false),
         },
     },
     InstancedBufferAttribute: {

js/src/core/BufferGeometry.js

@@ -18,7 +18,7 @@ var BufferGeometryModel = AutogenBufferGeometryModel.extend({
         this.property_assigners['attributes'] = 'assignAttributesMap';
     },
 
-    constructFromRef: function(ref) {
+    constructFromRef: function(ref, keep_ref) {
         var result = new THREE.BufferGeometry();
 
         var chain = ref.initPromise.bind(this);
@@ -98,6 +98,10 @@ var BufferGeometryModel = AutogenBufferGeometryModel.extend({
         }).then(function() {
             // Add other fields that needs to be synced out:
             toSet.name = result.name;
+            // Discard ref unless told to keep it:
+            if (!keep_ref) {
+                toSet._ref_geometry = null;
+            }
 
             // Perform actual sync to kernel side:
             this.set(toSet, 'pushFromThree');
@@ -109,8 +113,9 @@ var BufferGeometryModel = AutogenBufferGeometryModel.extend({
 
     constructThreeObject: function() {
         var ref = this.get('_ref_geometry');
+        var keep_ref = this.get('_store_ref');
         if (ref) {
-            return this.constructFromRef(ref);
+            return this.constructFromRef(ref, keep_ref);
         }
 
         var result = new THREE.BufferGeometry();

js/src/core/Geometry.js

@@ -10,6 +10,7 @@ var GeometryModel = AutogenGeometryModel.extend({
         var result = new THREE.Geometry();
 
         var ref = this.get('_ref_geometry');
+        var keep_ref = this.get('_store_ref');
         if (ref) {
             return ref.initPromise.bind(this).then(function() {
                 result.copy(ref.obj);
@@ -27,6 +28,10 @@ var GeometryModel = AutogenGeometryModel.extend({
                 }, this);
                 this.syncToModel();
                 this.props_created_by_three = old_three;
+                if (!keep_ref) {
+                    this.set({_ref_geometry: null}, 'pushFromThree');
+                    this.save_changes();
+                }
                 return result;
             });
         }

pythreejs/core/BufferGeometry.py

@@ -3,6 +3,7 @@
 from traitlets import validate, TraitError, Undefined
 from ipydatawidgets import NDArrayWidget, get_union_array
 
+from .Geometry import _make_key_filter
 from .BufferGeometry_autogen import BufferGeometry as BufferGeometryBase
 
 
@@ -11,10 +12,13 @@
 class BufferGeometry(BufferGeometryBase):
 
     @classmethod
-    def from_geometry(cls, geometry):
+    def from_geometry(cls, geometry, store_ref=False):
         """Creates a PlainBufferGeometry of another geometry.
+
+        store_ref determines if the reference is stored after initalization.
+        If it is, it will be used for future embedding.
         """
-        return cls(_ref_geometry=geometry)
+        return cls(_ref_geometry=geometry, _store_ref=store_ref)
 
     @validate('attributes')
     def validate(self, proposal):
@@ -48,6 +52,10 @@ def _gen_repr_from_keys(self, keys):
                 signature_parts.append('%s=%s' % (name, _attr_dict_repr(getattr(self, name))))
         return '%s(%s)' % (class_name, ', '.join(signature_parts))
 
+    def _repr_keys(self):
+        return filter(_make_key_filter(self._store_ref),
+                      super(BufferGeometry, self)._repr_keys())
+
 
 def _dict_is_default(ht, name):
     value = getattr(ht, name)

pythreejs/core/Geometry.py

@@ -1,19 +1,37 @@
 from ipywidgets import register
-from .Geometry_autogen import Geometry as GeometryBase
+from .Geometry_autogen import Geometry as AutogenGeometry
+from .._base.Three import ThreeWidget
 
 
 @register
-class Geometry(GeometryBase):
+class Geometry(AutogenGeometry):
 
     @classmethod
-    def from_geometry(cls, geometry):
+    def from_geometry(cls, geometry, store_ref=False):
         """Creates a PlainGeometry of another geometry.
 
+        store_ref determines if the reference is stored after initalization.
+        If it is, it will be used for future embedding.
+
         NOTE:
         The PlainGeometry will copy the arrays from the source geometry.
         To avoid this, use PlainBufferGeometry.
         """
-        return cls(_ref_geometry=geometry)
+        return cls(_ref_geometry=geometry, _store_ref=store_ref)
+
+    def _repr_keys(self):
+        return filter(_make_key_filter(self._store_ref),
+                      super(Geometry, self)._repr_keys())
+
 
+_non_gen_keys = tuple(ThreeWidget.class_trait_names())
 
+def _make_key_filter(use_ref):
+    def key_filter(key):
+        return (
+            key in _non_gen_keys or
+            (use_ref and key == '_ref_geometry') or
+            (not use_ref and key != '_ref_geometry')
+        )
 
+