changed IDObjects to Widget classes and introduced client side linking

Author: chrisjsewell

pandas3js/__init__.py

@@ -5,7 +5,7 @@
 
 """
 
-__version__ = '0.1.6'
+__version__ = '0.2.0'
 
 from pandas3js import models
 from pandas3js import views

pandas3js/models/idcollection.py

@@ -248,7 +248,7 @@ def change_by_df(self, df, columns=None,
                     pass
                 if key==otype_column:
                     continue
-                if not idobject.has_trait(key):
+                if not key in idobject.get_object_trait_names():
                     raise trait.TraitError('object with id {0} does not have trait: {1}'.format(s.id, key))
 
                 # wait to set traits until all are objects are tested
@@ -274,7 +274,7 @@ def trait_df(self, traits=None, incl_class=True):
         data = []
         for obj in self.idobjects:
             trait_dict = {}
-            for name in obj.trait_names():
+            for name in obj.get_object_trait_names():
                 if traits is not None:
                     if name not in traits:
                         continue

pandas3js/models/idobject.py

@@ -8,6 +8,7 @@
 import uuid
 
 import traitlets as trait
+import ipywidgets as widgets
 from matplotlib import colors
 import pandas as pd
 
@@ -38,18 +39,27 @@ def validate(self, obj, value):
 
         return value
 
-class IDObject(trait.HasTraits):
+class IDObject(widgets.Widget):
     """ an object with an id
     
     """
     id = HashableType()
     groups = trait.List(trait=trait.CUnicode(),default_value=("all",),
                         help='the groups that this object belongs to') 
-    other_info = trait.CUnicode('',help='other information about the object as HTML')
+    other_info = trait.CUnicode('',help='other information about the object as HTML').tag(sync=True)
 
     @trait.default('id')
     def _default_id(self):
         return uuid.uuid4()
+        
+    def get_object_trait_names(self):
+        """ get trait names which are only associated with the object,
+        i.e. not from the ipywidgets base class
+        """
+        base_ipywidget_traits = set(widgets.Widget().trait_names())
+        all_traits = set(self.trait_names())
+        return list(all_traits.difference(base_ipywidget_traits))
+        
 
     def trait_series(self):
         """ create pandas.Series of objects traits
@@ -65,7 +75,7 @@ def trait_series(self):
         
         """
         trait_dict = {}
-        for name in self.trait_names():
+        for name in self.get_object_trait_names():
             value = getattr(self, name)
             # might break series if cell value is a list
             value = tuple(value) if isinstance(value, list) else value
@@ -155,16 +165,16 @@ class GeometricObject(IDObject):
     (0.0, 0.0, 0.0)
     
     """
-    position = Vector3(default_value=(0,0,0),help='cartesian coordinate of pivot')
+    position = Vector3(default_value=(0,0,0),help='cartesian coordinate of pivot').tag(sync=True)
 
-    visible = trait.Bool(True)
-    color = Color('red')
-    transparency = trait.CFloat(1,min=0.0,max=1.0)
+    visible = trait.Bool(True).tag(sync=True)
+    color = Color('red').tag(sync=True)
+    transparency = trait.CFloat(1,min=0.0,max=1.0).tag(sync=True)
 
-    label = trait.CUnicode('-')
-    label_visible = trait.Bool(False)
-    label_color = Color('red')
-    label_transparency = trait.CFloat(1,min=0.0,max=1.0)
+    label = trait.CUnicode('-').tag(sync=True).tag(sync=True)
+    label_visible = trait.Bool(False).tag(sync=True)
+    label_color = Color('red').tag(sync=True)
+    label_transparency = trait.CFloat(1,min=0.0,max=1.0).tag(sync=True)
 
 def default_viewmap(label_height=None):
     """ a wrapper to signal that all
@@ -204,7 +214,7 @@ class Sphere(GeometricObject):
     
 
     """
-    radius = trait.CFloat(1,min=0.)
+    radius = trait.CFloat(1,min=0.).tag(sync=True)
 
 # TODO orientation of default geometries
 @default_viewmap('height')
@@ -219,9 +229,9 @@ class Box(GeometricObject):
     (0.0, 0.0, 0.0)
 
     """
-    width = trait.CFloat(1)
-    height = trait.CFloat(1)
-    depth = trait.CFloat(1)
+    width = trait.CFloat(1).tag(sync=True)
+    height = trait.CFloat(1).tag(sync=True)
+    depth = trait.CFloat(1).tag(sync=True)
 
 @default_viewmap('radius')
 class Octahedron(GeometricObject):
@@ -235,8 +245,8 @@ class Octahedron(GeometricObject):
     (0.0, 0.0, 0.0)
 
     """
-    radius = trait.CFloat(1)
-    detail = trait.CFloat(0)    
+    radius = trait.CFloat(1).tag(sync=True)
+    detail = trait.CFloat(0).tag(sync=True)
 
 @default_viewmap('radius')
 class Icosahedron(GeometricObject):
@@ -250,8 +260,8 @@ class Icosahedron(GeometricObject):
     (0.0, 0.0, 0.0)
 
     """
-    radius = trait.CFloat(1)
-    detail = trait.CFloat(0)    
+    radius = trait.CFloat(1).tag(sync=True)
+    detail = trait.CFloat(0).tag(sync=True)  
 
 @default_viewmap('radius')
 class Circle(GeometricObject):
@@ -265,8 +275,8 @@ class Circle(GeometricObject):
     (0.0, 0.0, 0.0)
 
     """
-    radius = trait.CFloat(1)
-    segments = trait.CFloat(36)    
+    radius = trait.CFloat(1).tag(sync=True) 
+    segments = trait.CFloat(36).tag(sync=True)     
 
 class Plane(GeometricObject):
     """ a plane object
@@ -279,8 +289,8 @@ class Plane(GeometricObject):
     (0.0, 0.0, 0.0)
 
     """
-    normal = Vector3(default_value=(0,0,1),help='the normal vector of the plane')
-    width = trait.CFloat(1,min=0.0)
+    normal = Vector3(default_value=(0,0,1),help='the normal vector of the plane').tag(sync=True) 
+    width = trait.CFloat(1,min=0.0).tag(sync=True) 
 
     @trait.validate('normal')
     def _valid_normal(self, proposal):
@@ -309,9 +319,9 @@ class Line(GeometricObject):
         
     """
 
-    end = Vector3(default_value=(1,1,1),help='cartesian coordinate of line end')
-    end_color = Color('red')
-    linewidth = trait.CFloat(1,min=0.0)
+    end = Vector3(default_value=(1,1,1),help='cartesian coordinate of line end').tag(sync=True) 
+    end_color = Color('red').tag(sync=True) 
+    linewidth = trait.CFloat(1,min=0.0).tag(sync=True) 
 
 # TDOD only development version of PlainGeometry exposes face colors
 class TriclinicSolid(GeometricObject):
@@ -333,10 +343,10 @@ class TriclinicSolid(GeometricObject):
     pivot must be at the centre or corner
         
     """
-    a = Vector3(default_value=(1,0,0),help='box vector a')
-    b = Vector3(default_value=(0,1,0),help='box vector b')
-    c = Vector3(default_value=(0,0,1),help='box vector c')
-    pivot = trait.CUnicode('centre',help='pivot about centre or corner')
+    a = Vector3(default_value=(1,0,0),help='box vector a').tag(sync=True) 
+    b = Vector3(default_value=(0,1,0),help='box vector b').tag(sync=True) 
+    c = Vector3(default_value=(0,0,1),help='box vector c').tag(sync=True) 
+    pivot = trait.CUnicode('centre',help='pivot about centre or corner').tag(sync=True) 
 
     @trait.validate('pivot')
     def _valid_pivot(self, proposal):
@@ -364,7 +374,7 @@ class TriclinicWire(TriclinicSolid):
     not valid
         
     """
-    linewidth = trait.CFloat(1)
+    linewidth = trait.CFloat(1).tag(sync=True) 
 
 # TODO Gimbal: add labels at end of each vector
 class Gimbal(GeometricObject):
@@ -390,13 +400,13 @@ class Gimbal(GeometricObject):
     not valid
         
     """
-    a = Vector3(default_value=(1,0,0),help='vector a')
-    b = Vector3(default_value=(0,1,0),help='vector b')
-    c = Vector3(default_value=(0,0,1),help='vector c')
-    a_color = Color('red')
-    b_color = Color('green')
-    c_color = Color('orange')
-    linewidth = trait.CFloat(1,min=0.0)
+    a = Vector3(default_value=(1,0,0),help='vector a').tag(sync=True) 
+    b = Vector3(default_value=(0,1,0),help='vector b').tag(sync=True) 
+    c = Vector3(default_value=(0,0,1),help='vector c').tag(sync=True) 
+    a_color = Color('red').tag(sync=True) 
+    b_color = Color('green').tag(sync=True) 
+    c_color = Color('orange').tag(sync=True) 
+    linewidth = trait.CFloat(1,min=0.0).tag(sync=True) 
 
 
 

pandas3js/views/jsgui.py

@@ -25,7 +25,7 @@ def create_gui(geometry=None,callback=None,
                view=(10,-10,-10,10),fov=50,
                add_objects=True, add_labels=True,
                show_object_info=False,
-               otype_column=None):
+               otype_column=None, jslink=False):
     """ creates simple gui to visualise 3d geometry,
     with a callback to update geometry according to option widgets 
 
@@ -66,6 +66,9 @@ def create_gui(geometry=None,callback=None,
         add object labels to scene
     show_object_info : bool
         if True, show coordinate of object under mouse (currently only works for Perspective)
+    jslink : bool
+        if True, where possible, create client side links
+        http://ipywidgets.readthedocs.io/en/latest/examples/Widget%20Events.html#The-difference-between-linking-in-the-kernel-and-linking-in-the-client     
     
     Returns
     -------
@@ -184,7 +187,7 @@ def create_gui(geometry=None,callback=None,
     else:
         gcollect = geometry
     scene = pjs.views.create_js_scene_view(gcollect,
-                    add_objects=add_objects,add_labels=add_labels)
+                    add_objects=add_objects,add_labels=add_labels, jslink=jslink)
     camera, renderer = pjs.views.create_jsrenderer(scene,
                                 orthographic=orthographic, camera_position=camera_position,
                                 view=view,fov=fov,

pandas3js/views/jsmesh.py

@@ -11,6 +11,7 @@
 
 import pythreejs as js
 import traitlets as trait 
+import ipywidgets as widget
 from matplotlib import colors
 import numpy as np
 
@@ -28,7 +29,7 @@ def trait_dlink(change):
     trait_dlink(None)
     return trait_dlink
 
-def create_jsmesh_view(gobject,mapping=None):
+def create_jsmesh_view(gobject,mapping=None,jslink=False):
     """create PyThreeJS Mesh for GeometricObjects
     and with one-way synchronisation
     
@@ -37,13 +38,16 @@ def create_jsmesh_view(gobject,mapping=None):
     gobject : GeometricObject
     mapping : None or dict
         if None, use default gobject->jsobject mapping
+    jslink : bool
+        if True, where possible, create client side links
+        http://ipywidgets.readthedocs.io/en/latest/examples/Widget%20Events.html#The-difference-between-linking-in-the-kernel-and-linking-in-the-client 
     
     Examples
     --------
     
     >>> import pandas3js as pjs
     >>> sphere = pjs.models.Sphere()
-    >>> mesh = create_jsmesh_view(sphere)
+    >>> mesh = pjs.views.create_jsmesh_view(sphere)
     >>> mesh.position
     [0.0, 0.0, 0.0]
     >>> str(mesh.material.color)
@@ -67,6 +71,11 @@ def create_jsmesh_view(gobject,mapping=None):
     >>> mesh = create_jsmesh_view(pjs.models.Plane())
     
     """
+    if jslink:
+        direct_link = widget.jsdlink
+    else:
+        direct_link = trait.dlink
+
     class_str = obj_to_str(gobject)
     if hasattr(gobject, '_use_default_viewmap'):
         class_map = copy.deepcopy(gobject_jsmapping['default'])
@@ -88,7 +97,7 @@ def create_jsmesh_view(gobject,mapping=None):
     for key, val in class_map['gvar'].items():
         geometry.set_trait(key, val)
     for key, val in class_map['gdmap'].items():
-        trait.dlink((gobject, val), (geometry, key))
+        direct_link((gobject, val), (geometry, key))
     for gkey, gdic in class_map['gfmap'].items():
         handle = _create_trait_dlink(gdic, gkey, gobject, geometry)
         gobject.observe(handle,names=gdic['vars'])
@@ -99,7 +108,7 @@ def create_jsmesh_view(gobject,mapping=None):
     for key, val in class_map['matvar'].items():
         material.set_trait(key, val)
     for key, val in class_map['matdmap'].items():
-        trait.dlink((gobject, val), (material, key))
+        direct_link((gobject, val), (material, key))
     for mkey, mdic in class_map['matfmap'].items():
         handle = _create_trait_dlink(mdic, mkey, gobject, material)
         gobject.observe(handle,names=mdic['vars'])
@@ -111,20 +120,21 @@ def create_jsmesh_view(gobject,mapping=None):
     for key, val in class_map['meshvar'].items():
         mesh.set_trait(key, val)
     for key, val in class_map['meshdmap'].items():
-        trait.dlink((gobject, val), (mesh, key))
+        direct_link((gobject, val), (mesh, key))
     for skey, sdic in class_map['meshfmap'].items():
         handle = _create_trait_dlink(sdic, skey, gobject, mesh)
         gobject.observe(handle,names=sdic['vars'])
 
     # add special traits
     mesh.add_traits(gobject_id=HashableType())
     mesh.gobject_id = gobject.id
-    mesh.add_traits(other_info=trait.CUnicode())
-    trait.dlink((gobject, 'other_info'), (mesh, 'other_info'))        
+    mesh.add_traits(other_info=trait.CUnicode().tag(sync=True))
+    direct_link((gobject, 'other_info'), (mesh, 'other_info'))        
 
     return mesh
 
-def create_jslabelmesh_view(gobject, mapping=None):
+def create_jslabelmesh_view(gobject, mapping=None,
+                            jslink=False):
     """create PyThreeJS Text Mesh for GeometricObject
     and with one-way synchronisation
 
@@ -133,13 +143,16 @@ def create_jslabelmesh_view(gobject, mapping=None):
     gobject : GeometricObject
     mapping : None or dict
         if None, use default gobject->jsobject mapping
+    jslink : bool
+        if True, where possible, create client side links
+        http://ipywidgets.readthedocs.io/en/latest/examples/Widget%20Events.html#The-difference-between-linking-in-the-kernel-and-linking-in-the-client 
 
     Examples
     --------
     
     >>> import pandas3js as pjs
     >>> sphere = pjs.models.Sphere()
-    >>> lmesh = create_jslabelmesh_view(sphere)
+    >>> lmesh = pjs.views.create_jslabelmesh_view(sphere)
     >>> lmesh.position
     [0.0, 0.0, 0.0]
     >>> str(lmesh.material.map.string)
@@ -160,6 +173,11 @@ def create_jslabelmesh_view(gobject, mapping=None):
     [1.0, 3.0, 1.0]
     
     """
+    if jslink:
+        direct_link = widget.jsdlink
+    else:
+        direct_link = trait.dlink
+        
     class_str = obj_to_str(gobject)
     if hasattr(gobject, '_use_default_viewmap'):
         class_map = copy.deepcopy(gobject_jsmapping['default'])
@@ -189,19 +207,19 @@ def create_jslabelmesh_view(gobject, mapping=None):
     # add special traits
     mesh.add_traits(gobject_id=HashableType())
     mesh.gobject_id = gobject.id
-    mesh.add_traits(other_info=trait.CUnicode())    
+    mesh.add_traits(other_info=trait.CUnicode().tag(sync=True))    
 
     if not class_map['show_label']:
         mesh.visible = False
         return mesh
 
     # add directional synchronisation
-    trait.dlink((gobject, 'other_info'), (mesh, 'other_info'))        
-    trait.dlink((gobject, 'label'), (text_map, 'string'))
-    trait.dlink((gobject, 'position'), (mesh, 'position'))
-    trait.dlink((gobject, 'label_visible'), (mesh, 'visible'))
+    direct_link((gobject, 'other_info'), (mesh, 'other_info'))        
+    direct_link((gobject, 'label'), (text_map, 'string'))
+    direct_link((gobject, 'position'), (mesh, 'position'))
+    direct_link((gobject, 'label_visible'), (mesh, 'visible'))
+    direct_link((gobject, 'label_transparency'), (material, 'opacity'))
     trait.dlink((gobject, 'label_color'), (text_map, 'color'), colors.to_hex)
-    trait.dlink((gobject, 'label_transparency'), (material, 'opacity'))
     trait.dlink((gobject, 'label_transparency'), (material, 'transparent'),
                lambda t: True if t <= 0.999 else False)