potree-core 2.0.11 → 2.0.13

package/README.md

@@ -61,6 +61,51 @@ function loop()
 loop();
 ```
 
+## Clip Boxes
+ - Clip boxes restrict the rendered region of a point cloud to a box-shaped volume.
+ - Use the `createClipBox(size, position)` helper to build an `IClipBox` from a size and world-space position.
+ - Set the desired `ClipMode` on the material and pass the clip boxes to `setClipBoxes()`.
+
+```javascript
+import { ClipMode, createClipBox } from 'potree-core';
+import { Vector3 } from 'three';
+
+// Create a 5×5×5 clip box centered at world position (2, 0, 0)
+const clipBox = createClipBox(new Vector3(5, 5, 5), new Vector3(2, 0, 0));
+
+// Highlight points inside the box (other modes: CLIP_OUTSIDE, CLIP_INSIDE, DISABLED)
+pco.material.clipMode = ClipMode.HIGHLIGHT_INSIDE;
+pco.material.setClipBoxes([clipBox]);
+```
+
+ - `ClipMode.DISABLED` – no clipping.
+ - `ClipMode.CLIP_OUTSIDE` – only points inside the box are rendered.
+ - `ClipMode.CLIP_INSIDE` – only points outside the box are rendered.
+ - `ClipMode.HIGHLIGHT_INSIDE` – all points rendered; points inside the box are highlighted.
+
+## Clip Spheres
+ - Clip spheres restrict the rendered region of a point cloud to a sphere-shaped volume.
+ - Use the `createClipSphere(center, radius)` helper to build an `IClipSphere` from a center position and radius.
+ - Set the desired `ClipMode` on the material and pass the clip spheres to `setClipSpheres()`.
+ - Clip boxes and clip spheres can be used together; a point is considered "inside" if it falls inside any box or any sphere.
+
+```javascript
+import { ClipMode, createClipSphere } from 'potree-core';
+import { Vector3 } from 'three';
+
+// Create a sphere of radius 3 centered at world position (0, 1, 0)
+const clipSphere = createClipSphere(new Vector3(0, 1, 0), 3);
+
+// Highlight points inside the sphere (other modes: CLIP_OUTSIDE, CLIP_INSIDE, DISABLED)
+pco.material.clipMode = ClipMode.HIGHLIGHT_INSIDE;
+pco.material.setClipSpheres([clipSphere]);
+```
+
+ - `ClipMode.DISABLED` – no clipping.
+ - `ClipMode.CLIP_OUTSIDE` – only points inside the sphere are rendered.
+ - `ClipMode.CLIP_INSIDE` – only points outside the sphere are rendered.
+ - `ClipMode.HIGHLIGHT_INSIDE` – all points rendered; points inside the sphere are highlighted.
+
 ## Custom Request Manager
    - The potree core library uses a custom request manager to handle the loading of point cloud data.
    - The request manager can be replaced by a custom implementation, for example to use a custom caching system or to handle requests in a different way.
@@ -81,7 +126,6 @@ loop();
 ## 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.
- - Removed classification and clipping functionality.
  - Removed Arena 4D point cloud support.
  - Removed Entwine Point Tile file support.
  - GUI elements were removed from the library

package/dist/constants.d.ts

@@ -10,5 +10,6 @@ export declare const DEFAULT_POINT_BUDGET = 1000000;
 export declare const MAX_LOADS_TO_GPU = 2;
 export declare const MAX_NUM_NODES_LOADING = 4;
 export declare const PERSPECTIVE_CAMERA = "PerspectiveCamera";
+export declare const ORTHOGRAPHIC_CAMERA = "OrthographicCamera";
 export declare const COLOR_BLACK: Color;
 export declare const DEFAULT_HIGHLIGHT_COLOR: Vector4;

package/dist/index.d.ts

@@ -7,5 +7,7 @@ export * from './point-cloud-octree-picker';
 export * from './point-cloud-octree';
 export * from './point-cloud-tree';
 export * from './potree';
+export * from './rendering/edl-pass';
+export * from './rendering/potree-renderer';
 export * from './types';
 export * from './version';