@yschindel/ara3d-webgl 1.3.10 → 1.3.14

package/dist/types/index.d.ts

@@ -5,4 +5,3 @@ export { DefaultInputScheme, KEYS } from './viewer/inputs/input';
 export * from './viewer/viewerSettings';
 export * from './loader/gltfLoader';
 export * from './loader/bimOpenSchemaLoader';
-export { BimGhostController } from './loader/bimGhostController';

package/dist/types/loader/BimParameterDescriptors.d.ts

@@ -0,0 +1,7 @@
+import { StringIndex } from './bimData';
+export interface BimParameterDescriptors {
+    Name: Array<StringIndex>;
+    Units: Array<StringIndex>;
+    Group: Array<StringIndex>;
+    Type: Array<number>;
+}

package/dist/types/loader/BimParameterTable.d.ts

@@ -0,0 +1,6 @@
+import { EntityIndex, DescriptorIndex } from './bimData';
+export interface BimParameterTable {
+    Entity: Array<EntityIndex>;
+    Descriptor: Array<DescriptorIndex>;
+    Value: Array<number>;
+}

package/dist/types/loader/bimData.d.ts

@@ -0,0 +1,39 @@
+import * as THREE from 'three';
+import { BimGeometry } from './bimGeometry';
+import { Instance } from './buildInstances';
+import { BimResolver } from './bimResolver';
+import { BimQuery } from './bimQuery';
+import { BuildGeometryOptions } from './buildGeometryGroup';
+import { BimEntities } from './bimEntities';
+import { BimParameterTable } from './BimParameterTable';
+import { BimParameterDescriptors } from './BimParameterDescriptors';
+export type EntityIndex = number & {
+    __brand: "EntityIndex";
+};
+export type StringIndex = number & {
+    __brand: "StringIndex";
+};
+export type InstanceIndex = number & {
+    __brand: "InstanceIndex";
+};
+export type DescriptorIndex = number & {
+    __brand: "InstanceIndex";
+};
+export declare class BimData {
+    BimGeometry: BimGeometry;
+    Entities: BimEntities;
+    Strings: Array<string>;
+    ThreeGeometry: THREE.Group;
+    Resolver: BimResolver;
+    Query: BimQuery;
+    Instances: Array<Instance | undefined>;
+    Descriptors: BimParameterDescriptors;
+    IntegerParameters: BimParameterTable;
+    StringParameters: BimParameterTable;
+    EntityParameters: BimParameterTable;
+    SingleParameters: BimParameterTable;
+    PointParameters: BimParameterTable;
+    /** Options used when building geometry (stored for rebuildGeometry) */
+    geometryOptions: BuildGeometryOptions;
+    rebuildGeometry(instances: Array<Instance | undefined>): THREE.Group;
+}

package/dist/types/loader/bimEntities.d.ts

@@ -0,0 +1,9 @@
+import { StringIndex, EntityIndex } from './bimData';
+export interface BimEntities {
+    LocalId: Array<number>;
+    GlobalId: Array<StringIndex>;
+    Document: Array<EntityIndex>;
+    Name: Array<StringIndex>;
+    Category: Array<EntityIndex>;
+    Type: Array<EntityIndex>;
+}

package/dist/types/loader/bimGeometry.d.ts

@@ -3,7 +3,7 @@ export interface BimGeometry {
     InstanceMaterialIndex: Int32Array;
     InstanceMeshIndex: Int32Array;
     InstanceTransformIndex: Int32Array;
-    InstanceGlobalId?: string[];
+    InstanceFlags: Uint8Array;
     VertexX: Int32Array;
     VertexY: Int32Array;
     VertexZ: Int32Array;

package/dist/types/loader/bimOpenSchemaLoader.d.ts

@@ -1,14 +1,26 @@
-import * as THREE from 'three';
 import JSZip from 'jszip';
-import { BimGeometry } from './bimGeometry';
+import { BimData } from './bimData';
+/**
+ * Options for loading BOS files
+ */
+export interface BosLoaderOptions {
+    /**
+     * Whether to apply Z-up to Y-up rotation.
+     * - true: Apply rotation (for Revit exports which are Z-up)
+     * - false: No rotation (for IFC imports which are already Y-up compatible)
+     * Default: true (for backwards compatibility with Revit BOS files)
+     */
+    applyZUpToYUpRotation?: boolean;
+    skipDescriptorsAndParameters?: boolean;
+}
 /**
  * Loader that takes a URL to a .ZIP or .BOS file containing BIM Open Schema geometry parquet tables:
  */
 export declare class BimOpenSchemaLoader {
-    load(source: string): Promise<THREE.Group>;
+    load(source: string, options?: BosLoaderOptions): Promise<BimData>;
 }
 /**
  * Reads the BOS parquet tables from a JSZip archive into a BimGeometry object.
  * This is the same idea as the previous browser version, just using package imports.
  */
-export declare function loadBimGeometryFromZip(zip: JSZip): Promise<BimGeometry>;
+export declare function loadBimGeometryFromZip(zip: JSZip, options?: BosLoaderOptions): Promise<BimData>;

package/dist/types/loader/bimQuery.d.ts

@@ -0,0 +1,13 @@
+import { BimData } from './bimData';
+import { BimResolver, Parameter } from './bimResolver';
+import { Instance } from './buildInstances';
+export declare class BimQuery {
+    readonly Data: BimData;
+    constructor(Data: BimData);
+    readonly Resolver: BimResolver;
+    FuncToInstances(f: (i: Instance) => string): Map<string, Instance[]>;
+    CategoryToInstances(): Map<string, Instance[]>;
+    GlobalIdToInstances(): Map<string, Instance[]>;
+    GetLevelFromParameters(ps: Array<Parameter>): string;
+    LevelToInstances(): Map<string, Instance[]>;
+}

package/dist/types/loader/bimResolver.d.ts

@@ -0,0 +1,49 @@
+import { BimData, StringIndex, EntityIndex, InstanceIndex, DescriptorIndex } from './bimData';
+import { BimEntities } from './bimEntities';
+import { BimGeometry } from './bimGeometry';
+import { BimParameterDescriptors } from './BimParameterDescriptors';
+import { BimParameterTable } from './BimParameterTable';
+import { Instance } from './buildInstances';
+import { BosLoaderOptions } from './bimOpenSchemaLoader';
+export type Parameter = {
+    Name: string;
+    Value: any;
+};
+export declare class BimResolver {
+    readonly Data: BimData;
+    constructor(Data: BimData, options?: BosLoaderOptions);
+    GetVal(rawVal: number, descType: number): any;
+    ProcessParameters(table: BimParameterTable): void;
+    readonly Descriptors: BimParameterDescriptors;
+    readonly Strings: Array<string>;
+    readonly Entities: BimEntities;
+    readonly InstanceCount: number;
+    readonly EntityCount: number;
+    readonly BimGeometry: BimGeometry;
+    readonly DescriptorCount: number;
+    readonly ParameterMap: Map<EntityIndex, Array<Parameter>>;
+    GetString(stringIndex: StringIndex): string;
+    GetEntityName(i: EntityIndex): string;
+    GetEntityCategory(i: EntityIndex): EntityIndex;
+    GetEntityCategoryName(i: EntityIndex): string;
+    GetEntityType(i: EntityIndex): EntityIndex;
+    GetEntityTypeName(i: EntityIndex): string;
+    GetEntityDocument(i: EntityIndex): EntityIndex;
+    GetEntityDocumentName(i: EntityIndex): string;
+    GetEntityParameters(i: EntityIndex): Array<Parameter>;
+    GetInstanceName(i: Instance): string;
+    GetInstanceCategoryName(i: Instance): string;
+    GetInstanceTypeName(i: Instance): string;
+    GetInstanceDocumentName(i: Instance): string;
+    GetInstanceGlobalId(i: Instance): string;
+    GetInstanceParameters(i: Instance): Array<Parameter>;
+    GetDescriptorName(i: DescriptorIndex): string;
+    GetDescriptorType(i: DescriptorIndex): number;
+    GetDescriptorGroup(i: DescriptorIndex): string;
+    GetDescriptorUnits(i: DescriptorIndex): string;
+    EntityIndices(): Iterable<EntityIndex>;
+    InstanceIndices(): Iterable<InstanceIndex>;
+    DescriptorIndices(): Iterable<DescriptorIndex>;
+    first<T>(iterable: Iterable<T>, predicate: (value: T) => boolean, _default: T): T;
+    FindDescriptor(name: string): DescriptorIndex;
+}

package/dist/types/loader/buildGeometryGroup.d.ts

@@ -1,14 +1,23 @@
 import * as THREE from 'three';
-import { BimGeometry } from './bimGeometry';
-type InstanceGroup = {
-    meshIndex: number;
-    materialIndex: number;
-    instanceIndices: number[];
+import { Instance } from './buildInstances';
+type GroupedInstances = Map<THREE.Material, Map<THREE.BufferGeometry, Instance[]>>;
+type InstanceMaterialGroup = {
+    material: THREE.Material;
+    instances: Array<Instance>;
 };
-export declare function buildGeometry(bim: BimGeometry): THREE.Group;
-export declare function createMergedAndSingleMeshes(bim: BimGeometry, geometries: Array<THREE.BufferGeometry>, materials: Array<THREE.Material>, transforms: Array<THREE.Matrix4>, materialGroups: Map<number, number[]>): Array<THREE.Mesh>;
-export declare function computeTransforms(bim: BimGeometry): any[];
-export declare function mergeGeometries(geometries: Array<THREE.BufferGeometry>): THREE.BufferGeometry;
-export declare function gatherSingleInstancesByMaterial(instanceGroups: Array<InstanceGroup>): Map<number, number[]>;
-export declare function createInstances(bim: BimGeometry, geometries: Array<THREE.BufferGeometry>, materials: Array<THREE.Material>, transforms: Array<THREE.Matrix4>, instanceGroups: Array<InstanceGroup>): Array<THREE.InstancedMesh>;
+export interface BuildGeometryOptions {
+    /**
+     * Whether to apply Z-up to Y-up rotation (-90° around X axis).
+     * Default: true
+     */
+    applyZUpToYUpRotation?: boolean;
+}
+export declare function buildGeometry(instances: Array<Instance | undefined>, options?: BuildGeometryOptions): THREE.Group;
+export declare function createMergedAndSingleMeshes(materialGroups: Array<InstanceMaterialGroup>): Array<THREE.Mesh>;
+export declare function mergeGeometries(geometries: Array<THREE.BufferGeometry>): {
+    geometry: THREE.BufferGeometry;
+    triToInstanceIndex: Uint32Array;
+};
+export declare function gatherSingleInstancesByMaterial(groups: GroupedInstances): Array<InstanceMaterialGroup>;
+export declare function createInstancedMeshes(instanceGroups: GroupedInstances): Array<THREE.InstancedMesh>;
 export {};

package/dist/types/loader/buildInstances.d.ts

@@ -0,0 +1,13 @@
+import * as THREE from 'three';
+import { BimGeometry } from './bimGeometry';
+import { EntityIndex, InstanceIndex } from './bimData';
+export type Instance = {
+    isIdentity: boolean;
+    instance: InstanceIndex;
+    entity: EntityIndex;
+    geometry: THREE.BufferGeometry;
+    material: THREE.Material;
+    transform: THREE.Matrix4;
+};
+export declare function buildInstances(bg: BimGeometry): Array<Instance | undefined>;
+export declare function computeTransforms(bim: BimGeometry): Array<THREE.Matrix4>;

package/dist/types/viewer/environment.d.ts

@@ -16,14 +16,13 @@ export declare class GroundPlane {
 }
 export declare class Environment {
     skyLight: THREE.HemisphereLight;
-    ambientLight: THREE.AmbientLight;
     sunLights: THREE.DirectionalLight[];
     private _groundPlane;
     get groundPlane(): THREE.Mesh;
     constructor(settings: Settings);
     loadGroundTexture(encoding: TextureEncoding, url: string): void;
     /**
-     * Returns all objects composing the environment
+     * Returns all three objects composing the environment
      */
     getObjects(): THREE.Object3D[];
     applySettings(settings: Settings): void;
@@ -35,7 +34,6 @@ export declare class Environment {
 }
 export interface IEnvironment {
     skyLight: THREE.HemisphereLight;
-    ambientLight: THREE.AmbientLight;
     sunLights: THREE.DirectionalLight[];
     groundPlane: THREE.Mesh;
 }

package/dist/types/viewer/rendering/renderer.d.ts

@@ -10,10 +10,9 @@ export declare class Renderer {
     camera: Camera;
     needsUpdate: boolean;
     constructor(scene: THREE.Scene, viewport: Viewport, camera: Camera, settings: Settings);
-    applyRenderingSettings(settings: Settings): void;
     dispose(): void;
-    get background(): THREE.Color | THREE.Texture | null;
-    set background(color: THREE.Color | THREE.Texture | null);
+    get background(): THREE.Color | THREE.Texture;
+    set background(color: THREE.Color | THREE.Texture);
     render(): void;
     add(target: THREE.Object3D): boolean;
     remove(target: THREE.Object3D): void;

package/dist/types/viewer/viewer.d.ts

@@ -23,6 +23,7 @@ export declare class Viewer {
     stop(): void;
     private animate;
     add(obj: THREE.Object3D, frameCamera?: boolean): void;
+    remove(obj: THREE.Object3D): void;
     clear(): void;
     dispose(): void;
 }

package/dist/types/viewer/viewerSettings.d.ts

@@ -1,32 +1,6 @@
 import * as THREE from 'three';
 export type TextureEncoding = 'url' | 'base64' | undefined;
 export { GizmoOptions } from './gizmos/gizmoAxes';
-/**
- * Example: Neutral lighting setup for color calibration or asset review
- *
- * ```typescript
- * const neutralSettings = {
- *   skylight: {
- *     intensity: 0  // Disable hemisphere light for neutral lighting
- *   },
- *   ambientLight: {
- *     color: new THREE.Color(0xffffff),
- *     intensity: 0.5  // Base level of even illumination
- *   },
- *   sunLights: [
- *     {
- *       position: new THREE.Vector3(5, 10, 7.5),
- *       color: new THREE.Color(0xffffff),
- *       intensity: 1  // Primary directional light
- *     }
- *   ],
- *   rendering: {
- *     toneMapping: THREE.ACESFilmicToneMapping,
- *     toneMappingExposure: 1.0
- *   }
- * }
- * ```
- */
 /**
  * Makes all field optional recursively
  * https://stackoverflow.com/questions/41980195/recursive-partialt-in-typescript
@@ -93,7 +67,7 @@ export type Settings = {
      * Rendering background options
      */
     background: {
-        color: THREE.Color | null;
+        color: THREE.Color;
     };
     /**
      * Plane under scene related options
@@ -113,21 +87,12 @@ export type Settings = {
     };
     /**
      * Skylight (hemisphere light) options
-     * Used for natural lighting with sky/ground color variation
      */
     skylight: {
         skyColor: THREE.Color;
         groundColor: THREE.Color;
         intensity: number;
     };
-    /**
-     * Ambient light options
-     * Used for neutral lighting setup (even illumination without color casts)
-     */
-    ambientLight: {
-        color: THREE.Color;
-        intensity: number;
-    };
     /**
      * Sunlight (directional light) options
      */
@@ -138,19 +103,6 @@ export type Settings = {
     }[];
     rendering: {
         onDemand: boolean;
-        /**
-         * Tone mapping mode for the renderer
-         * ACESFilmicToneMapping is recommended for realistic results and wider dynamic range
-         */
-        toneMapping: THREE.ToneMapping;
-        /**
-         * Tone mapping exposure value
-         */
-        toneMappingExposure: number;
-        /**
-         * Output color space for the renderer
-         */
-        outputColorSpace: THREE.ColorSpace;
     };
 };
 export type PartialSettings = RecursivePartial<Settings>;

package/package.json

@@ -1,74 +1,77 @@
-{
-  "name": "@yschindel/ara3d-webgl",
-  "version": "1.3.10",
-  "description": "A 3D viewer designed for large architectural (BIM) models built on top of Three.JS.",
-  "files": [
-    "dist"
-  ],
-  "types": "./dist/types/index.d.ts",
-  "module": "dist/ara3d-webgl.mjs",
-  "homepage": "https://github.com/ara3d/ara3d-webgl.git",
-  "bugs": {
-    "url": "https://github.com/ara3d/ara3d-webgl/issues"
-  },
-  "license": "MIT",
-  "author": "Ara 3D <info@ara3d.com>",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/ara3d/ara3d-webgl.git"
-  },
-  "scripts": {
-    "dev": "vite --config vite.config.docs.js --host",
-    "build:docs": "vite build --config vite.config.docs.js && npm run gentypes",
-    "build:lib": "npx vite build --config vite.config.lib.js && npm run gentypes",
-    "preview:docs": "vite preview --mode github --config vite.config.docs.js --host",
-    "serve:docs": "http-server ./docs -o --host",
-    "eslint": "eslint --ext .js,.ts src --fix",
-    "gentypes": "tsc --declaration --emitDeclarationOnly --outdir ./dist/types",
-    "prepare": "npm run build:lib"
-  },
-  "devDependencies": {
-    "@types/axios": "^0.14.0",
-    "@typescript-eslint/eslint-plugin": "^5.45.1",
-    "@typescript-eslint/parser": "^5.45.1",
-    "eslint": "^8.29.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-config-standard": "^17.0.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-promise": "^6.1.1",
-    "http-server": "^14",
-    "opener": "^1.5.2",
-    "prettier": "^2.8.0",
-    "typescript": "^5.9.3",
-    "vite": "^3.2.5"
-  },
-  "dependencies": {
-    "@types/node": "^18.11.11",
-    "deepmerge": "^4.2.2",
-    "hyparquet": "^1.23.2",
-    "hyparquet-compressors": "^1.1.1",
-    "jszip": "^3.10.1",
-    "ste-events": "^3.0.7",
-    "ste-signals": "^3.0.9",
-    "ste-simple-events": "^3.0.7",
-    "three": "^0.182.0"
-  },
-  "keywords": [
-    "3d",
-    "ara3d",
-    "ara 3d",
-    "bim",
-    "viewer",
-    "three.js",
-    "model",
-    "aec",
-    "BIM Open Schema",
-    "BIM",
-    "BOS",
-    ".bos",
-    "loader",
-    "webgl"
-  ]
-}
+{
+    "name": "@yschindel/ara3d-webgl",
+    "version": "1.3.14",
+    "description": "A 3D viewer designed for large architectural (BIM) models built on top of Three.JS.",
+    "files": [
+        "dist"
+    ],
+    "types": "./dist/types/index.d.ts",
+    "module": "/dist/ara3d-webgl.mjs",
+    "homepage": "https://github.com/yschindel/ara3d-webgl.git",
+    "bugs": {
+        "url": "https://github.com/yschindel/ara3d-webgl/issues"
+    },
+    "license": "MIT",
+    "author": "Yssentyl Technologies <contact@yssentyl.com>",
+    "publishConfig": {
+        "access": "public"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/yschindel/ara3d-webgl.git"
+    },
+    "scripts": {
+        "dev": "vite --config vite.config.docs.js --host",
+        "build:docs": "vite build --config vite.config.docs.js && npm run gentypes",
+        "build:lib": "vite build --config vite.config.lib.js && npm run gentypes",
+        "dev:lib-watch": "vite build --config vite.config.lib.js --watch",
+        "preview:docs": "vite preview --mode github --config vite.config.docs.js --host",
+        "serve:docs": "http-server ./docs -o --host",
+        "eslint": "eslint --ext .js,.ts src --fix",
+        "gentypes": "tsc --declaration --emitDeclarationOnly --outdir ./dist/types"
+    },
+    "devDependencies": {
+        "@types/axios": "^0.14.0",
+        "@typescript-eslint/eslint-plugin": "^5.45.1",
+        "@typescript-eslint/parser": "^5.45.1",
+        "eslint": "^8.29.0",
+        "eslint-config-prettier": "^8.5.0",
+        "eslint-config-standard": "^17.0.0",
+        "eslint-plugin-import": "^2.26.0",
+        "eslint-plugin-node": "^11.1.0",
+        "eslint-plugin-prettier": "^4.2.1",
+        "eslint-plugin-promise": "^6.1.1",
+        "http-server": "^14",
+        "opener": "^1.5.2",
+        "prettier": "^2.8.0",
+        "typescript": "^5.9.3",
+        "vite": "^3.2.5"
+    },
+    "dependencies": {
+        "@types/node": "^18.11.11",
+        "deepmerge": "^4.2.2",
+        "hyparquet": "^1.23.0",
+        "hyparquet-compressors": "^1.1.1",
+        "jszip": "^3.10.1",
+        "ste-events": "^3.0.7",
+        "ste-signals": "^3.0.9",
+        "ste-simple-events": "^3.0.7",
+        "three": "^0.182.0"
+    },
+    "keywords": [
+        "3d",
+        "ara3d",
+        "ara 3d",
+        "bim",
+        "viewer",
+        "three.js",
+        "model",
+        "aec",
+        "BIM Open Schema",
+        "BIM",
+        "BOS",
+        ".bos",
+        "loader",
+        "webgl"
+    ]
+}

package/dist/types/loader/bimGhostController.d.ts

@@ -1,21 +0,0 @@
-import * as THREE from 'three';
-/**
- * Controller for ghosting/isolation of BIM elements by GlobalId.
- * Allows focusing on specific elements while ghosting all others.
- */
-export declare class BimGhostController {
-    private root;
-    private globalIdToEntityIndex;
-    private entityToInstances;
-    constructor(root: THREE.Group);
-    /**
-     * Isolate elements: show these at full opacity, ghost everything else.
-     * @param globalIds Array of GlobalIds to keep at full opacity
-     * @param ghostOpacity Opacity for ghosted elements (default 0.1)
-     */
-    isolate(globalIds: string[], ghostOpacity?: number): void;
-    /**
-     * Clear isolation: show all elements at full opacity.
-     */
-    clearIsolation(): void;
-}

package/dist/types/loader/ghostMaterial.d.ts

@@ -1,6 +0,0 @@
-import * as THREE from 'three';
-/**
- * Creates a material that supports per-instance opacity via instanceOpacity attribute.
- * This allows ghosting individual instances within an InstancedMesh.
- */
-export declare function createGhostableMaterial(baseMaterial: THREE.MeshStandardMaterial): THREE.MeshStandardMaterial;