potree-core 2.0.3 → 2.0.5

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Tentone
+Copyright (c) Tentone
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -62,4 +62,22 @@ http://plas.io/
 
 The MIT License (MIT)
 
-Copyright (c) 2014 Uday Verma, uday.karan@gmail.com
+Copyright (c) 2014 Uday Verma, uday.karan@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -1,173 +1,72 @@
-# Potree Core
+# Potree Core 2.0
 
 [![npm version](https://badge.fury.io/js/potree-core.svg)](https://badge.fury.io/js/potree-core)
 [![GitHub version](https://badge.fury.io/gh/tentone%2Fpotree-core.svg)](https://badge.fury.io/gh/tentone%2Fpotree-core)
 
- - This project was originally based on Potree 1.6 and is now since version 2.0 based on [fork]https://github.com/shiukaheng/potree-loader] of the [Potree-Loader](https://github.com/pnext/three-loader).
+ - This project was originally based on [Potree Viewer 1.6](https://github.com/potree/potree) and is now since version 2.0 based on the [shiukaheng fork](https://github.com/shiukaheng/potree-loader) of the [Potree-Loader](https://github.com/pnext/three-loader).
  - Potree is a web based pouint cloud visualizer project created by Markus Schütz.
- - This project contains only the main parts of the potree project adapted to be more easily used as a independent library (I have only adapted code from the original repository).
- - Support for pointclouds from LAS, LAZ, Binary files and Greyhound server.
- - Point clouds are automatically updated, frustum culling is used to avoid unnecessary updates (better update performance for multiple point clouds).
- - Supports logarithmic depth buffer (just by enabling it on the threejs renderer), useful for large scale visualization.
-
-
-
-### How to use
- - Download the custom potree build from the build folder or add it to your project using NPM.
-    - https://www.npmjs.com/package/potree-core
- - Include it alonside the worker folder in your project (can be found on the source folder).
- - Download threejs from github repository.
-    - https://github.com/mrdoob/three.js/tree/dev/build
- - The build is a ES module, that can be imported to other projects, it assumes the existence of THREE namespace for threejs dependencies.
-
-
+ - This project contains only the main parts of the potree project adapted to be more easily used as a independent library, the code was adapted from the original repositorys.
+ - Support for pointclouds from LAS, LAZ, Binary files.
+ - Some features require support for the following GL extensions
+   - EXT_frag_depth, WEBGL_depth_texture, OES_vertex_array_object
 
-### Demo
+## Demo
  - Live demo at https://tentone.github.io/potree-core/
- - Contains the same model multiple times stored in different formats.
  - Double click the models to raycast the scene and create marker points.
 
 <img src="https://raw.githubusercontent.com/tentone/potree-core/master/screenshot.png" width="700">
 
 
-### Example
- - Bellow its a fully functional example of how to use this wrapper to load potree point clouds to a THREE.js project
+## Example
+ - The project can be build running the commands `npm install` and `npm run build`.
+ - Download the potree build from the build folder or add it to your project using NPM.
+ - Include it alonside the worker folder in your project (can be found on the source folder).
+ - The build is a ES module, that can be imported to other projects, threejs should be available as a peer dependency.
+ - Bellow its a fully functional example of how to use this wrapper to load potree point clouds to a three.js project
 
 ```javascript
-var scene = new THREE.Scene();
-var camera = new THREE.PerspectiveCamera(60, 1, 0.1, 10000);
-
-var canvas = document.createElement("canvas");
-canvas.style.position = "absolute";
-canvas.style.top = "0px";
-canvas.style.left = "0px";
-canvas.style.width = "100%";
-canvas.style.height = "100%";
-document.body.appendChild(canvas);
-
-var renderer = new THREE.WebGLRenderer({canvas:canvas});
-
-var geometry = new THREE.BoxGeometry(1, 1, 1);
-var material = new THREE.MeshBasicMaterial({color: 0x00ff00});
-var cube = new THREE.Mesh(geometry, material);
+const scene = new Scene();
+const camera = new PerspectiveCamera(60, 1, 0.1, 10000);
+
+const canvas = document.getElementById("canvas");
+
+const renderer = new WebGLRenderer({canvas:canvas});
+
+const geometry = new BoxGeometry(1, 1, 1);
+const material = new MeshBasicMaterial({color: 0x00ff00});
+const cube = new Mesh(geometry, material);
 scene.add(cube);
 
-var controls = new THREE.OrbitControls(camera, canvas);
+const controls = new OrbitControls(camera, canvas);
 camera.position.z = 10;
 
-var points = new Potree.Group();
-points.setPointBudget(10000000)
-scene.add(points);
+const pointClouds = [];
 
-Potree.loadPointCloud("data/test/cloud.js", name, function(data)
-{
-	var pointcloud = data.pointcloud;
-	points.add(pointcloud);
+const baseUrl = "data/test/";
+const potree = new Potree();
+potree.loadPointCloud("cloud.js", url => `${baseUrl}${url}`,).then(function(pco) {
+   scene.add(pco);
+	pointClouds.push(pco);
 });
 
 function loop()
 {
+   potree.updatePointClouds(pointClouds, camera, renderer);
+
 	controls.update();
 	renderer.render(scene, camera);
+
 	requestAnimationFrame(loop);
 };
 loop();
-
-document.body.onresize = function()
-{
-	var width = window.innerWidth;
-	var height = window.innerHeight;
-	renderer.setSize(width, height);
-	camera.aspect = width / height;
-	camera.updateProjectionMatrix();
-}
-document.body.onresize();
 ```
 
-
-
-### API Reference
-
- - The project has no generated documentation but bellow are some of the main configuration elements.
- - A example can be found in the repository `index.html` file.
-
-
-
-##### Potree.BasicGroup
-
-- Container that stores point cloud objects and updates them on render.
-- The container supports frustum culling using the point cloud bouding box.
-- Automatically stops updating the point cloud if out of view.
-- This container only support pointColorType set as RGB, pointSizeType set as FIXED and shape set as SQUARE.
-
-
-
-##### Potree.Group
-
-- Complete container with support for all potree features.
-- Some features require support for the following GL extensions
-
-   - EXT_frag_depth, WEBGL_depth_texture, OES_vertex_array_object
-
-   
-
-##### Potree.loadPointCloud
-
-- Method to load a point cloud database file
-- `Potree.loadPointCloud(url, name, onLoad)`
-
-
-
-##### Potree.PointCloudMaterial
-
-- Material used by threejs to draw the point clouds, based on RawShaderMaterial
-- shape
-   - Defines the shape used to draw points
-      - Potree.PointShape.SQUARE
-      - Potree.PointShape.CIRCLE
-      - Potree.PointShape.PARABOLOID
-- pointSizeType
-   - Defines how the point cloud points are sized, fixed mode keeps the same size, adaptive resizes points accordingly to their distance to the camera 
-   - Possible values are
-      - Potree.PointSizeType.FIXED
-      - Potree.PointSizeType.ATTENUATED
-      - Potree.PointSizeType.ADAPTIVE
-- pointColorType
-   - Defines how to color the drawn points
-   - Possible values are
-      - Potree.PointColorType.RGB
-      - Potree.PointColorType.COLOR
-      - Potree.PointColorType.DEPTH
-      - Potree.PointColorType.HEIGHT
-      - Potree.PointColorType.INTENSITY
-      - Potree.PointColorType.INTENSITY_GRADIENT
-      - Potree.PointColorType.LOD
-      - Potree.PointColorType.POINT_INDEX
-      - Potree.PointColorType.CLASSIFICATION
-      - Potree.PointColorType.RETURN_NUMBER
-      - Potree.PointColorType.SOURCE
-      - Potree.PointColorType.NORMAL
-      - Potree.PointColorType.PHONG
-      - Potree.PointColorType.RGB_HEIGHT
-- logarithmicDepthBuffer
-   - Set true to enable logarithmic depth buffer
-- weighted
-   - If true points are drawn as weighted splats
-- treeType
-   - Defines the type of point cloud tree being drawn by this material
-   - This should be automatically defined by the loader
-      - Potree.TreeType.OCTREE
-      - Potree.TreeType.KDTREE
-
- - Potree.PointCloudTree
-    - Base Object3D used to store and represent point cloud data.
-    - These objects are created by the loader
-
-### Notes
+## Notes
  - Since potree-core is meant to be used as library and not as a full software as potree some features are not available.
- - EDL shading is not supported by potree core (might be added later).
+ - EDL shading is not supported by potree core.
  - Removed classification and clipping functionality.
  - Removed Arena 4D point cloud support.
+ - Removed Entwine Point Tile file support.
  - GUI elements were removed from the library
    - PotreeViewer
    - Controls, Input, GUI, Tools
@@ -179,10 +78,7 @@ document.body.onresize();
      - JQuery, TWEEN and Proj4 dependencies
 
 
-### Building
- - The project can be build running the commands `npm install` and `npm run build`.
-
-### Potree Converter
+## Potree Converter
  - Use the (Potree Converter)[https://github.com/potree/PotreeConverter/releases] tool to create point cloud data from LAS, ZLAS or BIN point cloud files
  - Potree Converter 1.8 creates a multi file structure with each node as an individual file.
  - Potree Converter 2.1 creates a single file for all points and separates files for hierarchy index, its faster to create files. Requires a HTTP server configured for file streaming.
@@ -190,9 +86,13 @@ document.body.onresize();
  - There are two main versions 2.1 witch generates 4 contained files with point data, hierarchy, 
  - To generate a folder output from a input file run the command `.\PotreeConverter '..\input.laz' -o ../output`
 
+
 ### TXT2LAS
  - The potree converter tool only supports las and laz files, so textural file formats such as .pts, .xyz, have to be first converted into a supported format.
  - The TXT2LAS tool from the (LASTools)[https://github.com/LAStools/LAStools] repository can be used for this effect.
  - To run the tool use the command `.\txt2las64 -i input.pts -ipts -parse xyziRGB  -set_scale 0.001 0.001 0.001 -set_version 1.4 -o output.laz`
 
 
+ ### To Do
+ - Supports logarithmic depth buffer (just by enabling it on the threejs renderer), useful for large scale visualization.
+ - Point clouds are automatically updated, frustum culling is used to avoid unnecessary updates (better update performance for multiple point clouds).