@kingsy/viewer 2.25.7

package/dist/IViewer.d.ts

@@ -0,0 +1,157 @@
+import { Vector3 } from 'three';
+import { type PropertyInfo } from './modules/filtering/PropertyManager.js';
+import type { Query, QueryArgsResultMap } from './modules/queries/Query.js';
+import { type TreeNode, WorldTree } from './modules/tree/WorldTree.js';
+import { type Utils } from './modules/Utils.js';
+import { World } from './modules/World.js';
+import KingSyRenderer from './modules/KingSyRenderer.js';
+import { Extension } from './modules/extensions/Extension.js';
+import { Loader } from './modules/loaders/Loader.js';
+import { type Constructor } from 'type-fest';
+import type { Vector3Like } from './modules/batching/BatchObject.js';
+import type { FilteringState } from './modules/extensions/FilteringExtension.js';
+export type KingSyReference = {
+    referencedId: string;
+};
+export type KingSyObject = {
+    [k: string]: unknown;
+    kingsy_type: string;
+    id: string;
+    elements?: KingSyReference[];
+    children?: KingSyObject[] | KingSyReference[];
+    name?: string;
+    referencedId?: string;
+    units?: string;
+    applicationId?: string;
+};
+export interface ViewerParams {
+    showStats: boolean;
+    environmentSrc: Asset;
+    verbose: boolean;
+}
+export declare enum AssetType {
+    TEXTURE_8BPP = "png",// For now
+    TEXTURE_HDR = "hdr",
+    TEXTURE_EXR = "exr",
+    FONT_JSON = "font-json"
+}
+export interface Asset {
+    id: string;
+    src: string;
+    type: AssetType;
+}
+/**
+ * The default HDRI the viewer uses is actually a true HDR image (.exr),
+ * specified by the explicit TEXTURE_EXR
+ *
+ * We do this because bundling an actual .exr or .hdr image format would require
+ * anybody consuming the viewer to make adjustments to their build config, to enable
+ * its import.
+ *
+ * Three.js doesn't mind the extension of the asset you load, so an .exr hidden behind
+ * a .png will work just fine.
+ */
+export declare const DefaultViewerParams: ViewerParams;
+export declare enum ViewerEvent {
+    ObjectClicked = "object-clicked",
+    ObjectDoubleClicked = "object-doubleclicked",
+    LoadComplete = "load-complete",
+    UnloadComplete = "unload-complete",
+    UnloadAllComplete = "unload-all-complete",
+    Busy = "busy",
+    FilteringStateSet = "filtering-state-set",
+    LightConfigUpdated = "light-config-updated"
+}
+export interface ViewerEventPayload {
+    [ViewerEvent.ObjectClicked]: SelectionEvent | null;
+    [ViewerEvent.ObjectDoubleClicked]: SelectionEvent | null;
+    [ViewerEvent.LoadComplete]: string;
+    [ViewerEvent.UnloadComplete]: string;
+    [ViewerEvent.UnloadAllComplete]: void;
+    [ViewerEvent.Busy]: boolean;
+    [ViewerEvent.FilteringStateSet]: FilteringState;
+    [ViewerEvent.LightConfigUpdated]: LightConfiguration;
+}
+export type KingSyView = KingSyObject & {
+    origin: Vector3Like;
+    target: Vector3Like;
+    name?: string;
+    upDirection?: Vector3Like;
+    forwardDirection?: Vector3Like;
+};
+export type SelectionEvent = {
+    multiple: boolean;
+    event?: PointerEvent;
+    hits: Array<{
+        node: TreeNode;
+        point: Vector3;
+    }>;
+};
+export interface LightConfiguration {
+    enabled?: boolean;
+    castShadow?: boolean;
+    intensity?: number;
+    color?: number;
+    indirectLightIntensity?: number;
+    shadowcatcher?: boolean;
+}
+export interface SunLightConfiguration extends LightConfiguration {
+    elevation?: number;
+    azimuth?: number;
+    radius?: number;
+}
+export declare const DefaultLightConfiguration: SunLightConfiguration;
+export declare enum ObjectLayers {
+    STREAM_CONTENT_MESH = 10,
+    STREAM_CONTENT_LINE = 11,
+    STREAM_CONTENT_POINT = 12,
+    STREAM_CONTENT_TEXT = 13,
+    STREAM_CONTENT_POINT_CLOUD = 14,
+    NONE = 0,
+    STREAM_CONTENT = 1,
+    PROPS = 2,
+    SHADOWCATCHER = 3,
+    OVERLAY = 4,
+    MEASUREMENTS = 5
+}
+export declare enum UpdateFlags {
+    RENDER = 1,
+    SHADOWS = 2,
+    CLIPPING_PLANES = 4,
+    RENDER_RESET = 8
+}
+export interface MaterialOptions {
+    stencilOutlines?: StencilOutlineType;
+    pointSize?: number;
+    depthWrite?: number;
+}
+export declare enum StencilOutlineType {
+    NONE = 0,
+    OVERLAY = 1,
+    OUTLINE_ONLY = 2
+}
+export interface IViewer {
+    get Utils(): Utils;
+    get World(): World;
+    init(): Promise<void>;
+    resize(): void;
+    on<T extends ViewerEvent>(eventType: T, handler: (arg: ViewerEventPayload[T]) => void): void;
+    requestRender(flags?: UpdateFlags): void;
+    setLightConfiguration(config: LightConfiguration): void;
+    getViews(): KingSyView[];
+    loadObject(loader: Loader, zoomToObject?: boolean): Promise<void>;
+    cancelLoad(url: string, unload?: boolean): Promise<void>;
+    unloadObject(url: string): Promise<void>;
+    unloadAll(): Promise<void>;
+    screenshot(): Promise<string>;
+    getObjectProperties(resourceURL?: string, bypassCache?: boolean): Promise<PropertyInfo[]>;
+    /** Data ops */
+    getWorldTree(): WorldTree;
+    query<T extends Query>(query: T): QueryArgsResultMap[T['operation']] | null;
+    getRenderer(): KingSyRenderer;
+    getContainer(): HTMLElement;
+    createExtension<T extends Extension>(type: Constructor<T>): T;
+    getExtension<T extends Extension>(type: Constructor<T>): T;
+    hasExtension<T extends Extension>(type: Constructor<T>): boolean;
+    dispose(): void;
+}

package/dist/helpers/flatten.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Flattens a kingsy object. It will ignore arrays, null and undefined valuesm, as well as various 'safe to ignore' kingsy properties, such as
+ * bbox, __closure, __parents, totalChildrenCount.
+ * @param obj object to flatten
+ * @returns an object with all its props flattened into `prop.subprop.subsubprop`.
+ */
+declare const flattenObject: (obj: {
+    [x: string]: unknown;
+    id: unknown;
+}) => Record<string, unknown>;
+export default flattenObject;

package/dist/helpers/typeHelper.d.ts

@@ -0,0 +1,2 @@
+export type Maybe<T> = T | null;
+export type Optional<T> = T | undefined;

package/dist/index.d.ts

@@ -0,0 +1,89 @@
+import { Viewer } from './modules/Viewer.js';
+import { AssetType, DefaultLightConfiguration, DefaultViewerParams, type IViewer, ObjectLayers, type SelectionEvent, type KingSyObject, type KingSyReference, type KingSyView, UpdateFlags, ViewerEvent, type ViewerParams, LightConfiguration, ViewerEventPayload, StencilOutlineType } from './IViewer.js';
+import type { PropertyInfo, StringPropertyInfo, NumericPropertyInfo } from './modules/filtering/PropertyManager.js';
+import { type SunLightConfiguration } from './IViewer.js';
+import { World } from './modules/World.js';
+import { type NodeData, type TreeNode, WorldTree } from './modules/tree/WorldTree.js';
+import type { PointQuery, QueryResult, IntersectionQuery, PointQueryResult, IntersectionQueryResult } from './modules/queries/Query.js';
+import { type Utils } from './modules/Utils.js';
+import { BatchObject } from './modules/batching/BatchObject.js';
+import { type MeasurementOptions, MeasurementType, MeasurementsExtension } from './modules/extensions/measurements/MeasurementsExtension.js';
+import { Units } from './modules/converter/Units.js';
+import { SelectionExtension, SelectionExtensionOptions, DefaultSelectionExtensionOptions } from './modules/extensions/SelectionExtension.js';
+import { CameraController, CameraControllerOptions, NearPlaneCalculation } from './modules/extensions/CameraController.js';
+import { type InlineView } from './modules/extensions/CameraController.js';
+import { type CanonicalView } from './modules/extensions/CameraController.js';
+import { CameraEvent, CameraEventPayload } from './modules/objects/KingSyCamera.js';
+import { SectionOutlines } from './modules/extensions/sections/SectionOutlines.js';
+import { FilteringExtension, type FilteringState } from './modules/extensions/FilteringExtension.js';
+import { Extension } from './modules/extensions/Extension.js';
+import { ExplodeEvent, ExplodeExtension } from './modules/extensions/ExplodeExtension.js';
+import { DiffExtension, type DiffResult, VisualDiffMode } from './modules/extensions/DiffExtension.js';
+import { Loader, LoaderEvent } from './modules/loaders/Loader.js';
+import { KingSyLoader } from './modules/loaders/KingSy/KingSyLoader.js';
+import { ObjLoader } from './modules/loaders/OBJ/ObjLoader.js';
+import { LegacyViewer } from './modules/LegacyViewer.js';
+import { GeometryConverter, KingSyType } from './modules/loaders/GeometryConverter.js';
+import Input, { InputEvent, InputEventPayload } from './modules/input/Input.js';
+import { GeometryType } from './modules/batching/Batch.js';
+import { MeshBatch } from './modules/batching/MeshBatch.js';
+import KingSyStandardMaterial from './modules/materials/KingSyStandardMaterial.js';
+import KingSyTextMaterial from './modules/materials/KingSyTextMaterial.js';
+import { KingSyText } from './modules/objects/KingSyText.js';
+import { NodeRenderView } from './modules/tree/NodeRenderView.js';
+import { CONTAINED, INTERSECTED, NOT_INTERSECTED, type ExtendedIntersection } from './modules/objects/KingSyRaycaster.js';
+import { KingSyGeometryConverter } from './modules/loaders/KingSy/KingSyGeometryConverter.js';
+import { Assets } from './modules/Assets.js';
+import { InstancedBatchObject } from './modules/batching/InstancedBatchObject.js';
+import { HybridCameraController } from './modules/extensions/HybridCameraController.js';
+import KingSyBasicMaterial from './modules/materials/KingSyBasicMaterial.js';
+import LineBatch from './modules/batching/LineBatch.js';
+import { PointBatch } from './modules/batching/PointBatch.js';
+import TextBatch from './modules/batching/TextBatch.js';
+import { ArcticViewPipeline } from './modules/pipeline/Pipelines/ArcticViewPipeline.js';
+import { DefaultPipeline } from './modules/pipeline/Pipelines/DefaultPipeline.js';
+import { PenViewPipeline } from './modules/pipeline/Pipelines/PenViewPipeline.js';
+import { SolidViewPipeline } from './modules/pipeline/Pipelines/SolidViewPipeline.js';
+import { TAAPipeline } from './modules/pipeline/Pipelines/TAAPipeline.js';
+import KingSyRenderer from './modules/KingSyRenderer.js';
+import { RenderTree } from './modules/tree/RenderTree.js';
+import KingSyConverter from './modules/loaders/KingSy/KingSyConverter.js';
+import { ViewMode, ViewModes } from './modules/extensions/ViewModes.js';
+import { BaseGPass, ClearFlags, GPass, ObjectVisibility, PassOptions, ProgressiveGPass } from './modules/pipeline/Passes/GPass.js';
+import { DefaultPipelineOptions, Pipeline } from './modules/pipeline/Pipelines/Pipeline.js';
+import { ProgressivePipeline } from './modules/pipeline/Pipelines/ProgressivePipeline.js';
+import { DepthPass, DepthPassOptions } from './modules/pipeline/Passes/DepthPass.js';
+import { GeometryPass } from './modules/pipeline/Passes/GeometryPass.js';
+import { NormalsPass } from './modules/pipeline/Passes/NormalsPass.js';
+import { InputType, OutputPass, OutputPassOptions } from './modules/pipeline/Passes/OutputPass.js';
+import { ViewportPass, ViewportPassOptions } from './modules/pipeline/Passes/ViewportPass.js';
+import { BlendPass, BlendPassOptions } from './modules/pipeline/Passes/BlendPass.js';
+import { DepthNormalPass } from './modules/pipeline/Passes/DepthNormalPass.js';
+import { ShadedPass } from './modules/pipeline/Passes/ShadedPass.js';
+import { DefaultProgressiveAOPassOptions, ProgressiveAOPass, ProgressiveAOPassOptions } from './modules/pipeline/Passes/ProgressiveAOPass.js';
+import { TAAPass } from './modules/pipeline/Passes/TAAPass.js';
+import { FilterMaterial, FilterMaterialOptions, FilterMaterialType } from './modules/materials/Materials.js';
+import { KingSyOfflineLoader } from './modules/loaders/KingSy/KingSyOfflineLoader.js';
+import { AccelerationStructure } from './modules/objects/AccelerationStructure.js';
+import { TopLevelAccelerationStructure } from './modules/objects/TopLevelAccelerationStructure.js';
+import { StencilPass } from './modules/pipeline/Passes/StencilPass.js';
+import { KingSyWebGLRenderer } from './modules/objects/KingSyWebGLRenderer.js';
+import { InstancedMeshBatch } from './modules/batching/InstancedMeshBatch.js';
+import { ViewModeEvent, ViewModeEventPayload } from './modules/extensions/ViewModes.js';
+import { ShadedViewPipeline } from './modules/pipeline/Pipelines/ShadedViewPipeline.js';
+import KingSyMesh from './modules/objects/KingSyMesh.js';
+import KingSyInstancedMesh from './modules/objects/KingSyInstancedMesh.js';
+import { SectionTool, SectionToolEvent, SectionToolEventPayload } from './modules/extensions/sections/SectionTool.js';
+import { WebXrViewer } from './modules/WebXrViewer.js';
+import { StencilMaskPass } from './modules/pipeline/Passes/StencilMaskPass.js';
+import { DefaultEdgesPassOptions, EdgesPass, EdgesPassOptions } from './modules/pipeline/Passes/EdgesPass.js';
+import { Measurement, MeasurementState } from './modules/extensions/measurements/Measurement.js';
+import { PointToPointMeasurement } from './modules/extensions/measurements/PointToPointMeasurement.js';
+import { PerpendicularMeasurement } from './modules/extensions/measurements/PerpendicularMeasurement.js';
+import { AreaMeasurement } from './modules/extensions/measurements/AreaMeasurement.js';
+import { PointMeasurement } from './modules/extensions/measurements/PointMeasurement.js';
+import { DefaultEdgesPipelineOptions, EdgesPipeline } from './modules/pipeline/Pipelines/EdgesPipeline.js';
+import { Geometry } from './modules/converter/Geometry.js';
+export { Viewer, LegacyViewer, WebXrViewer, KingSyWebGLRenderer, DefaultViewerParams, ViewerEvent, DefaultLightConfiguration, World, BatchObject, InstancedBatchObject, WorldTree, RenderTree, VisualDiffMode, Measurement, PointToPointMeasurement, PerpendicularMeasurement, AreaMeasurement, PointMeasurement, MeasurementType, MeasurementState, Units, Extension, SelectionExtension, CameraController, SectionTool, SectionOutlines, MeasurementsExtension, FilteringExtension, CameraEvent, ExplodeExtension, ExplodeEvent, DiffExtension, Loader, KingSyConverter, GeometryConverter, Geometry, KingSyLoader, ObjLoader, LoaderEvent, UpdateFlags, KingSyType, Input, InputEvent, ObjectLayers, GeometryType, MeshBatch, InstancedMeshBatch, LineBatch, PointBatch, TextBatch, AccelerationStructure, TopLevelAccelerationStructure, KingSyStandardMaterial, KingSyBasicMaterial, KingSyTextMaterial, KingSyText, NodeRenderView, KingSyGeometryConverter, Assets, AssetType, HybridCameraController, KingSyRenderer, SectionToolEvent, StencilOutlineType, GPass, BaseGPass, ProgressiveGPass, DepthPass, GeometryPass, NormalsPass, OutputPass, ViewportPass, BlendPass, DepthNormalPass, ShadedPass as BasitPass, ProgressiveAOPass, TAAPass, StencilPass, StencilMaskPass, EdgesPass, PassOptions, EdgesPassOptions as EdgePassOptions, BlendPassOptions, DepthPassOptions, OutputPassOptions, ProgressiveAOPassOptions, ViewportPassOptions, DefaultEdgesPassOptions, DefaultProgressiveAOPassOptions, ClearFlags, ObjectVisibility, InputType, Pipeline, ProgressivePipeline, DefaultPipeline, EdgesPipeline, SolidViewPipeline, PenViewPipeline, ArcticViewPipeline, TAAPipeline, ShadedViewPipeline, DefaultPipelineOptions, DefaultEdgesPipelineOptions, ViewModes, ViewMode, FilterMaterial, FilterMaterialType, FilterMaterialOptions, KingSyOfflineLoader, NOT_INTERSECTED, INTERSECTED, CONTAINED, ViewModeEvent, KingSyMesh, KingSyInstancedMesh, CameraControllerOptions, NearPlaneCalculation };
+export type { IViewer, ViewerParams, SelectionEvent, PropertyInfo, StringPropertyInfo, NumericPropertyInfo, LightConfiguration, SunLightConfiguration, KingSyObject, KingSyReference, KingSyView, CanonicalView, InlineView, TreeNode, NodeData, PointQuery, IntersectionQuery, QueryResult, PointQueryResult, IntersectionQueryResult, Utils, DiffResult, MeasurementOptions, FilteringState, ExtendedIntersection, ViewerEventPayload, InputEventPayload, SectionToolEventPayload, CameraEventPayload, SelectionExtensionOptions, DefaultSelectionExtensionOptions, ViewModeEventPayload };
+export * as UrlHelper from './modules/UrlHelper.js';