architwin 1.10.21 → 1.10.23

package/lib/architwin.d.ts

@@ -2,7 +2,7 @@ import { AxiosInstance } from "axios";
 import { MpSdk, Scene, Vector3, Vector2, Renderer } from "../bundle/sdk";
 import { tubeLineType } from "./loaders";
 import { initToolbarUI, themeManager } from "./atwinui";
-import { type ITag, type IUser, type ISpace, type IShowcaseObject, type I3DObject, type IMPConfig, type ISweep, type ITagPublic, type NearbyPayload, type NearbyObjects, type IObjectData, TRANSFORM_TYPE, Object3DPosition, ObjectCoordinates, EulerCoordinates, State, FileUpload, ObjectConfig, IAtwinFloor, IAtwinLabel, SPACE_EVENTS, ComponentOptions, SpaceAvatar, IMapConfig, MEETING_SIDEBAR, IO_ROLE, IO_SPACE_EVENTS, IO_MEETING_EVENTS, SCREEN_POSITIONS, ITagCategory, TagMessage, ISdkConnections, PartitionNode, PartitionPayload, ICurrentSpace } from "./types";
+import { type ITag, type IUser, type ISpace, type IShowcaseObject, type I3DObject, type IMPConfig, type ISweep, type ITagPublic, type NearbyPayload, type NearbyObjects, type IObjectData, TRANSFORM_TYPE, Object3DPosition, ObjectCoordinates, EulerCoordinates, State, FileUpload, ObjectConfig, IAtwinFloor, IAtwinLabel, SPACE_EVENTS, ComponentOptions, SpaceAvatar, IMapConfig, MEETING_SIDEBAR, IO_ROLE, IO_SPACE_EVENTS, IO_MEETING_EVENTS, SCREEN_POSITIONS, ITagCategory, TagMessage, ISdkConnections, PartitionNode, PartitionPayload, ICurrentSpace, SpaceMetadata } from "./types";
 import * as minimap from './minimap';
 import '../static/sidebar.css';
 import '../static/map.css';
@@ -11,7 +11,7 @@ import { createMeetingTemplate, joinMeetingTemplate } from "./meeting/templates"
 import { ActionHistory } from "./actionHistory";
 import * as meet from './zoom';
 import 'notyf/notyf.min.css';
-import { convertYupToZup, convertZupToYup } from "./worldConversion";
+import { convertYupToZup, convertZupToYup, getRelativePosition, getOriginalWorldPosition } from "./worldConversion";
 declare const transformHistory: ActionHistory;
 declare const _config: {
     mp: {
@@ -52,7 +52,7 @@ declare let domMousePosition: Vector3;
 declare let isFitScreenOccupied: boolean;
 declare let isCdnMapDataAvailable: boolean;
 declare let _atwinConnections: ISdkConnections;
-declare let _onMouseClickInstance: any;
+declare let _onMouseClickInstance: Function;
 declare let _modelDetails: MpSdk.Model.ModelDetails;
 declare const tagColors: string[];
 declare let _tubes: MpSdk.Scene.IObject;
@@ -153,6 +153,11 @@ declare function disableSweep(sweepIds?: string[], iframeId?: string): Promise<v
  */
 declare function setSelectedObject(data: IShowcaseObject, node: Scene.INode, component: Scene.IComponent, type: string): void;
 declare function get3DXObjects(): Array<IObjectData>;
+/**
+ * Clears the 3DXObjects array. DOES NOT remove the rendered objects from the space.
+ * Use carefully
+ */
+declare function clear3DXObjects(): void;
 /**
  * Clears the current selected object and sets it to null
  */
@@ -198,7 +203,37 @@ declare function captureSpaceScreenshot(callback?: Function | null, resolution?:
 declare function captureScreenshotAndCameraDetails(callback?: Function | null, resolution?: Renderer.Resolution, visibility?: Renderer.Visibility, iframeId?: string): Promise<{
     base64Screenshot: string;
     cameraPose: MpSdk.Camera.Pose;
+    cameraZoom: MpSdk.Camera.ZoomData;
 }>;
+/**
+ * Captures a screenshot (JPEG) of the user's current view.
+ * @param callback - Optional callback function.
+ * @param resolution - Optional screenshot resolution. Default: { width: 1920, height: 1080 }.
+ * @param visibility - Optional visibility settings. Default: { mattertags: false, measurements: false, sweeps: false, views: false }.
+ * @param iframeId - Optional id of iframe
+ * @returns {string} Screenshot URI -- a base64 encoded string
+ */
+declare function captureCurrentView(callback?: Function | null, resolution?: Renderer.Resolution, visibility?: Renderer.Visibility, iframeId?: string): Promise<string>;
+/**
+ * Zooms the camera by a percentage. The zoom delta is defined relative to the base field of view, not the current zoom.
+ * This means that the delta is strictly added, and not multiplied by the current zoom first.
+ * Ex: If at zoom 2.0, zooming by another 0.1x will bring the camera to 2.1x (2.0 + 0.1) not 2.2x (2.0 + 2.0 * 0.1)
+ * NOTE: This will FAIL if user is not in Inside Mode
+ * @param zoom -
+ */
+declare function cameraZoomBy(zoom: number, callback?: Function): Promise<number | undefined>;
+/**
+ * Zooms the camera to a percentage of the base field of view.
+ * Ex: Doubling the zoom, halves the field of view.
+ * NOTE: This will FAIL if user is not in Inside Mode
+ * @param zoom -
+ */
+declare function cameraZoomTo(zoom: number, callback?: Function): Promise<number | undefined>;
+/**
+ * Reset the zoom of the camera back to 1.0x.
+ * NOTE: This will FAIL if user is not in Inside Mode
+ */
+declare function cameraZoomReset(): Promise<void>;
 /**
  * Moves the camera position in the direction of the argument provided.
  * @constructor
@@ -281,6 +316,11 @@ declare function copyObject(payload: IShowcaseObject, position_offset?: Vector3,
  * @returns {Promise<IShowcaseObject>}
  */
 declare function replaceObject(payload: I3DObject, target: IObjectData, options?: Object): Promise<IShowcaseObject>;
+/**
+ * Navigates the user to Matterport's true origin (0, 0, 0) and places a marker at that location.
+ * If a custom marker URL is provided, it uses that; otherwise, it uses a default marker.
+ */
+declare function goToMPOrigin(iframeId?: string, customMarkerUrl?: string): Promise<void>;
 /**
  * Creates a 2D blank canvas that can used to display a wide variety images or videos dynamically by the user
  * A user can use transform controls to scale,reposition, and rotate the frame as they see fit
@@ -390,6 +430,11 @@ declare function deleteShowcaseObject(id: number): Promise<void>;
  * @returns {number} Model id
  */
 declare function disposeModel(target: IObjectData): Promise<number>;
+/**
+ * Deletes ALL models in the space
+ * @returns
+ */
+declare function disposeAllModels(): Promise<any[]>;
 declare function setLibrary(libraryModels: Array<I3DObject>): Promise<Array<I3DObject>>;
 declare function getLibrary(refetch?: boolean): Promise<Array<I3DObject>>;
 declare function getNearestSweepFromObject(objectId: number): {
@@ -402,9 +447,9 @@ declare function rotateCameraToObject(objectCoord: Vector3): Promise<void>;
  * @deprecated - Use gotoModel instead
  */
 declare function goTo3dx(objectId: number): Promise<void>;
-declare function goToModel(objectId: number): Promise<void>;
+declare function goToModel(objectId: number, iframeId?: string): Promise<void>;
 declare function goToParticipant(participantId: number): Promise<void>;
-declare function goToPosition(pos: Vector3): Promise<MpSdk.Vector3>;
+declare function goToPosition(pos: Vector3, iframeId?: string): Promise<MpSdk.Vector3>;
 declare function showMinimap(): void;
 declare function hideMinimap(): void;
 declare function getMapConfig(): IMapConfig;
@@ -650,6 +695,10 @@ declare function dispatchSpaceEvent(eventType: SPACE_EVENTS | string, payload?:
  * @returns
  */
 declare function registerCustomSpaceEvent(eventType: string | Array<string>): void;
+/**
+ * Clears the space event queue
+ */
+declare function clearSpaceEventQueue(): void;
 declare function initSocketIo(meetingId?: string, role?: IO_ROLE): void;
 declare function socketEmit(payload: {
     socketEvent: IO_SPACE_EVENTS | IO_MEETING_EVENTS;
@@ -693,4 +742,14 @@ declare function getPathBetweenSweeps(startSweepId: string, endSweepId: string,
     }[];
 }>;
 declare function moveAlongPath(path: any[], iframeId: any, transitionTime?: number): Promise<void>;
-export { _atwin, _config, _mpConfig, tags, sweeps, selectedObject, previousObjTransform, currentObjTransform, actionHistory, state, _tags, _tagCategories, _tagMessageRecepients, _space, _spaceId, _api, _pointerCoord, _3DXObjects, _meetingParticipants, _generatedObjectIds, tagColors, domMousePosition, isFitScreenOccupied, isCdnMapDataAvailable, minimap, _modelDetails, _onMouseClickInstance, transformHistory, _partitionNodes, initAtwinApi, getAtwinSdk, connectSpace, disconnectSpace, clearActionHistory, getSweeps, getCurrentSweep, getCurrentSweepPosition, moveToSweep, getNearbySweeps, getAllSweeps, getCurrentCameraPose, getCurrentCameraZoom, getCameraPosition, getCurrentFloor, moveInDirection, cameraLookAt, cameraPan, cameraRotate, cameraSetRotation, getViewMode, setViewMode, captureSpaceScreenshot, captureScreenshotAndCameraDetails, getNearbyObjects, setTransformMode, setSelectedObject, clearSelectedObject, revertTransform, setTransformControls, removeTransformControls, setRenderDistance, addObject, getObject, addObjectToSpace, addMediaScreen, attachMediaScreenContent, updateObject, updateShowcaseObject, deleteObject, deleteShowcaseObject, copyObject, replaceObject, getTargetPosition, setObjectTransformation, setPointerCoordinates, addTextMarkupScreen, setTextMarkupScreenContent, goTo3dx, goToModel, hasTimeElapsed, getSelectedObject, renderAvatar, setSpaceAvatar, get3DXObjects, setLibrary, getLibrary, disposeModel, renderInSpaceMediaScreen, goToPosition, goToParticipant, getNearestSweepFromObject, cancelModelPlacement, renderViewpointMarker, toggleViewpointVisibility, convertDegRotationToEuler, isToolbarFeatureEnabled, pauseVideo, playVideo, setVideoPlayback, setAnimationState, showMinimap, hideMinimap, getMapConfig, addTag, getTags, gotoTag, renderTag, disposeTag, disposeTags, getMpTags, getMpTag, showTags, attachTagMedia, detachTagMedia, moveTag, editTagLabel, editTagDescription, editTagStem, editTagIcon, editTagColor, saveTag, rotateCameraToObject, setModelVisibility, tagStateSubscriber, setTagIcon, setTagCategories, setUserAssignedCategories, getUserAssignedCategories, setTagMessageRecepients, getTagMessageRecepients, setTagMessages, getTagMessages, setSelectedTagUuid, getSelectedTagUuid, setCurrentSpace, toggleFitToScreen, getFloors, getLabels, renderMeetingSidebar, createMeetingTemplate, joinMeetingTemplate, meet, dispatchSpaceEvent, subscribeSpaceEvent, unsubscribeSpaceEvent, registerCustomSpaceEvent, initSocketIo, socketEmit, getParticipants, followParticipant, unFollowParticipant, enableHUD, disableHUD, getMediaScreenHUDs, canSetHud, saveMediaScreenHud, removeMediaScreenHud, enableFitScreen, disableFitScreen, initToolbarUI, themeManager, convertToEuler, disableSweeps, enableSweep, disableSweep, tubeLineType, _sceneObject, _tubes, drawPath, toggleSpaceNavigation, startDraw, exitDraw, cancelDraw, setPolygonPath, setTubeLinePath, getCurrentTubeLine, renderPolygon, toggleWallVisibility, toggleMeshChildrenVisibility, toggleFloorVisibility, getChildrenOfModel, toggleVerticeRingVisibility, setPolygonFloorOffset, getPolygonFloorOffset, setFloorBaseHeight, clearFloorBaseHeight, enableVerticeControls, deleteEdge, disposePathLine, getFloorBaseHeight, setMeshChildrenMaterialProperty, undoDrawAction, redoDrawAction, addUndoDrawActions, setWallBaseHeight, getWallBaseHeight, clearWallBaseHeight, setSpacePartitionNodes, setCurrentPolygon, getSpaceId, getCurrentPolygon, getPathBetweenSweeps, moveAlongPath, _atwinConnections, convertZupToYup, convertYupToZup };
+/**
+ * Set the space meta data variable
+ * @param payload
+ */
+declare function setSpaceMetadata(payload: SpaceMetadata | null): void;
+/**
+ * Returns the value of the space meta data
+ * @returns
+ */
+declare function getSpaceMetadata(): SpaceMetadata;
+export { _atwin, _config, _mpConfig, tags, sweeps, selectedObject, previousObjTransform, currentObjTransform, actionHistory, state, _tags, _tagCategories, _tagMessageRecepients, _space, _spaceId, _api, _pointerCoord, _3DXObjects, _meetingParticipants, _generatedObjectIds, tagColors, domMousePosition, isFitScreenOccupied, isCdnMapDataAvailable, minimap, _modelDetails, _onMouseClickInstance, transformHistory, _partitionNodes, initAtwinApi, getAtwinSdk, connectSpace, disconnectSpace, clearActionHistory, getSweeps, getCurrentSweep, getCurrentSweepPosition, moveToSweep, getNearbySweeps, getAllSweeps, getCurrentCameraPose, getCurrentCameraZoom, getCameraPosition, getCurrentFloor, moveInDirection, cameraLookAt, cameraPan, cameraRotate, cameraSetRotation, getViewMode, setViewMode, captureSpaceScreenshot, captureScreenshotAndCameraDetails, captureCurrentView, cameraZoomBy, cameraZoomReset, cameraZoomTo, getNearbyObjects, setTransformMode, setSelectedObject, clearSelectedObject, revertTransform, setTransformControls, removeTransformControls, setRenderDistance, addObject, getObject, addObjectToSpace, addMediaScreen, attachMediaScreenContent, updateObject, updateShowcaseObject, deleteObject, deleteShowcaseObject, copyObject, replaceObject, getTargetPosition, setObjectTransformation, setPointerCoordinates, addTextMarkupScreen, setTextMarkupScreenContent, goTo3dx, goToModel, hasTimeElapsed, getSelectedObject, renderAvatar, setSpaceAvatar, get3DXObjects, clear3DXObjects, setLibrary, getLibrary, disposeModel, disposeAllModels, renderInSpaceMediaScreen, goToPosition, goToParticipant, getNearestSweepFromObject, cancelModelPlacement, renderViewpointMarker, toggleViewpointVisibility, convertDegRotationToEuler, isToolbarFeatureEnabled, goToMPOrigin, pauseVideo, playVideo, setVideoPlayback, setAnimationState, showMinimap, hideMinimap, getMapConfig, addTag, getTags, gotoTag, renderTag, disposeTag, disposeTags, getMpTags, getMpTag, showTags, attachTagMedia, detachTagMedia, moveTag, editTagLabel, editTagDescription, editTagStem, editTagIcon, editTagColor, saveTag, rotateCameraToObject, setModelVisibility, tagStateSubscriber, setTagIcon, setTagCategories, setUserAssignedCategories, getUserAssignedCategories, setTagMessageRecepients, getTagMessageRecepients, setTagMessages, getTagMessages, setSelectedTagUuid, getSelectedTagUuid, setCurrentSpace, toggleFitToScreen, getFloors, getLabels, renderMeetingSidebar, createMeetingTemplate, joinMeetingTemplate, meet, dispatchSpaceEvent, subscribeSpaceEvent, unsubscribeSpaceEvent, registerCustomSpaceEvent, clearSpaceEventQueue, initSocketIo, socketEmit, getParticipants, followParticipant, unFollowParticipant, enableHUD, disableHUD, getMediaScreenHUDs, canSetHud, saveMediaScreenHud, removeMediaScreenHud, enableFitScreen, disableFitScreen, initToolbarUI, themeManager, convertToEuler, disableSweeps, enableSweep, disableSweep, tubeLineType, _sceneObject, _tubes, drawPath, toggleSpaceNavigation, startDraw, exitDraw, cancelDraw, setPolygonPath, setTubeLinePath, getCurrentTubeLine, renderPolygon, toggleWallVisibility, toggleMeshChildrenVisibility, toggleFloorVisibility, getChildrenOfModel, toggleVerticeRingVisibility, setPolygonFloorOffset, getPolygonFloorOffset, setFloorBaseHeight, clearFloorBaseHeight, enableVerticeControls, deleteEdge, disposePathLine, getFloorBaseHeight, setMeshChildrenMaterialProperty, undoDrawAction, redoDrawAction, addUndoDrawActions, setWallBaseHeight, getWallBaseHeight, clearWallBaseHeight, setSpacePartitionNodes, setCurrentPolygon, getSpaceId, getCurrentPolygon, getPathBetweenSweeps, moveAlongPath, _atwinConnections, convertZupToYup, convertYupToZup, getRelativePosition, getOriginalWorldPosition, setSpaceMetadata, getSpaceMetadata };