potree-core 1.0.7 → 2.0.0

package/dist/point-cloud-octree-geometry-node.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Adapted from Potree.js http://potree.org
+ * Potree License: https://github.com/potree/potree/blob/1.5/LICENSE
+ */
+import { Box3, BufferGeometry, EventDispatcher, Sphere, Vector3 } from 'three';
+import { PointCloudOctreeGeometry } from './point-cloud-octree-geometry';
+import { IPointCloudTreeNode } from './types';
+export interface NodeData {
+    children: number;
+    numPoints: number;
+    name: string;
+}
+export declare class PointCloudOctreeGeometryNode extends EventDispatcher implements IPointCloudTreeNode {
+    id: number;
+    name: string;
+    pcoGeometry: PointCloudOctreeGeometry;
+    index: number;
+    level: number;
+    spacing: number;
+    hasChildren: boolean;
+    readonly children: ReadonlyArray<PointCloudOctreeGeometryNode | null>;
+    boundingBox: Box3;
+    tightBoundingBox: Box3;
+    boundingSphere: Sphere;
+    mean: Vector3;
+    numPoints: number;
+    geometry: BufferGeometry | undefined;
+    loaded: boolean;
+    loading: boolean;
+    failed: boolean;
+    parent: PointCloudOctreeGeometryNode | null;
+    oneTimeDisposeHandlers: (() => void)[];
+    isLeafNode: boolean;
+    readonly isTreeNode: boolean;
+    readonly isGeometryNode: boolean;
+    private static idCount;
+    constructor(name: string, pcoGeometry: PointCloudOctreeGeometry, boundingBox: Box3);
+    dispose(): void;
+    /**
+   * Gets the url of the binary file for this node.
+   */
+    getUrl(): string;
+    /**
+   * Gets the url of the hierarchy file for this node.
+   */
+    getHierarchyUrl(): string;
+    /**
+   * Adds the specified node as a child of the current node.
+   *
+   * @param child
+   *    The node which is to be added as a child.
+   */
+    addChild(child: PointCloudOctreeGeometryNode): void;
+    /**
+   * Calls the specified callback for the current node (if includeSelf is set to true) and all its
+   * children.
+   *
+   * @param cb
+   *    The function which is to be called for each node.
+   */
+    traverse(cb: (node: PointCloudOctreeGeometryNode) => void, includeSelf?: boolean): void;
+    load(): Promise<void>;
+    private canLoad;
+    private loadPoints;
+    private loadHierachyThenPoints;
+    /**
+   * Gets the url of the folder where the hierarchy is, relative to the octreeDir.
+   */
+    private getHierarchyBaseUrl;
+    private loadHierarchy;
+    private getNodeData;
+    addNode({ name, numPoints, children }: NodeData, pco: PointCloudOctreeGeometry, nodes: Map<string, PointCloudOctreeGeometryNode>): void;
+}

package/dist/point-cloud-octree-geometry.d.ts

@@ -0,0 +1,27 @@
+import { Box3, Vector3 } from 'three';
+import { BinaryLoader, XhrRequest } from './loading';
+import { PointAttributes } from './point-attributes';
+import { PointCloudOctreeGeometryNode } from './point-cloud-octree-geometry-node';
+export declare class PointCloudOctreeGeometry {
+    loader: BinaryLoader;
+    boundingBox: Box3;
+    tightBoundingBox: Box3;
+    offset: Vector3;
+    xhrRequest: XhrRequest;
+    disposed: boolean;
+    needsUpdate: boolean;
+    root: PointCloudOctreeGeometryNode;
+    octreeDir: string;
+    hierarchyStepSize: number;
+    nodes: Record<string, PointCloudOctreeGeometryNode>;
+    numNodesLoading: number;
+    maxNumNodesLoading: number;
+    spacing: number;
+    pointAttributes: PointAttributes;
+    projection: any;
+    url: string | null;
+    constructor(loader: BinaryLoader, boundingBox: Box3, tightBoundingBox: Box3, offset: Vector3, xhrRequest: XhrRequest);
+    dispose(): void;
+    addNodeLoadedCallback(callback: (node: PointCloudOctreeGeometryNode) => void): void;
+    clearNodeLoadedCallbacks(): void;
+}

package/dist/point-cloud-octree-node.d.ts

@@ -0,0 +1,26 @@
+import { Box3, EventDispatcher, Object3D, Points, Sphere } from 'three';
+import { PointCloudOctreeGeometryNode } from './point-cloud-octree-geometry-node';
+import { IPointCloudTreeNode } from './types';
+export declare class PointCloudOctreeNode extends EventDispatcher implements IPointCloudTreeNode {
+    geometryNode: PointCloudOctreeGeometryNode;
+    sceneNode: Points;
+    pcIndex: number | undefined;
+    boundingBoxNode: Object3D | null;
+    readonly children: (IPointCloudTreeNode | null)[];
+    readonly loaded = true;
+    readonly isTreeNode: boolean;
+    readonly isGeometryNode: boolean;
+    constructor(geometryNode: PointCloudOctreeGeometryNode, sceneNode: Points);
+    dispose(): void;
+    disposeSceneNode(): void;
+    traverse(cb: (node: IPointCloudTreeNode) => void, includeSelf?: boolean): void;
+    get id(): number;
+    get name(): string;
+    get level(): number;
+    get isLeafNode(): boolean;
+    get numPoints(): number;
+    get index(): number;
+    get boundingSphere(): Sphere;
+    get boundingBox(): Box3;
+    get spacing(): number;
+}

package/dist/point-cloud-octree-picker.d.ts

@@ -0,0 +1,45 @@
+import { Camera, Ray, Vector3, WebGLRenderer, WebGLRenderTarget } from 'three';
+import { PointCloudMaterial } from './materials';
+import { PointCloudOctree } from './point-cloud-octree';
+import { PickPoint } from './types';
+export interface PickParams {
+    pickWindowSize: number;
+    pickOutsideClipRegion: boolean;
+    /**
+     * If provided, the picking will use this pixel position instead of the `Ray` passed to the `pick`
+     * method.
+     */
+    pixelPosition: Vector3;
+    /**
+     * Function which gets called after a picking material has been created and setup and before the
+     * point cloud is rendered into the picking render target. This gives applications a chance to
+     * customize the renderTarget and the material.
+     *
+     * @param material
+     *    The pick material.
+     * @param renterTarget
+     *    The render target used for picking.
+     */
+    onBeforePickRender: (material: PointCloudMaterial, renterTarget: WebGLRenderTarget) => void;
+}
+export declare class PointCloudOctreePicker {
+    private static readonly helperVec3;
+    private static readonly helperSphere;
+    private static readonly clearColor;
+    private pickState;
+    dispose(): void;
+    pick(renderer: WebGLRenderer, camera: Camera, ray: Ray, octrees: PointCloudOctree[], params?: Partial<PickParams>): PickPoint | null;
+    private static prepareRender;
+    private static render;
+    private static nodesOnRay;
+    private static readPixels;
+    private static createTempNodes;
+    private static updatePickMaterial;
+    private static updatePickRenderTarget;
+    private static makePickRenderTarget;
+    private static findHit;
+    private static getPickPoint;
+    private static addPositionToPickPoint;
+    private static addNormalToPickPoint;
+    private static getPickState;
+}

package/dist/point-cloud-octree.d.ts

@@ -0,0 +1,45 @@
+import { Box3, Camera, Object3D, Ray, Sphere, WebGLRenderer } from 'three';
+import { PointCloudMaterial, PointSizeType } from './materials';
+import { PointCloudOctreeGeometryNode } from './point-cloud-octree-geometry-node';
+import { PointCloudOctreeNode } from './point-cloud-octree-node';
+import { PickParams } from './point-cloud-octree-picker';
+import { PointCloudTree } from './point-cloud-tree';
+import { IPointCloudTreeNode, IPotree, PickPoint, PCOGeometry } from './types';
+export declare class PointCloudOctree extends PointCloudTree {
+    potree: IPotree;
+    disposed: boolean;
+    pcoGeometry: PCOGeometry;
+    boundingBox: Box3;
+    boundingSphere: Sphere;
+    material: PointCloudMaterial;
+    level: number;
+    maxLevel: number;
+    /**
+   * The minimum radius of a node's bounding sphere on the screen in order to be displayed.
+   */
+    minNodePixelSize: number;
+    root: IPointCloudTreeNode | null;
+    boundingBoxNodes: Object3D[];
+    visibleNodes: PointCloudOctreeNode[];
+    visibleGeometry: PointCloudOctreeGeometryNode[];
+    numVisiblePoints: number;
+    showBoundingBox: boolean;
+    private visibleBounds;
+    private picker;
+    constructor(potree: IPotree, pcoGeometry: PCOGeometry, material?: PointCloudMaterial);
+    private initMaterial;
+    dispose(): void;
+    get pointSizeType(): PointSizeType;
+    set pointSizeType(value: PointSizeType);
+    toTreeNode(geometryNode: PointCloudOctreeGeometryNode, parent?: PointCloudOctreeNode | null): PointCloudOctreeNode;
+    updateVisibleBounds(): void;
+    updateBoundingBoxes(): void;
+    updateMatrixWorld(force: boolean): void;
+    hideDescendants(object: Object3D): void;
+    moveToOrigin(): void;
+    moveToGroundPlane(): void;
+    getBoundingBoxWorld(): Box3;
+    getVisibleExtent(): Box3;
+    pick(renderer: WebGLRenderer, camera: Camera, ray: Ray, params?: Partial<PickParams>): PickPoint | null;
+    get progress(): number;
+}

package/dist/point-cloud-tree.d.ts

@@ -0,0 +1,6 @@
+import { Object3D } from 'three';
+import { IPointCloudTreeNode } from './types';
+export declare class PointCloudTree extends Object3D {
+    root: IPointCloudTreeNode | null;
+    initialized(): boolean;
+}

package/dist/potree.d.ts

@@ -0,0 +1,37 @@
+import { Camera, Ray, WebGLRenderer } from 'three';
+import { GetUrlFn } from './loading';
+import { PointCloudOctree } from './point-cloud-octree';
+import { PickParams } from './point-cloud-octree-picker';
+import { IPointCloudTreeNode, IPotree, IVisibilityUpdateResult, PickPoint } from './types';
+import { LRU } from './utils/lru';
+export declare class QueueItem {
+    pointCloudIndex: number;
+    weight: number;
+    node: IPointCloudTreeNode;
+    parent?: IPointCloudTreeNode | null;
+    constructor(pointCloudIndex: number, weight: number, node: IPointCloudTreeNode, parent?: IPointCloudTreeNode | null);
+}
+export declare class Potree implements IPotree {
+    private static picker;
+    private _pointBudget;
+    private _rendererSize;
+    maxNumNodesLoading: number;
+    features: {
+        SHADER_INTERPOLATION: boolean;
+        SHADER_SPLATS: boolean;
+        SHADER_EDL: boolean;
+        precision: string;
+    };
+    lru: LRU;
+    loadPointCloud(url: string, getUrl: GetUrlFn, xhrRequest?: (input: RequestInfo, init?: RequestInit) => Promise<Response>): Promise<PointCloudOctree>;
+    updatePointClouds(pointClouds: PointCloudOctree[], camera: Camera, renderer: WebGLRenderer): IVisibilityUpdateResult;
+    static pick(pointClouds: PointCloudOctree[], renderer: WebGLRenderer, camera: Camera, ray: Ray, params?: Partial<PickParams>): PickPoint | null;
+    get pointBudget(): number;
+    set pointBudget(value: number);
+    private updateVisibility;
+    private updateTreeNodeVisibility;
+    private updateChildVisibility;
+    private updateBoundingBoxVisibility;
+    private shouldClip;
+    private updateVisibilityStructures;
+}

package/dist/type-predicates.d.ts

@@ -0,0 +1,3 @@
+import { PointCloudOctreeGeometryNode } from './point-cloud-octree-geometry-node';
+export declare function isGeometryNode(node?: any): node is PointCloudOctreeGeometryNode;
+export declare function isTreeNode(node?: any): any;

package/dist/types.d.ts

@@ -0,0 +1,56 @@
+import { OctreeGeometry } from './loading2/OctreeGeometry';
+import { PointCloudOctreeGeometry } from './point-cloud-octree-geometry';
+import { Box3, Camera, Sphere, Vector3, WebGLRenderer } from 'three';
+import { GetUrlFn, XhrRequest } from './loading/types';
+import { PointCloudOctree } from './point-cloud-octree';
+import { LRU } from './utils/lru';
+export interface IPointCloudTreeNode {
+    id: number;
+    name: string;
+    level: number;
+    index: number;
+    spacing: number;
+    boundingBox: Box3;
+    boundingSphere: Sphere;
+    loaded: boolean;
+    numPoints: number;
+    readonly children: ReadonlyArray<IPointCloudTreeNode | null>;
+    readonly isLeafNode: boolean;
+    dispose(): void;
+    traverse(cb: (node: IPointCloudTreeNode) => void, includeSelf?: boolean): void;
+}
+export interface IVisibilityUpdateResult {
+    visibleNodes: IPointCloudTreeNode[];
+    numVisiblePoints: number;
+    /**
+     * True when a node has been loaded but was not added to the scene yet.
+     * Make sure to call updatePointClouds() again on the next frame.
+     */
+    exceededMaxLoadsToGPU: boolean;
+    /**
+     * True when at least one node in view has failed to load.
+     */
+    nodeLoadFailed: boolean;
+    /**
+     * Promises for loading nodes, will reject when loading fails.
+     */
+    nodeLoadPromises: Promise<void>[];
+}
+export interface IPotree {
+    pointBudget: number;
+    maxNumNodesLoading: number;
+    lru: LRU;
+    loadPointCloud(url: string, getUrl: GetUrlFn, xhrRequest?: XhrRequest): Promise<PointCloudOctree>;
+    updatePointClouds(pointClouds: PointCloudOctree[], camera: Camera, renderer: WebGLRenderer): IVisibilityUpdateResult;
+}
+export interface PickPoint {
+    position?: Vector3;
+    normal?: Vector3;
+    pointCloud?: PointCloudOctree;
+    [property: string]: any;
+}
+export interface PointCloudHit {
+    pIndex: number;
+    pcIndex: number;
+}
+export type PCOGeometry = PointCloudOctreeGeometry | OctreeGeometry;

package/dist/utils/bounds.d.ts

@@ -0,0 +1,6 @@
+import { Box3, Matrix4 } from 'three';
+/**
+ * adapted from mhluska at https://github.com/mrdoob/three.js/issues/1561
+ */
+export declare function computeTransformedBoundingBox(box: Box3, transform: Matrix4): Box3;
+export declare function createChildAABB(aabb: Box3, index: number): Box3;

package/dist/utils/box3-helper.d.ts

@@ -0,0 +1,13 @@
+import { Box3, Color, LineSegments } from 'three';
+/**
+ *
+ * code adapted from three.js BoxHelper.js
+ * https://github.com/mrdoob/three.js/blob/dev/src/helpers/BoxHelper.js
+ *
+ * @author mrdoob / http://mrdoob.com/
+ * @author Mugen87 / http://github.com/Mugen87
+ * @author mschuetz / http://potree.org
+ */
+export declare class Box3Helper extends LineSegments {
+    constructor(box: Box3, color?: Color);
+}

package/dist/utils/lru.d.ts

@@ -0,0 +1,32 @@
+import { IPointCloudTreeNode } from '../types';
+export type Node = IPointCloudTreeNode;
+export declare class LRUItem {
+    node: Node;
+    next: LRUItem | null;
+    previous: LRUItem | null;
+    constructor(node: Node);
+}
+/**
+ * A doubly-linked-list of the least recently used elements.
+ */
+export declare class LRU {
+    pointBudget: number;
+    first: LRUItem | null;
+    last: LRUItem | null;
+    numPoints: number;
+    private items;
+    constructor(pointBudget?: number);
+    get size(): number;
+    has(node: Node): boolean;
+    /**
+   * Makes the specified the most recently used item. if the list does not contain node, it will
+   * be added.
+   */
+    touch(node: Node): void;
+    private addNew;
+    private touchExisting;
+    remove(node: Node): void;
+    getLRUItem(): Node | undefined;
+    freeMemory(): void;
+    disposeSubtree(node: Node): void;
+}

package/dist/utils/math.d.ts

@@ -0,0 +1 @@
+export declare function clamp(value: number, min: number, max: number): number;

package/dist/utils/utils.d.ts

@@ -0,0 +1,6 @@
+import { IPointCloudTreeNode } from '../types';
+export declare function getIndexFromName(name: string): number;
+/**
+ * When passed to `[].sort`, sorts the array by level and index: r, r0, r3, r4, r01, r07, r30, ...
+ */
+export declare function byLevelAndIndex(a: IPointCloudTreeNode, b: IPointCloudTreeNode): number;

package/dist/version.d.ts

@@ -0,0 +1,9 @@
+export declare class Version {
+    version: string;
+    versionMajor: number;
+    versionMinor: number;
+    constructor(version: string);
+    newerThan(version: string): boolean;
+    equalOrHigher(version: string): boolean;
+    upTo(version: string): boolean;
+}

package/dist/workers/binary-decoder-worker-internal.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Adapted from Potree.js http://potree.org
+ * Potree License: https://github.com/potree/potree/blob/1.5/LICENSE
+ */
+export declare function handleMessage(event: MessageEvent): void;

package/dist/workers/custom-array-view.d.ts

@@ -0,0 +1,11 @@
+export declare class CustomArrayView {
+    private u8;
+    private tmp;
+    private tmpf;
+    private tmpu8;
+    constructor(buffer: ArrayBuffer);
+    getUint32(i: number): number;
+    getUint16(i: number): number;
+    getFloat32(i: number): number;
+    getUint8(i: number): number;
+}

package/package.json

@@ -1,18 +1,21 @@
 {
 	"name": "potree-core",
-	"version": "1.0.7",
-	"description": "Potree wrapper for threejs applications",
-	"main": "build/potree.module.js",
+	"version": "2.0.0",
+	"description": "Potree wrapper for three.js applications",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/tentone/potree-core.git"
 	},
+	"files": ["dist"],
+	"type": "module",
 	"scripts": {
-		"dev": "http-server .",
-		"build": "rollup -c && npm run closure",
+		"dev": "webpack --mode development --watch --progress --stats-children",
+		"build": "webpack --mode production --config webpack.prod.js",
+		"start": "npm run build && webpack-dev-server --config webpack.example.js --mode development --progress --port 5200",
 		"docs": "jsdoc -d docs source",
-		"closure": "java -jar node_modules/google-closure-compiler-java/compiler.jar --compilation_level SIMPLE --warning_level QUIET --formatting SINGLE_QUOTES --language_in ECMASCRIPT_2017 --language_out ECMASCRIPT_2017 --js build/potree.js --js_output_file build/potree.min.js",
-		"pub": "npm run build && npm publish --access public ."
+		"pub": "npm run build && npm publish --access public .",
+		"lint": "eslint --ext .js source",
+		"lint-fix": "eslint --ext .js --fix source"
 	},
 	"keywords": [
 		"three",
@@ -22,12 +25,30 @@
 	],
 	"author": "Tentone",
 	"license": "MIT",
-	"dependencies": {},
+	"peerDependencies": {
+		"three": "^0.120.0"
+	},
 	"devDependencies": {
-		"http-server": "0.11.1",
-		"google-closure-compiler": "^20190301.0.0",
-		"jsdoc": "^3.5.0",
-		"rollup": "^1.0.0",
-		"rollup-plugin-strip": "^1.2.1"
+		"@typescript-eslint/eslint-plugin": "5.48.1",
+		"@typescript-eslint/parser": "5.48.1",
+		"@types/node": "18.11.18",
+		"@types/three": "^0.148.0",
+		"css-loader": "6.7.3",
+		"html-loader": "4.2.0",
+		"html-webpack-plugin": "5.5.0",
+		"raw-loader": "4.0.2",
+		"style-loader": "3.3.1",
+		"three": "^0.148.0",
+		"ts-loader": "9.4.2",
+		"eslint": "8.30.0",
+		"eslint-plugin-import": "2.26.0",
+		"eslint-plugin-tsdoc": "0.2.17",
+		"eslint-plugin-typescript": "0.14.0",
+		"typescript": "4.9.4",
+		"webpack": "5.75.0",
+		"webpack-bundle-analyzer": "4.7.0",
+		"webpack-cli": "5.0.1",
+		"webpack-dev-server": "4.11.1",
+		"worker-loader": "3.0.8"
 	}
 }