Store the feature in the Cesium counterpart.

Immediately give access to the feature while picking.

Author: gberaudo

Cesium.externs.js

@@ -122,7 +122,7 @@ Cesium.optionsBillboardCollectionAdd;
 
 /**
  * @param {Cesium.optionsBillboardCollectionAdd} opt_opts .
- * @return {Cesium.Billboard} .
+ * @return {!Cesium.Billboard} .
  */
 Cesium.BillboardCollection.prototype.add = function(opt_opts) {};
 
@@ -956,12 +956,11 @@ Cesium.optionsPrimitive;
 Cesium.Primitive = function(opt_opts) {};
 
 /**
- * Workaround for finding the feature associated to a primitive.
- * Required since the Primitive lacks a dedicated id property, as shown in:
+ * Custom property for storing the associated Ol3 feature.
  * http://cesiumjs.org/Cesium/Apps/Sandcastle/index.html?src=Picking.html&label=Showcases
- * @type {string|number|undefined}
+ * @type {ol.Feature}
  */
-Cesium.Primitive.prototype.olFeatureId;
+Cesium.Primitive.prototype.olFeature;
 
 /**
  * @constructor

examples/synthvectors.js

@@ -85,10 +85,10 @@ handler.setInputAction(function(movement) {
    if (Cesium.defined(pickedObjects)) {
     for (i = 0; i < pickedObjects.length; ++i) {
       var picked = pickedObjects[i].primitive;
-      if (picked.olFeatureId == lastPicked) continue;
+      if (picked.olFeature == lastPicked) continue;
       var carto = Cesium.Ellipsoid.WGS84.cartesianToCartographic(picked.position);
-      console.log('Picked feature', picked.olFeatureId, ' is at ', carto);
-      lastPicked = picked.olFeatureId;
+      console.log('Picked feature', picked.olFeature, ' is at ', carto);
+      lastPicked = picked.olFeature;
     }
   } else {
     lastPicked = undefined;

examples/synthvectors_batch.js

@@ -88,10 +88,10 @@ handler.setInputAction(function(movement) {
    if (Cesium.defined(pickedObjects)) {
     for (i = 0; i < pickedObjects.length; ++i) {
       var picked = pickedObjects[i].primitive;
-      if (picked.olFeatureId == lastPicked) continue;
+      if (picked.olFeature == lastPicked) continue;
       var carto = Cesium.Ellipsoid.WGS84.cartesianToCartographic(picked.position);
-      console.log('Picked feature', picked.olFeatureId, ' is at ', carto);
-      lastPicked = picked.olFeatureId;
+      console.log('Picked feature', picked.olFeature, ' is at ', carto);
+      lastPicked = picked.olFeature;
     }
   } else {
     lastPicked = undefined;

src/core.js

@@ -762,13 +762,13 @@ goog.require('olcs.core.OlLayerPrimitive');
    * @param {!ol.proj.ProjectionLike} projection
    * @param {!ol.style.Style} style
    * @param {!Cesium.BillboardCollection} billboards
-   * @param {number} featureId
-   * @param {Object.<number,!Cesium.Primitive|!Cesium.Billboard>=} opt_featureToCesiumMap
+   * @param {function(!Cesium.Billboard)=} opt_newBillboardCallback Called when
+   * the new billboard is added.
    * @return {Cesium.Primitive} primitives
    * @api
    */
   olcs.core.olPointGeometryToCesium = function(geometry, projection, style,
-      billboards, featureId, opt_featureToCesiumMap) {
+      billboards, opt_newBillboardCallback) {
     goog.asserts.assert(geometry.getType() == 'Point');
     geometry = olGeometryCloneTo4326(geometry, projection);
 
@@ -793,9 +793,8 @@ goog.require('olcs.core.OlLayerPrimitive');
         verticalOrigin: Cesium.VerticalOrigin.BOTTOM,
         position: position
       });
-      bb.olFeatureId = featureId;
-      if (goog.isDef(opt_featureToCesiumMap)) {
-        opt_featureToCesiumMap[featureId] = bb;
+      if (opt_newBillboardCallback) {
+        opt_newBillboardCallback(bb);
       }
     };
 
@@ -823,12 +822,13 @@ goog.require('olcs.core.OlLayerPrimitive');
    * @param {!ol.geom.Geometry} geometry Ol3 geometry.
    * @param {!ol.proj.ProjectionLike} projection
    * @param {!ol.style.Style} olStyle
-   * @param {?} featureId
+   * @param {function(!Cesium.Billboard)=} opt_newBillboardCallback Called when
+   * the new billboard is added.
    * @return {!Cesium.Primitive} primitives
    * @api
    */
   olcs.core.olMultiGeometryToCesium = function(geometry, projection,
-      olStyle, featureId) {
+      olStyle, opt_newBillboardCallback) {
     // Do not reproject to 4326 now because it will be done later.
 
     // FIXME: would be better to combine all child geometries in one primitive
@@ -853,7 +853,7 @@ goog.require('olcs.core.OlLayerPrimitive');
           goog.array.forEach(subgeos, function(geometry) {
             goog.asserts.assert(geometry);
             var result = fn(geometry, projection, olStyle, billboards,
-                featureId);
+                opt_newBillboardCallback);
             if (result) {
               primitives.add(result);
             }
@@ -862,7 +862,8 @@ goog.require('olcs.core.OlLayerPrimitive');
         } else {
           goog.array.forEach(subgeos, function(geometry) {
             goog.asserts.assert(!goog.isNull(geometry));
-            fn(geometry, projection, olStyle, billboards, featureId);
+            fn(geometry, projection, olStyle, billboards,
+                opt_newBillboardCallback);
           });
           return billboards;
         }
@@ -1083,9 +1084,14 @@ goog.require('olcs.core.OlLayerPrimitive');
     var geom = opt_geom || feature.getGeometry();
     var proj = context.projection;
 
-    var id = function(primitives) {
-      primitives.olFeatureId = goog.getUid(feature);
-      return primitives;
+    var id = function(object) {
+      object.olFeature = feature;
+      return object;
+    };
+
+    var newBillboardAddedCallback = function(bb) {
+      context.featureToCesiumMap[goog.getUid(feature)] = bb;
+      id(bb);
     };
 
     switch (geom.getType()) {
@@ -1106,7 +1112,7 @@ goog.require('olcs.core.OlLayerPrimitive');
         geom = /** @type {!ol.geom.Point} */ (geom);
         var bbs = context.billboards;
         var result = olcs.core.olPointGeometryToCesium(geom, proj, style, bbs,
-            goog.getUid(feature), context.featureToCesiumMap);
+            newBillboardAddedCallback);
         if (!result) {
           // no wrapping primitive
           return null;
@@ -1126,7 +1132,7 @@ goog.require('olcs.core.OlLayerPrimitive');
       case 'MultiLineString':
       case 'MultiPolygon':
         return id(olcs.core.olMultiGeometryToCesium(geom, proj, style,
-            goog.getUid(feature)));
+            newBillboardAddedCallback));
       case 'LinearRing':
         throw new Error('LinearRing should only be part of polygon.');
       default: