three-render-objects 1.27.4 → 1.27.6

package/dist/three-render-objects.common.js

@@ -11,24 +11,15 @@ var TWEEN = require('@tweenjs/tween.js');
 var accessorFn = require('accessor-fn');
 var Kapsule = require('kapsule');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var TWEEN__default = /*#__PURE__*/_interopDefaultLegacy(TWEEN);
-var accessorFn__default = /*#__PURE__*/_interopDefaultLegacy(accessorFn);
-var Kapsule__default = /*#__PURE__*/_interopDefaultLegacy(Kapsule);
-
 function styleInject(css, ref) {
   if (ref === void 0) ref = {};
   var insertAt = ref.insertAt;
-
   if (!css || typeof document === 'undefined') {
     return;
   }
-
   var head = document.head || document.getElementsByTagName('head')[0];
   var style = document.createElement('style');
   style.type = 'text/css';
-
   if (insertAt === 'top') {
     if (head.firstChild) {
       head.insertBefore(style, head.firstChild);
@@ -38,7 +29,6 @@ function styleInject(css, ref) {
   } else {
     head.appendChild(style);
   }
-
   if (style.styleSheet) {
     style.styleSheet.cssText = css;
   } else {
@@ -60,44 +50,33 @@ function _defineProperty(obj, key, value) {
   } else {
     obj[key] = value;
   }
-
   return obj;
 }
-
 function _slicedToArray(arr, i) {
   return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest();
 }
-
 function _toConsumableArray(arr) {
   return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread();
 }
-
 function _arrayWithoutHoles(arr) {
   if (Array.isArray(arr)) return _arrayLikeToArray(arr);
 }
-
 function _arrayWithHoles(arr) {
   if (Array.isArray(arr)) return arr;
 }
-
 function _iterableToArray(iter) {
   if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
 }
-
 function _iterableToArrayLimit(arr, i) {
   var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"];
-
   if (_i == null) return;
   var _arr = [];
   var _n = true;
   var _d = false;
-
   var _s, _e;
-
   try {
     for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) {
       _arr.push(_s.value);
-
       if (i && _arr.length === i) break;
     }
   } catch (err) {
@@ -110,10 +89,8 @@ function _iterableToArrayLimit(arr, i) {
       if (_d) throw _e;
     }
   }
-
   return _arr;
 }
-
 function _unsupportedIterableToArray(o, minLen) {
   if (!o) return;
   if (typeof o === "string") return _arrayLikeToArray(o, minLen);
@@ -122,19 +99,14 @@ function _unsupportedIterableToArray(o, minLen) {
   if (n === "Map" || n === "Set") return Array.from(o);
   if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen);
 }
-
 function _arrayLikeToArray(arr, len) {
   if (len == null || len > arr.length) len = arr.length;
-
   for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i];
-
   return arr2;
 }
-
 function _nonIterableSpread() {
   throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
 }
-
 function _nonIterableRest() {
   throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
 }
@@ -160,7 +132,7 @@ var three = window.THREE ? window.THREE // Prefer consumption from global THREE,
   Spherical: three$1.Spherical,
   Clock: three$1.Clock
 };
-var threeRenderObjects = Kapsule__default["default"]({
+var threeRenderObjects = Kapsule({
   props: {
     width: {
       "default": window.innerWidth,
@@ -248,11 +220,9 @@ var threeRenderObjects = Kapsule__default["default"]({
         state.extraRenderers.forEach(function (r) {
           return r.render(state.scene, state.camera);
         });
-
         if (state.enablePointerInteraction) {
           // Update tooltip and trigger onHover events
           var topObject = null;
-
           if (state.hoverDuringDrag || !state.isPointerDragging) {
             var intersects = this.intersectingObjects(state.pointerPos.x, state.pointerPos.y).filter(function (d) {
               return state.hoverFilter(d.object);
@@ -263,31 +233,30 @@ var threeRenderObjects = Kapsule__default["default"]({
             topObject = topIntersect ? topIntersect.object : null;
             state.intersectionPoint = topIntersect ? topIntersect.point : null;
           }
-
           if (topObject !== state.hoverObj) {
             state.onHover(topObject, state.hoverObj);
-            state.toolTipElem.innerHTML = topObject ? accessorFn__default["default"](state.tooltipContent)(topObject) || '' : '';
+            state.toolTipElem.innerHTML = topObject ? accessorFn(state.tooltipContent)(topObject) || '' : '';
             state.hoverObj = topObject;
           }
         }
-
-        TWEEN__default["default"].update(); // update camera animation tweens
+        TWEEN.update(); // update camera animation tweens
       }
 
       return this;
     },
     getPointerPos: function getPointerPos(state) {
       var _state$pointerPos = state.pointerPos,
-          x = _state$pointerPos.x,
-          y = _state$pointerPos.y;
+        x = _state$pointerPos.x,
+        y = _state$pointerPos.y;
       return {
         x: x,
         y: y
       };
     },
     cameraPosition: function cameraPosition(state, position, lookAt, transitionDuration) {
-      var camera = state.camera; // Setter
+      var camera = state.camera;
 
+      // Setter
       if (position && state.initialised) {
         var finalPos = position;
         var finalLookAt = lookAt || {
@@ -295,7 +264,6 @@ var threeRenderObjects = Kapsule__default["default"]({
           y: 0,
           z: 0
         };
-
         if (!transitionDuration) {
           // no animation
           setCameraPos(finalPos);
@@ -303,31 +271,31 @@ var threeRenderObjects = Kapsule__default["default"]({
         } else {
           var camPos = Object.assign({}, camera.position);
           var camLookAt = getLookAt();
-          new TWEEN__default["default"].Tween(camPos).to(finalPos, transitionDuration).easing(TWEEN__default["default"].Easing.Quadratic.Out).onUpdate(setCameraPos).start(); // Face direction in 1/3rd of time
+          new TWEEN.Tween(camPos).to(finalPos, transitionDuration).easing(TWEEN.Easing.Quadratic.Out).onUpdate(setCameraPos).start();
 
-          new TWEEN__default["default"].Tween(camLookAt).to(finalLookAt, transitionDuration / 3).easing(TWEEN__default["default"].Easing.Quadratic.Out).onUpdate(setLookAt).start();
+          // Face direction in 1/3rd of time
+          new TWEEN.Tween(camLookAt).to(finalLookAt, transitionDuration / 3).easing(TWEEN.Easing.Quadratic.Out).onUpdate(setLookAt).start();
         }
-
         return this;
-      } // Getter
-
+      }
 
+      // Getter
       return Object.assign({}, camera.position, {
         lookAt: getLookAt()
-      }); //
+      });
+
+      //
 
       function setCameraPos(pos) {
         var x = pos.x,
-            y = pos.y,
-            z = pos.z;
+          y = pos.y,
+          z = pos.z;
         if (x !== undefined) camera.position.x = x;
         if (y !== undefined) camera.position.y = y;
         if (z !== undefined) camera.position.z = z;
       }
-
       function setLookAt(lookAt) {
         var lookAtVect = new three.Vector3(lookAt.x, lookAt.y, lookAt.z);
-
         if (state.controls.target) {
           state.controls.target = lookAtVect;
         } else {
@@ -343,11 +311,9 @@ var threeRenderObjects = Kapsule__default["default"]({
     zoomToFit: function zoomToFit(state) {
       var transitionDuration = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
       var padding = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 10;
-
       for (var _len = arguments.length, bboxArgs = new Array(_len > 3 ? _len - 3 : 0), _key = 3; _key < _len; _key++) {
         bboxArgs[_key - 3] = arguments[_key];
       }
-
       return this.fitToBbox(this.getBbox.apply(this, bboxArgs), transitionDuration, padding);
     },
     fitToBbox: function fitToBbox(state, bbox) {
@@ -355,31 +321,27 @@ var threeRenderObjects = Kapsule__default["default"]({
       var padding = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 10;
       // based on https://discourse.threejs.org/t/camera-zoom-to-fit-object/936/24
       var camera = state.camera;
-
       if (bbox) {
         var center = new three.Vector3(0, 0, 0); // reset camera aim to center
-
         var maxBoxSide = Math.max.apply(Math, _toConsumableArray(Object.entries(bbox).map(function (_ref) {
           var _ref2 = _slicedToArray(_ref, 2),
-              coordType = _ref2[0],
-              coords = _ref2[1];
-
+            coordType = _ref2[0],
+            coords = _ref2[1];
           return Math.max.apply(Math, _toConsumableArray(coords.map(function (c) {
             return Math.abs(center[coordType] - c);
           })));
-        }))) * 2; // find distance that fits whole bbox within padded fov
+        }))) * 2;
 
+        // find distance that fits whole bbox within padded fov
         var paddedFov = (1 - padding * 2 / state.height) * camera.fov;
         var fitHeightDistance = maxBoxSide / Math.atan(paddedFov * Math.PI / 180);
         var fitWidthDistance = fitHeightDistance / camera.aspect;
         var distance = Math.max(fitHeightDistance, fitWidthDistance);
-
         if (distance > 0) {
           var newCameraPosition = center.clone().sub(camera.position).normalize().multiplyScalar(-distance);
           this.cameraPosition(newCameraPosition, center, transitionDuration);
         }
       }
-
       return this;
     },
     getBbox: function getBbox(state) {
@@ -391,8 +353,9 @@ var threeRenderObjects = Kapsule__default["default"]({
       if (!objs.length) return null;
       objs.forEach(function (obj) {
         return box.expandByObject(obj);
-      }); // extract global x,y,z min/max
+      });
 
+      // extract global x,y,z min/max
       return Object.assign.apply(Object, _toConsumableArray(['x', 'y', 'z'].map(function (c) {
         return _defineProperty({}, c, [box.min[c], box.max[c]]);
       })));
@@ -400,7 +363,6 @@ var threeRenderObjects = Kapsule__default["default"]({
     getScreenCoords: function getScreenCoords(state, x, y, z) {
       var vec = new three.Vector3(x, y, z);
       vec.project(this.camera()); // project to the camera plane
-
       return {
         // align relative pos to canvas dimensions
         x: (vec.x + 1) * state.width / 2,
@@ -418,7 +380,6 @@ var threeRenderObjects = Kapsule__default["default"]({
       var relCoords = new three.Vector2(x / state.width * 2 - 1, -(y / state.height) * 2 + 1);
       var raycaster = new three.Raycaster();
       raycaster.params.Line.threshold = state.lineHoverPrecision; // set linePrecision
-
       raycaster.setFromCamera(relCoords, state.camera);
       return raycaster.intersectObjects(state.objects, true);
     },
@@ -440,8 +401,8 @@ var threeRenderObjects = Kapsule__default["default"]({
     tbControls: function tbControls(state) {
       return state.controls;
     } // to be deprecated
-
   },
+
   stateInit: function stateInit() {
     return {
       scene: new three.Scene(),
@@ -451,22 +412,23 @@ var threeRenderObjects = Kapsule__default["default"]({
   },
   init: function init(domNode, state) {
     var _ref4 = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {},
-        _ref4$controlType = _ref4.controlType,
-        controlType = _ref4$controlType === void 0 ? 'trackball' : _ref4$controlType,
-        _ref4$rendererConfig = _ref4.rendererConfig,
-        rendererConfig = _ref4$rendererConfig === void 0 ? {} : _ref4$rendererConfig,
-        _ref4$extraRenderers = _ref4.extraRenderers,
-        extraRenderers = _ref4$extraRenderers === void 0 ? [] : _ref4$extraRenderers,
-        _ref4$waitForLoadComp = _ref4.waitForLoadComplete,
-        waitForLoadComplete = _ref4$waitForLoadComp === void 0 ? true : _ref4$waitForLoadComp;
-
+      _ref4$controlType = _ref4.controlType,
+      controlType = _ref4$controlType === void 0 ? 'trackball' : _ref4$controlType,
+      _ref4$rendererConfig = _ref4.rendererConfig,
+      rendererConfig = _ref4$rendererConfig === void 0 ? {} : _ref4$rendererConfig,
+      _ref4$extraRenderers = _ref4.extraRenderers,
+      extraRenderers = _ref4$extraRenderers === void 0 ? [] : _ref4$extraRenderers,
+      _ref4$waitForLoadComp = _ref4.waitForLoadComplete,
+      waitForLoadComplete = _ref4$waitForLoadComp === void 0 ? true : _ref4$waitForLoadComp;
     // Wipe DOM
-    domNode.innerHTML = ''; // Add relative container
+    domNode.innerHTML = '';
 
+    // Add relative container
     domNode.appendChild(state.container = document.createElement('div'));
     state.container.className = 'scene-container';
-    state.container.style.position = 'relative'; // Add nav info section
+    state.container.style.position = 'relative';
 
+    // Add nav info section
     state.container.appendChild(state.navInfo = document.createElement('div'));
     state.navInfo.className = 'scene-nav-info';
     state.navInfo.textContent = {
@@ -474,44 +436,46 @@ var threeRenderObjects = Kapsule__default["default"]({
       trackball: 'Left-click: rotate, Mouse-wheel/middle-click: zoom, Right-click: pan',
       fly: 'WASD: move, R|F: up | down, Q|E: roll, up|down: pitch, left|right: yaw'
     }[controlType] || '';
-    state.navInfo.style.display = state.showNavInfo ? null : 'none'; // Setup tooltip
+    state.navInfo.style.display = state.showNavInfo ? null : 'none';
 
+    // Setup tooltip
     state.toolTipElem = document.createElement('div');
     state.toolTipElem.classList.add('scene-tooltip');
-    state.container.appendChild(state.toolTipElem); // Capture pointer coords on move or touchstart
+    state.container.appendChild(state.toolTipElem);
 
+    // Capture pointer coords on move or touchstart
     state.pointerPos = new three.Vector2();
     state.pointerPos.x = -2; // Initialize off canvas
-
     state.pointerPos.y = -2;
     ['pointermove', 'pointerdown'].forEach(function (evType) {
       return state.container.addEventListener(evType, function (ev) {
         // track click state
-        evType === 'pointerdown' && (state.isPointerPressed = true); // detect point drag
+        evType === 'pointerdown' && (state.isPointerPressed = true);
 
+        // detect point drag
         !state.isPointerDragging && ev.type === 'pointermove' && (ev.pressure > 0 || state.isPointerPressed) // ev.pressure always 0 on Safari, so we used the isPointerPressed tracker
         && (ev.pointerType !== 'touch' || ev.movementX === undefined || [ev.movementX, ev.movementY].some(function (m) {
           return Math.abs(m) > 1;
         })) // relax drag trigger sensitivity on touch events
         && (state.isPointerDragging = true);
-
         if (state.enablePointerInteraction) {
           // update the pointer pos
           var offset = getOffset(state.container);
           state.pointerPos.x = ev.pageX - offset.left;
-          state.pointerPos.y = ev.pageY - offset.top; // Move tooltip
+          state.pointerPos.y = ev.pageY - offset.top;
 
+          // Move tooltip
           state.toolTipElem.style.top = "".concat(state.pointerPos.y, "px");
-          state.toolTipElem.style.left = "".concat(state.pointerPos.x, "px"); // adjust horizontal position to not exceed canvas boundaries
-
-          state.toolTipElem.style.transform = "translate(-".concat(state.pointerPos.x / state.width * 100, "%, ").concat( // flip to above if near bottom
+          state.toolTipElem.style.left = "".concat(state.pointerPos.x, "px");
+          // adjust horizontal position to not exceed canvas boundaries
+          state.toolTipElem.style.transform = "translate(-".concat(state.pointerPos.x / state.width * 100, "%, ").concat(
+          // flip to above if near bottom
           state.height - state.pointerPos.y < 100 ? 'calc(-100% - 8px)' : '21px', ")");
         }
-
         function getOffset(el) {
           var rect = el.getBoundingClientRect(),
-              scrollLeft = window.pageXOffset || document.documentElement.scrollLeft,
-              scrollTop = window.pageYOffset || document.documentElement.scrollTop;
+            scrollLeft = window.pageXOffset || document.documentElement.scrollLeft,
+            scrollTop = window.pageYOffset || document.documentElement.scrollTop;
           return {
             top: rect.top + scrollTop,
             left: rect.left + scrollLeft
@@ -520,11 +484,11 @@ var threeRenderObjects = Kapsule__default["default"]({
       }, {
         passive: true
       });
-    }); // Handle click events on objs
+    });
 
+    // Handle click events on objs
     state.container.addEventListener('pointerup', function (ev) {
       state.isPointerPressed = false;
-
       if (state.isPointerDragging) {
         state.isPointerDragging = false;
         if (!state.clickAfterDrag) return; // don't trigger onClick after pointer drag (camera motion via controls)
@@ -549,16 +513,17 @@ var threeRenderObjects = Kapsule__default["default"]({
 
     state.container.addEventListener('contextmenu', function (ev) {
       if (state.onRightClick) ev.preventDefault(); // prevent default contextmenu behavior and allow pointerup to fire instead
-    }); // Setup renderer, camera and controls
+    });
 
+    // Setup renderer, camera and controls
     state.renderer = new three.WebGLRenderer(Object.assign({
       antialias: true,
       alpha: true
     }, rendererConfig));
     state.renderer.setPixelRatio(Math.min(2, window.devicePixelRatio)); // clamp device pixel ratio
+    state.container.appendChild(state.renderer.domElement);
 
-    state.container.appendChild(state.renderer.domElement); // Setup extra renderers
-
+    // Setup extra renderers
     state.extraRenderers = extraRenderers;
     state.extraRenderers.forEach(function (r) {
       // overlay them on top of main renderer
@@ -566,24 +531,23 @@ var threeRenderObjects = Kapsule__default["default"]({
       r.domElement.style.top = '0px';
       r.domElement.style.pointerEvents = 'none';
       state.container.appendChild(r.domElement);
-    }); // configure post-processing composer
+    });
 
+    // configure post-processing composer
     state.postProcessingComposer = new EffectComposer_js.EffectComposer(state.renderer);
     state.postProcessingComposer.addPass(new RenderPass_js.RenderPass(state.scene, state.camera)); // render scene as first pass
-    // configure controls
 
+    // configure controls
     state.controls = new {
       trackball: TrackballControls_js.TrackballControls,
       orbit: OrbitControls_js.OrbitControls,
       fly: FlyControls_js.FlyControls
     }[controlType](state.camera, state.renderer.domElement);
-
     if (controlType === 'fly') {
       state.controls.movementSpeed = 300;
       state.controls.rollSpeed = Math.PI / 6;
       state.controls.dragToLook = true;
     }
-
     if (controlType === 'trackball' || controlType === 'orbit') {
       state.controls.minDistance = 0.1;
       state.controls.maxDistance = state.skyRadius;
@@ -600,14 +564,14 @@ var threeRenderObjects = Kapsule__default["default"]({
         state.controlsDragging = false;
       });
     }
-
     [state.renderer, state.postProcessingComposer].concat(_toConsumableArray(state.extraRenderers)).forEach(function (r) {
       return r.setSize(state.width, state.height);
     });
     state.camera.aspect = state.width / state.height;
     state.camera.updateProjectionMatrix();
-    state.camera.position.z = 1000; // add sky
+    state.camera.position.z = 1000;
 
+    // add sky
     state.scene.add(state.skysphere = new three.Mesh());
     state.skysphere.visible = false;
     state.loadComplete = state.scene.visible = !waitForLoadComplete;
@@ -624,20 +588,17 @@ var threeRenderObjects = Kapsule__default["default"]({
       state.camera.aspect = state.width / state.height;
       state.camera.updateProjectionMatrix();
     }
-
     if (changedProps.hasOwnProperty('skyRadius') && state.skyRadius) {
       state.controls.hasOwnProperty('maxDistance') && changedProps.skyRadius && (state.controls.maxDistance = Math.min(state.controls.maxDistance, state.skyRadius));
       state.camera.far = state.skyRadius * 2.5;
       state.camera.updateProjectionMatrix();
       state.skysphere.geometry = new three.SphereGeometry(state.skyRadius);
     }
-
     if (changedProps.hasOwnProperty('backgroundColor')) {
       var alpha = polished.parseToRgb(state.backgroundColor).alpha;
       if (alpha === undefined) alpha = 1;
       state.renderer.setClearColor(new three.Color(polished.opacify(1, state.backgroundColor)), alpha);
     }
-
     if (changedProps.hasOwnProperty('backgroundImageUrl')) {
       if (!state.backgroundImageUrl) {
         state.skysphere.visible = false;
@@ -649,26 +610,25 @@ var threeRenderObjects = Kapsule__default["default"]({
             map: texture,
             side: three.BackSide
           });
-          state.skysphere.visible = true; // triggered when background image finishes loading (asynchronously to allow 1 frame to load texture)
+          state.skysphere.visible = true;
 
+          // triggered when background image finishes loading (asynchronously to allow 1 frame to load texture)
           state.onBackgroundImageLoaded && setTimeout(state.onBackgroundImageLoaded);
           !state.loadComplete && finishLoad();
         });
       }
     }
-
     changedProps.hasOwnProperty('showNavInfo') && (state.navInfo.style.display = state.showNavInfo ? null : 'none');
-
     if (changedProps.hasOwnProperty('objects')) {
       (changedProps.objects || []).forEach(function (obj) {
         return state.scene.remove(obj);
       }); // Clear the place
-
       state.objects.forEach(function (obj) {
         return state.scene.add(obj);
       }); // Add to scene
-    } //
+    }
 
+    //
 
     function finishLoad() {
       state.loadComplete = state.scene.visible = true;

package/dist/three-render-objects.d.ts

@@ -1,4 +1,7 @@
 import { WebGLRendererParameters, Renderer, Object3D, WebGLRenderer, Scene, Camera, Intersection } from 'three';
+import { TrackballControls } from 'three/examples/jsm/controls/TrackballControls.js';
+import { OrbitControls } from 'three/examples/jsm/controls/OrbitControls.js';
+import { FlyControls } from 'three/examples/jsm/controls/FlyControls.js';
 import { EffectComposer } from 'three/examples/jsm/postprocessing/EffectComposer.js';
 
 interface ConfigOptions {
@@ -48,7 +51,7 @@ interface ThreeRenderObjectsGenericInstance<ChainableInstance> {
   renderer(): WebGLRenderer;
   scene(): Scene;
   camera(): Camera;
-  controls(): object;
+  controls(): TrackballControls | OrbitControls | FlyControls;
 
   // Interaction
   onClick(callback: (obj: object | null, event: MouseEvent, intersectionPoint: { x: number, y: number, z: number }) => void): ChainableInstance;