zincjs 2.4.1-beta.4 → 2.4.1-beta.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. package/README.md +10 -0
  2. package/build/zinc.js +3 -3
  3. package/build/zinc.js.map +1 -1
  4. package/package.json +1 -1
  5. package/src/controls.js +71 -49
  6. package/src/loaders/primitivesLoader.js +59 -16
  7. package/src/minimap.js +48 -13
  8. package/src/primitives/geometry.js +2 -0
  9. package/src/primitives/glyph.js +11 -1
  10. package/src/primitives/glyphset.js +26 -9
  11. package/src/primitives/label.js +39 -24
  12. package/src/primitives/lines.js +2 -0
  13. package/src/primitives/lines2.js +76 -24
  14. package/src/primitives/lod.js +11 -4
  15. package/src/primitives/marker.js +6 -1
  16. package/src/primitives/markerCluster.js +5 -1
  17. package/src/primitives/pointset.js +33 -28
  18. package/src/primitives/textureSlides.js +19 -3
  19. package/src/primitives/textureVolume.js +2 -0
  20. package/src/primitives/tubeLines.js +4 -0
  21. package/src/primitives/zincObject.js +76 -10
  22. package/src/region.js +85 -35
  23. package/src/renderRequests.js +20 -0
  24. package/src/renderer.js +85 -13
  25. package/src/scene.js +132 -22
  26. package/src/sceneExporter.js +4 -0
  27. package/src/sceneLoader.js +58 -19
  28. package/src/textSprite.js +211 -0
  29. package/src/tsl/glyphTransform.js +85 -54
  30. package/src/utilities.js +147 -47
package/README.md CHANGED
@@ -55,6 +55,16 @@ renderer.animate();
55
55
 
56
56
  `initialiseVisualisation` is asynchronous and must finish before any scene is used. Other formats can be loaded with `scene.loadGLTF`, `scene.loadOBJ` and `scene.loadSTL`, and NIfTI images with `Zinc.createPrimitivesFromNIFTI`.
57
57
 
58
+ ### Render on demand
59
+
60
+ By default the renderer draws every animation frame. To only draw when something has changed, which saves GPU time and battery on idle pages, enable render on demand:
61
+
62
+ ```javascript
63
+ renderer.setRenderOnDemand(true);
64
+ ```
65
+
66
+ Camera movement, playback, loading, changes made through the ZincJS APIs and changes to scene properties such as `displayMinimap`, `displayMiniAxes` or `displayMarkers` request a frame automatically. Call `renderer.invalidate()` after changing three.js objects directly, or after changing the three.js renderer from `getThreeJSRenderer()`, e.g. `setClearColor`. Pre-render callbacks still run every frame and can call `invalidate()`; post-render callbacks only run when a frame is drawn.
67
+
58
68
  Useful links:
59
69
 
60
70
  * [Examples](https://github.com/alan-wu/ZincJS-Examples/)