Extract utility functions

Author: vidartf

js/src/_base/utils.js

@@ -357,6 +357,39 @@ function nestedDiff(newObj, oldObj) {
     return ret;
 }
 
+/**
+ * Get the scene object of an Object3D.
+ *
+ * @param {THREE.Object3D} object3d
+ * @returns The scene object, or null if it cannot be found
+ */
+function getObjectScene(object3d) {
+    while (object3d.parent) {
+        object3d = object3d.parent;
+    }
+    if (object3d.type === 'Scene') {
+        return object3d;
+    }
+    return null;
+}
+
+/**
+ * Get the scene model for a three Object3D model.
+ *
+ * @param {any} model
+ * @returns The scene object's model, or null if it cannot be found
+ */
+function getModelScene(model) {
+    let obj = model.obj;
+    while (obj.parent) {
+        obj = obj.parent;
+    }
+    if (obj.type === 'Scene') {
+        return obj.ipymodel;
+    }
+    return null;
+}
+
 
 module.exports = {
     createModel: createModel,
@@ -369,4 +402,6 @@ module.exports = {
     arrayDiff: arrayDiff,
     dictDiff: dictDiff,
     nestedDiff: nestedDiff,
+    getObjectScene: getObjectScene,
+    getModelScene: getModelScene,
 }

js/src/animation/AnimationAction.js

@@ -1,32 +1,12 @@
 var _ = require('underscore');
 var widgets = require("@jupyter-widgets/base");
+var utils = require("../_base/utils");
 var AnimationActionAutogen = require('./AnimationAction.autogen').AnimationActionModel;
 
 var THREE = require('three');
 
 var pkgName = require('../../package.json').name;
 
-function getObjectScene(object3d) {
-    while (object3d.parent) {
-        object3d = object3d.parent;
-    }
-    if (object3d.type === 'Scene') {
-        return object3d;
-    }
-    return null;
-}
-
-function getModelScene(model) {
-    let obj = model.obj;
-    while (obj.parent) {
-        obj = obj.parent;
-    }
-    if (obj.type === 'Scene') {
-        return obj.ipymodel;
-    }
-    return null;
-}
-
 var AnimationActionModel = AnimationActionAutogen.extend({
 
     defaults: function() {
@@ -70,7 +50,7 @@ var AnimationActionModel = AnimationActionAutogen.extend({
         this.obj.paused = false;
 
         var root = this.get('localRoot');
-        var scene = getModelScene(root);
+        var scene = utils.getModelScene(root);
         if (scene) {
             this.listenTo(scene, 'afterRender', this.animateFrame.bind(this));
         }
@@ -92,7 +72,7 @@ var AnimationActionModel = AnimationActionAutogen.extend({
         mixer.update(delta);
         // As long as root is in scene, this will trigger a re-render
         // The onAfterRender will then trigger a new frame
-        var scene = getModelScene(this.get('localRoot'));
+        var scene = utils.getModelScene(this.get('localRoot'));
         if (scene) {
             scene.trigger('rerender');
         }
@@ -118,7 +98,7 @@ var AnimationActionModel = AnimationActionAutogen.extend({
     },
 
     resetRenderHook: function() {
-        var scene = getModelScene(this.get('localRoot'));
+        var scene = utils.getModelScene(this.get('localRoot'));
         if (scene) {
             this.stopListening(scene, 'afterRender');
         }
@@ -223,4 +203,4 @@ var AnimationActionView = widgets.DOMWidgetView.extend({
 module.exports = {
     AnimationActionModel: AnimationActionModel,
     AnimationActionView: AnimationActionView,
-};
+};