@smarterplan/ngx-smarterplan-core 1.4.20 → 1.4.22

package/lib/services/viewer.service.d.ts

@@ -8,6 +8,24 @@ import { PoiService } from './models/poi.service';
 import { ThreeJsModelUp } from '../helpers.service';
 import { Config } from '../config';
 import * as i0 from "@angular/core";
+/**
+ * What a Gaussian splat file is named with, when it is a .ply: the content is what tells it from
+ * another .ply, and the key is all a visit stores (see isGaussianSplatPly).
+ */
+export declare const GAUSSIAN_SPLAT_PLY_SUFFIX = ".splat.ply";
+/**
+ * Whether a 3D model file holds Gaussian splats, which the Three.js viewer cannot draw: .spz,
+ * .splat, .ksplat, SuperSplat's .sog, a .ply named with GAUSSIAN_SPLAT_PLY_SUFFIX, or the
+ * lod-meta.json of a Streamed SOG - SuperSplat's levels of detail, in pieces beside it.
+ */
+export declare function isGaussianSplatFile(name: string): boolean;
+/**
+ * Whether a .ply holds Gaussian splats: what splat tools export carries, for each splat, its colour
+ * as spherical harmonics (f_dc_0...) and its size (scale_0...). Only the header is read.
+ */
+export declare function isGaussianSplatPly(file: Blob): Promise<boolean>;
+/** Whether a 3D model file is the lod-meta.json of a Streamed SOG; see isGaussianSplatFile. */
+export declare function isStreamedSplatFile(name: string): boolean;
 export declare class ViewerService {
     private readonly sdkKey;
     private readonly config;
@@ -155,6 +173,22 @@ export declare class ViewerService {
     private defaultTagIconUrl;
     /** Moves the Three.js camera to frame a tag, mirroring Matterport's goToTag. */
     goToThreeJsTag(elementId: string): void;
+    /** The tag the Three.js camera is sent to, for the splat viewer to point out; see goToThreeJsTag. */
+    get threeJsTagFocused$(): Subject<string>;
+    /** A tag clicked in the splat viewer, said as threeJsTagClicked$ says one clicked in the scene. */
+    clickThreeJsTag(elementId: string): void;
+    /** Whether the visit's 3D model has a calibration, from its capture's metadata. */
+    isThreeJsCalibrated(): boolean;
+    /** Whether the tags a calibration works with are on show; see ThreeJsService.showsCalibrationTags. */
+    isThreeJsShowingCalibrationTags(): boolean;
+    /** Whether a calibration is under way in the Three.js scene. */
+    isThreeJsAligningTags(): boolean;
+    /** Whether a measurement is taking clicks in the Three.js scene. */
+    isThreeJsMeasuring(): boolean;
+    /** True when a measurement starts taking clicks, false when it stops; see ThreeJsService.measuringChanged$. */
+    get threeJsMeasuringChanged$(): Subject<boolean>;
+    /** Says a click in the splat viewer was of no use to the calibration, as one in the scene would. */
+    ignoreThreeJsAlignmentClick(expected: 'tag' | 'point'): void;
     /** Shows only tags of the given POI types; null clears the filter. */
     setVisibleThreeJsTagTypes(types: PoiType[] | null): void;
     /**
@@ -165,11 +199,17 @@ export declare class ViewerService {
      */
     startThreeJsTagAlignment(): void;
     cancelThreeJsTagAlignment(): void;
-    get threeJsAlignmentProgress$(): Subject<{
-        pairs: number;
-        awaiting: "tag" | "point";
-        tagId?: string;
-    }>;
+    /**
+     * Says whether the 3D model on screen is the site's only visit. Then there is nowhere else for a
+     * tag to have come from, and the tags that do not record where they were placed are its own.
+     */
+    setThreeJsSoleVisit(sole: boolean): void;
+    /**
+     * Shows the tags a calibration would work with, including those hidden for not landing on the
+     * model, before anything is armed. Cancelling or saving the calibration hides them again.
+     */
+    revealThreeJsCalibrationTags(): void;
+    get threeJsAlignmentProgress$(): Subject<import("./threejs.service").ThreeJsAlignmentProgress>;
     /**
      * Solves the alignment and applies it to the scene, returning it as the JSON to store in the
      * capture's metadata. Null means the three tags were collinear and nothing was applied.
@@ -224,8 +264,28 @@ export declare class ViewerService {
         points: number;
         distances: number[];
     }>;
-    /** Ends the Three.js measurement in progress, or returns null when it has fewer than two points. */
-    finishThreeJsMeasurement(): ThreeJsMeasurement | null;
+    /**
+     * Ends the Three.js measurement in progress, or returns null when it has fewer than two points.
+     * `screenshot` is the picture of it, when the model is drawn by another viewer than the scene.
+     */
+    finishThreeJsMeasurement(screenshot?: string): ThreeJsMeasurement | null;
+    /** A measurement was taken off the model, finished or not; see ThreeJsService.measurementCleared$. */
+    get threeJsMeasurementCleared$(): Subject<void>;
+    /**
+     * Adds a point to the measurement under way, picked on the model in another viewer - the splat
+     * viewer - in the model's own coordinates. False when no measurement is under way.
+     */
+    addThreeJsMeasurePointAtModelPoint(point: {
+        x: number;
+        y: number;
+        z: number;
+    }): boolean;
+    /** The points of the measurement on the model, in the model's own coordinates, for another viewer to draw. */
+    getThreeJsMeasurePointsInModelFrame(): {
+        x: number;
+        y: number;
+        z: number;
+    }[];
     /** The measurement last finished in the Three.js viewer, for the form that saves it. */
     getThreeJsLastMeasurement(): ThreeJsMeasurement | null;
     /**
@@ -259,6 +319,22 @@ export declare class ViewerService {
     } | null;
     /** Chooses the tag for the calibration pair being matched by id, instead of by clicking it. */
     selectThreeJsAlignmentTag(elementId: string): boolean;
+    /**
+     * Gives the tag being matched in the calibration under way its real place, picked on the model in
+     * another viewer - the splat viewer - in the model's own coordinates. False when no tag was waiting.
+     */
+    matchThreeJsAlignmentTagAtModelPoint(point: {
+        x: number;
+        y: number;
+        z: number;
+    }): boolean;
+    /**
+     * Takes back the last step of the calibration under way: the tag just chosen, or else the last
+     * pair matched. False when there was nothing to take back.
+     */
+    undoThreeJsAlignmentStep(): boolean;
+    /** Removes one matched pair of the calibration under way, by its place in the list. */
+    removeThreeJsAlignmentPair(index: number): boolean;
     /** How far the visible tags sit from the 3D model, in model radii. Null without both. */
     getThreeJsTagDistanceFromModel(): number | null;
     /** How many tags the Three.js scene is showing. */
@@ -281,11 +357,37 @@ export declare class ViewerService {
      *
      * Returns null when there is no pending placement, which is the normal case in Matterport mode.
      */
-    createPoiForThreeJsPlacement(element: DbObjectType, poiType: PoiType): Promise<POI | null>;
+    createPoiForThreeJsPlacement(element: DbObjectType, poiType: PoiType, extra?: Partial<POI>): Promise<POI | null>;
     /** Emits when a tag is dropped on the model in the Three.js scene. */
     get threeJsTagPlaced$(): Subject<import("./threejs.service").ThreeJsTagPlacement>;
     /** Emits when the calibration walkthrough is abandoned, including via Escape. */
     get threeJsAlignmentCancelled$(): Subject<void>;
+    /** Emits when the Three.js tags change; see getThreeJsTagSnapshot. */
+    get threeJsTagsChanged$(): Subject<void>;
+    /** The tags, and their calibration, as a viewer drawing the scene elsewhere needs them. */
+    getThreeJsTagSnapshot(): {
+        tags: import("./threejs.service").ThreeJsTagSnapshot[];
+        alignment: import("../helpers.service").ThreeJsAlignment;
+    };
+    /** Stops drawing the Three.js scene while another viewer covers it, or starts again. */
+    setThreeJsRenderingPaused(paused: boolean): void;
+    /** Emits when a click during calibration landed on nothing it could use: a tag, or the model. */
+    get threeJsAlignmentClickIgnored$(): Subject<"tag" | "point">;
+    /** Emits when Three.js tag placement is armed (true) and when it ends (false). */
+    get threeJsPlacementChanged$(): Subject<boolean>;
+    /**
+     * Completes an armed Three.js tag placement at a spot the splat viewer picked, in the model's own
+     * coordinates: the creation form then opens as for a click in the Three.js scene.
+     */
+    placeThreeJsTagAtModelPoint(point: {
+        x: number;
+        y: number;
+        z: number;
+    }, normal?: {
+        x: number;
+        y: number;
+        z: number;
+    } | null): void;
     /** Leaves Three.js tag placement mode without placing anything. */
     cancelThreeJsTagPlacement(): void;
     editOnlyTagStyleForPoi(poi: POI, object: DbObjectType): void;

package/lib/types.service.d.ts

@@ -405,7 +405,9 @@ export type POI = {
 export declare enum ViewerInteractions {
     DEFAULT = 0,
     ADDING = 1,
-    POSITIONING = 2
+    POSITIONING = 2,
+    /** A loaded 3D object follows the cursor until the user clicks (validate) or cancels */
+    PLACING_OBJECT3D = 3
 }
 export type Mission = {
     userID: string;
@@ -820,6 +822,8 @@ export type IObject3D = {
     id?: string;
     object: string;
     format: string;
+    /** Full url of the model file; when set it replaces the url built from the bundled assets */
+    url?: string;
     mode: string;
     position: {
         x: number;
@@ -838,6 +842,43 @@ export type IObject3D = {
     };
     viewFrustum: boolean;
 };
+export type Point3D = {
+    x: number;
+    y: number;
+    z: number;
+};
+/** World-space bounding box of a 3D object */
+export type Object3DBoundingBox = {
+    min: Point3D;
+    max: Point3D;
+    size: Point3D;
+    center: Point3D;
+};
+/** Local transform of a 3D object (rotation in radians, Euler XYZ) */
+export type Object3DTransform = {
+    position: Point3D;
+    rotation: Point3D;
+    scale: Point3D;
+};
+/** Emitted when the transform of a 3D object changes (gizmo drag or setObject3DTransform) */
+export type Object3DTransformChange = Object3DTransform & {
+    uuid: string;
+};
+export type GizmoMode = 'translate' | 'rotate' | 'scale';
+/** Snapping steps of the gizmo. A missing / null value disables snapping for that mode */
+export type GizmoSnap = {
+    /** meters */
+    translation?: number | null;
+    /** degrees */
+    rotationDeg?: number | null;
+    /** scale step */
+    scale?: number | null;
+};
+/** Result of an interactive placement (surface point under the cursor and its normal) */
+export type Object3DPlacementResult = {
+    position: Point3D;
+    normal: Point3D;
+};
 /**
  * DynamoDb object3D
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smarterplan/ngx-smarterplan-core",
-  "version": "1.4.20",
+  "version": "1.4.22",
   "dependencies": {
     "tslib": "^2.5.0"
   },

package/public-api.d.ts

@@ -21,6 +21,7 @@ export * from './lib/services/search.service';
 export * from './lib/services/zone-drawer.service';
 export * from './lib/services/matterport-import.service';
 export * from './lib/services/threejs-import.service';
+export * from './lib/services/obj-to-glb';
 export * from './lib/services/matterport-tag-copy.service';
 export * from './lib/mattertagData';
 export * from './lib/services/utils/matterport-transform.util';
@@ -56,6 +57,7 @@ export * from './lib/components/csv-export/csv-export.component';
 export * from './lib/components/search-bar/search-bar.component';
 export * from './lib/components/menu-bar/menu-bar.component';
 export * from './lib/components/loader/loader.component';
+export * from './lib/components/splat-viewer/splat-viewer.component';
 export * from './lib/components/support-modal/support-modal.component';
 export * from './lib/components/menu-bar/avatar/avatar.component';
 export * from './lib/pipes/duration-to-string.pipe';