split prepareRegl and clearGlCanvases into two modules

etpinard · etpinard · commit 658c529470b6 · 2018-03-28T18:53:39.000-04:00
- so that plot_api.js can require clearGlCanvases w/o requiring
  all of regl.
- this also makes the ie9_test.js pass again !
diff --git a/src/lib/clear_gl_canvases.js b/src/lib/clear_gl_canvases.js
@@ -0,0 +1,26 @@
+/**
+* Copyright 2012-2018, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+'use strict';
+
+/**
+ * Clear gl frame (if any). This is a common pattern as
+ * we usually set `preserveDrawingBuffer: true` during
+ * gl context creation (e.g. via `reglUtils.prepare`).
+ *
+ * @param {DOM node or object} gd : graph div object
+ */
+module.exports = function clearGlCanvases(gd) {
+    var fullLayout = gd._fullLayout;
+
+    if(fullLayout._glcanvas && fullLayout._glcanvas.size()) {
+        fullLayout._glcanvas.each(function(d) {
+            if(d.regl) d.regl.clear({color: true});
+        });
+    }
+};
diff --git a/src/lib/prepare_regl.js b/src/lib/prepare_regl.js
@@ -8,6 +8,10 @@
 
 'use strict';
 
+// Note that this module should be ONLY required into
+// files corresponding to regl trace modules
+// so that bundles with non-regl only don't include
+// regl and all its bytes.
 var createRegl = require('regl');
 
 /**
@@ -18,7 +22,7 @@ var createRegl = require('regl');
  * @param {DOM node or object} gd : graph div object
  * @param {array} extensions : list of extension to pass to createRegl
  */
-exports.prepare = function prepare(gd, extensions) {
+module.exports = function prepareRegl(gd, extensions) {
     gd._fullLayout._glcanvas.each(function(d) {
         if(d.regl) return;
 
@@ -33,20 +37,3 @@ exports.prepare = function prepare(gd, extensions) {
         });
     });
 };
-
-/**
- * Clear gl frame (if any). This is a common pattern as
- * we usually set `preserveDrawingBuffer: true` during
- * gl context creation (e.g. via `reglUtils.prepare`).
- *
- * @param {DOM node or object} gd : graph div object
- */
-exports.clear = function clear(gd) {
-    var fullLayout = gd._fullLayout;
-
-    if(fullLayout._glcanvas && fullLayout._glcanvas.size()) {
-        fullLayout._glcanvas.each(function(d) {
-            if(d.regl) d.regl.clear({color: true});
-        });
-    }
-};
diff --git a/src/plot_api/plot_api.js b/src/plot_api/plot_api.js
@@ -29,7 +29,7 @@ var Drawing = require('../components/drawing');
 var Color = require('../components/color');
 var xmlnsNamespaces = require('../constants/xmlns_namespaces');
 var svgTextUtils = require('../lib/svg_text_utils');
-var reglUtils = require('../lib/regl_utils');
+var clearGlCanvases = require('../lib/clear_gl_canvases');
 
 var defaultConfig = require('./plot_config');
 var manageArrays = require('./manage_arrays');
@@ -386,9 +386,7 @@ exports.plot = function(gd, data, layout, config) {
         }
 
         // TODO does this break or slow down parcoords??
-        if(fullLayout._glcanvas) {
-            reglUtils.clear(gd);
-        }
+        clearGlCanvases(gd);
 
         // loop over the base plot modules present on graph
         var basePlotModules = fullLayout._basePlotModules;
diff --git a/src/plots/cartesian/dragbox.js b/src/plots/cartesian/dragbox.js
@@ -16,7 +16,7 @@ var supportsPassive = require('has-passive-events');
 var Registry = require('../../registry');
 var Lib = require('../../lib');
 var svgTextUtils = require('../../lib/svg_text_utils');
-var reglUtils = require('../../lib/regl_utils');
+var clearGlCanvases = require('../../lib/clear_gl_canvases');
 var Color = require('../../components/color');
 var Drawing = require('../../components/drawing');
 var Fx = require('../../components/fx');
@@ -714,7 +714,7 @@ function makeDragBox(gd, plotinfo, x, y, w, h, ns, ew) {
             return ax._length * (1 - scaleFactor) * FROM_TL[ax.constraintoward || 'middle'];
         }
 
-        reglUtils.clear(gd);
+        clearGlCanvases(gd);
 
         for(i = 0; i < subplots.length; i++) {
             var subplot = plotinfos[subplots[i]],
diff --git a/src/traces/parcoords/plot.js b/src/traces/parcoords/plot.js
@@ -9,15 +9,15 @@
 'use strict';
 
 var parcoords = require('./parcoords');
-var reglUtils = require('../../lib/regl_utils');
+var prepareRegl = require('../../lib/prepare_regl');
 
 module.exports = function plot(gd, cdparcoords) {
     var fullLayout = gd._fullLayout;
     var svg = fullLayout._toppaper;
     var root = fullLayout._paperdiv;
     var container = fullLayout._glcontainer;
 
-    reglUtils.prepare(gd);
+    prepareRegl(gd);
 
     var gdDimensions = {};
     var gdDimensionsOriginalOrder = {};
diff --git a/src/traces/scattergl/index.js b/src/traces/scattergl/index.js
@@ -16,7 +16,7 @@ var arrayRange = require('array-range');
 
 var Registry = require('../../registry');
 var Lib = require('../../lib');
-var reglUtils = require('../../lib/regl_utils');
+var prepareRegl = require('../../lib/prepare_regl');
 var AxisIDs = require('../../plots/cartesian/axis_ids');
 
 var subTypes = require('../scatter/subtypes');
@@ -336,7 +336,7 @@ function plot(gd, subplot, cdata) {
     var width = fullLayout.width;
     var height = fullLayout.height;
 
-    reglUtils.prepare(gd, ['ANGLE_instanced_arrays', 'OES_element_index_uint']);
+    prepareRegl(gd, ['ANGLE_instanced_arrays', 'OES_element_index_uint']);
     var regl = fullLayout._glcanvas.data()[0].regl;
 
     // that is needed for fills
diff --git a/src/traces/splom/base_plot.js b/src/traces/splom/base_plot.js
@@ -12,7 +12,7 @@ var createLine = require('regl-line2d');
 
 var Registry = require('../../registry');
 var Lib = require('../../lib');
-var reglUtils = require('../../lib/regl_utils');
+var prepareRegl = require('../../lib/prepare_regl');
 var getModuleCalcData = require('../../plots/get_data').getModuleCalcData;
 var Cartesian = require('../../plots/cartesian');
 var AxisIDs = require('../../plots/cartesian/axis_ids');
@@ -24,7 +24,7 @@ function plot(gd) {
     var _module = Registry.getModule(SPLOM);
     var splomCalcData = getModuleCalcData(gd.calcdata, _module);
 
-    reglUtils.prepare(gd, ['ANGLE_instanced_arrays', 'OES_element_index_uint']);
+    prepareRegl(gd, ['ANGLE_instanced_arrays', 'OES_element_index_uint']);
 
     if(fullLayout._hasOnlyLargeSploms) {
         drawGrid(gd);
