bimatter-viewer-react 0.0.1

package/README.md

@@ -0,0 +1,73 @@
+# React + TypeScript + Vite
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Oxc](https://oxc.rs)
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/)
+
+## React Compiler
+
+The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
+
+## Expanding the ESLint configuration
+
+If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
+
+```js
+export default defineConfig([
+  globalIgnores(['dist']),
+  {
+    files: ['**/*.{ts,tsx}'],
+    extends: [
+      // Other configs...
+
+      // Remove tseslint.configs.recommended and replace with this
+      tseslint.configs.recommendedTypeChecked,
+      // Alternatively, use this for stricter rules
+      tseslint.configs.strictTypeChecked,
+      // Optionally, add this for stylistic rules
+      tseslint.configs.stylisticTypeChecked,
+
+      // Other configs...
+    ],
+    languageOptions: {
+      parserOptions: {
+        project: ['./tsconfig.node.json', './tsconfig.app.json'],
+        tsconfigRootDir: import.meta.dirname,
+      },
+      // other options...
+    },
+  },
+])
+```
+
+You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
+
+```js
+// eslint.config.js
+import reactX from 'eslint-plugin-react-x'
+import reactDom from 'eslint-plugin-react-dom'
+
+export default defineConfig([
+  globalIgnores(['dist']),
+  {
+    files: ['**/*.{ts,tsx}'],
+    extends: [
+      // Other configs...
+      // Enable lint rules for React
+      reactX.configs['recommended-typescript'],
+      // Enable lint rules for React DOM
+      reactDom.configs.recommended,
+    ],
+    languageOptions: {
+      parserOptions: {
+        project: ['./tsconfig.node.json', './tsconfig.app.json'],
+        tsconfigRootDir: import.meta.dirname,
+      },
+      // other options...
+    },
+  },
+])
+```

package/lib/Camera/useCameraFit.d.ts

@@ -0,0 +1,2 @@
+import type { ViewerControlsRef, ViewerLightRef, ViewerModelRef } from "../types";
+export default function useFitCamera(): (ref: ViewerModelRef, controlRef: ViewerControlsRef, lightRef: ViewerLightRef) => void;

package/lib/GeometryUtils/useGeometryIndex.d.ts

@@ -0,0 +1,35 @@
+import { Mesh } from "three";
+import type { MeshBVH } from "three-mesh-bvh";
+import type { ViewerModelRef } from "../types";
+export type IndexArray = Uint16Array | Uint32Array;
+export type IndexRange = {
+    count: number;
+    start: number;
+};
+export type MeshGeometryRecord = {
+    hiddenIds: Set<number>;
+    initialVisible: boolean;
+    mesh: Mesh;
+    modelID: number;
+    originalBoundsTree: MeshBVH | null;
+    originalIndex: IndexArray;
+    visibleStateKey: string;
+    triangleRanges: Array<IndexRange & {
+        id: number;
+    }>;
+};
+export type ElementIndexEntry = {
+    record: MeshGeometryRecord;
+    vertexRanges: IndexRange[];
+};
+export type GeometryIndex = {
+    elementIndex: Map<number, ElementIndexEntry[]>;
+    indexedModel: unknown;
+    isolatedIdsByModel: Map<number, Set<number>> | null;
+    isolatedIds: Set<number> | null;
+    records: Set<MeshGeometryRecord>;
+};
+export type GeometryIndexApi = {
+    buildIndex: () => GeometryIndex;
+};
+export default function useGeometryIndex(modelRef: ViewerModelRef): GeometryIndexApi;

package/lib/GeometryUtils/useGeometryUtils.d.ts

@@ -0,0 +1,13 @@
+import type { GeometryIndexApi } from "./useGeometryIndex";
+export type GeometryUtilsApi = {
+    buildIndex: GeometryIndexApi["buildIndex"];
+    getAllIds: () => number[];
+    hideByIds: (ids: number[]) => void;
+    hideSelected: () => void;
+    isolateByIds: (ids: number[]) => void;
+    isolateSelected: () => void;
+    resetIsolation: () => void;
+    showAll: () => void;
+    showByIds: (ids: number[]) => void;
+};
+export default function useGeometryUtils(geometryIndex: GeometryIndexApi): GeometryUtilsApi;

package/lib/Hotkeys/useHotkeysUtils.d.ts

@@ -0,0 +1,2 @@
+import type { GeometryUtilsApi } from "../GeometryUtils/useGeometryUtils";
+export default function useHotkeys(geometryUtils: GeometryUtilsApi): void;

package/lib/Loaders/BmtLoader.d.ts

@@ -0,0 +1,51 @@
+import pako from "pako";
+export type BmtIndexArray = Uint16Array | Uint32Array;
+export interface BmtMaterialData {
+    r: number;
+    g: number;
+    b: number;
+    opacity: number;
+    name: number;
+}
+export interface BmtGeomData {
+    pos: Float32Array;
+    ind: BmtIndexArray;
+    ids: Uint32Array;
+    matrix: string;
+    mat: BmtMaterialData;
+}
+export type BmtModelData = Record<number, BmtGeomData>;
+type BmtMeshData = {
+    colorId: BmtMaterialData;
+    ids: Uint8Array;
+    ind: {
+        data: Uint8Array;
+        type: number;
+    };
+    pos: Uint8Array;
+};
+export declare class BinaryReader {
+    view: DataView;
+    offset: number;
+    constructor(buffer: ArrayBuffer);
+    readUint8(): number;
+    readUint32(): number;
+    readBytes(length: number): Uint8Array<ArrayBufferLike>;
+    eof(): boolean;
+}
+export declare class BMTLoader {
+    decodeBuffer(buffer: Uint8Array): string;
+    decoder: typeof pako;
+    textDecoder: TextDecoder;
+    ChunkType: {
+        PROP: number;
+        MESH: number;
+        STRUCTURE: number;
+        GRIDS: number;
+        MATRIX: number;
+    };
+    parseMesh(data: Uint8Array): BmtMeshData;
+    loadModel(path: string): Promise<BmtModelData>;
+    parseBinaryFile(data: ArrayBuffer): BmtModelData;
+}
+export {};

package/lib/Model.d.ts

@@ -0,0 +1,7 @@
+import type { BmtModelData } from "./Loaders/BmtLoader";
+type ModelProps = {
+    modelID: number;
+    data: BmtModelData;
+};
+declare function Model({ modelID, data }: ModelProps): import("react/jsx-runtime").JSX.Element;
+export default Model;

package/lib/SelectableMesh.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+import { Matrix4 } from "three";
+import type { BmtGeomData, BmtMaterialData } from "./Loaders/BmtLoader";
+type SelectableMeshProps = {
+    data: BmtGeomData;
+    material: BmtMaterialData;
+    meshMatrix: Matrix4;
+};
+export declare const SelectableMesh: React.MemoExoticComponent<({ material, data, meshMatrix, }: SelectableMeshProps) => import("react/jsx-runtime").JSX.Element>;
+export {};

package/lib/Selector/SelectionBox.d.ts

@@ -0,0 +1,50 @@
+import type { MutableRefObject } from "react";
+import { Camera, Object3D, Vector2 } from "three";
+export type ClientRectSelection = {
+    minX: number;
+    minY: number;
+    maxX: number;
+    maxY: number;
+};
+export type SelectionBoxMode = "contains" | "intersects";
+export type SelectionBoxProfile = {
+    boundsCheckMs: number;
+    candidateIds: number;
+    containedCandidateVertices: number;
+    containedIdsMs: number;
+    containedVerticesVisited: number;
+    intersectsBoundsCalls: number;
+    intersectsBoundsMs: number;
+    intersectsRangeCalls: number;
+    intersectsRangeMs: number;
+    intersectsTriangleCalls: number;
+    intersectsTriangleMs: number;
+    matrixUpdateMs: number;
+    meshCount: number;
+    mode: SelectionBoxMode;
+    selectedIds: number;
+    shapecastMs: number;
+    skippedMeshCount: number;
+    totalMs: number;
+    trianglePointCalls: number;
+    trianglePointMs: number;
+    trianglePointVertices: number;
+    triangleProjectionMs: number;
+};
+export declare const MIN_BOX_SIZE = 6;
+export declare function getClientSelectionRect(start: Vector2, end: Vector2): ClientRectSelection;
+export declare function getSelectionBoxMode(start: Vector2, end: Vector2): SelectionBoxMode;
+export declare function getBoxSelectedIds({ model, camera, domElement, rect, mode, profile, }: {
+    model: Object3D | null;
+    camera: Camera;
+    domElement: HTMLElement;
+    rect: ClientRectSelection;
+    mode: SelectionBoxMode;
+    profile?: SelectionBoxProfile;
+}): Map<number, Set<number>>;
+export declare function getBoxSelectedIdsProfiled(options: Parameters<typeof getBoxSelectedIds>[0]): {
+    ids: Map<number, Set<number>>;
+    profile: SelectionBoxProfile;
+};
+export declare function updateSelectionBoxElement(elementRef: MutableRefObject<HTMLDivElement | null>, start: Vector2, end: Vector2): void;
+export declare function removeSelectionBoxElement(elementRef: MutableRefObject<HTMLDivElement | null>): void;

package/lib/Selector/useSelector.d.ts

@@ -0,0 +1,3 @@
+import type { GeometryIndexApi } from "../GeometryUtils/useGeometryIndex";
+import type { ViewerControlsRef, ViewerModelRef } from "../types";
+export default function useSelector(modelRef: ViewerModelRef, controlRef: ViewerControlsRef, geometryIndex: GeometryIndexApi): void;

package/lib/Viewer.d.ts

@@ -0,0 +1,21 @@
+import { type ComponentProps } from "react";
+import type { BmtModelData } from "./Loaders/BmtLoader";
+import { Canvas } from "@react-three/fiber";
+import { type ViewerApi, type ViewerSelection } from "./api/ViewerApi";
+import { type ViewerModelSource } from "./api/loader";
+type ModelsData = Record<number, BmtModelData>;
+export type ViewerModelsData = ModelsData;
+export type ViewerProps = {
+    camera?: ComponentProps<typeof Canvas>["camera"];
+    dpr?: ComponentProps<typeof Canvas>["dpr"];
+    defaultSelected?: ViewerSelection;
+    modelUrls?: string[];
+    modelSources?: ViewerModelSource[];
+    modelsData?: ModelsData;
+    onReady?: (api: ViewerApi) => void;
+    onSelectedChange?: (selected: ViewerSelection) => void;
+    selected?: ViewerSelection;
+    showStats?: boolean;
+};
+declare const Viewer: import("react").ForwardRefExoticComponent<ViewerProps & import("react").RefAttributes<ViewerApi>>;
+export default Viewer;

package/lib/api/ViewerApi.d.ts

@@ -0,0 +1,40 @@
+import type { SelectedStore, UserDevice, ViewerStoreApi } from "../store/ViewerStore";
+export type ViewerSelection = Record<number, number[]>;
+export type ViewerGeometryUtilsApi = {
+    getAllIds: () => number[];
+    hideByIds: (ids: number[]) => void;
+    hideSelected: () => void;
+    isolateByIds: (ids: number[]) => void;
+    isolateSelected: () => void;
+    resetIsolation: () => void;
+    showAll: () => void;
+    showByIds: (ids: number[]) => void;
+};
+export type ViewerSelectorApi = {
+    addSelected: (modelID: number, ids: number[]) => void;
+    getSelected: () => ViewerSelection;
+    removeSelected: (modelID: number, ids: number[]) => void;
+    resetSelection: (modelID?: number) => void;
+    setSelected: (modelID: number, ids: number[], reset?: boolean) => void;
+};
+export type ViewerUtilsApi = {
+    getShowStats: () => boolean;
+    getUserDevice: () => UserDevice;
+    setShowStats: (showStats: boolean) => void;
+};
+export type ViewerCameraApi = {
+    fitCamera: () => void;
+};
+export type ViewerApi = {
+    camera: ViewerCameraApi;
+    geometryUtils: ViewerGeometryUtilsApi;
+    selector: ViewerSelectorApi;
+    utils: ViewerUtilsApi;
+};
+export type ViewerSceneApi = {
+    camera: ViewerCameraApi;
+    geometryUtils: ViewerGeometryUtilsApi;
+};
+export declare function serializeSelected(selected: SelectedStore): ViewerSelection;
+export declare function createSelectedStore(selection: ViewerSelection): SelectedStore;
+export declare function createPublicViewerApi(viewerStore: ViewerStoreApi, getSceneApi: () => ViewerSceneApi | null): ViewerApi;

package/lib/api/loader.d.ts

@@ -0,0 +1,8 @@
+import { type BmtModelData } from "../Loaders/BmtLoader";
+export type ViewerModelSource = string | File;
+export type ViewerLoadedModels = Record<number, BmtModelData>;
+declare function loadModel(sources: ViewerModelSource[]): Promise<ViewerLoadedModels>;
+export declare const loader: {
+    loadModel: typeof loadModel;
+};
+export {};

package/lib/index.d.ts

@@ -0,0 +1,11 @@
+export { default as Viewer } from "./Viewer";
+export type { ViewerModelsData, ViewerProps } from "./Viewer";
+export type { ViewerApi, ViewerCameraApi, ViewerGeometryUtilsApi, ViewerSelection, ViewerSelectorApi, ViewerUtilsApi, } from "./api/ViewerApi";
+export { BMTLoader } from "./Loaders/BmtLoader";
+export type { BmtGeomData, BmtIndexArray, BmtMaterialData, BmtModelData, } from "./Loaders/BmtLoader";
+export { loader } from "./api/loader";
+export type { ViewerLoadedModels, ViewerModelSource } from "./api/loader";
+export { createViewerStore, } from "./store/ViewerStore";
+export { ViewerStoreProvider } from "./store/ViewerStoreProvider";
+export { useViewerStore, useViewerStoreApi, } from "./store/useViewerStore";
+export type { SelectedStore, UserDevice, ViewerStore, ViewerStoreApi, } from "./store/ViewerStore";