architwin 1.13.11 → 1.14.1

package/lib/architwin.d.ts

@@ -3,7 +3,7 @@ import { MpSdk, Scene, Vector3, Vector2, Renderer } from "../bundle/sdk";
 import { tubeLineType, pathLineType } from "./loaders";
 import { getAssetUrl } from "./utils";
 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, SpaceMetadata, IObjectFilters, PathConfig, ModelPayload, IPipeCategory, IPipe } 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, IObjectFilters, ScreenShareUser, PathConfig, ModelPayload, IPipeCategory, IPipe } from "./types";
 import * as minimap from './minimap';
 import '../static/sidebar.css';
 import '../static/map.css';
@@ -13,6 +13,7 @@ import { ActionHistory } from "./actionHistory";
 import * as meet from './zoom';
 import 'notyf/notyf.min.css';
 import { convertYupToZup, convertZupToYup, getRelativePosition, getOriginalWorldPosition } from "./worldConversion";
+import { removeScreenShareSessionData } from "./atwinui/components/toolbar/screenSharePane";
 declare const transformHistory: ActionHistory;
 declare const _config: {
     mp: {
@@ -61,6 +62,10 @@ _redoDrawActions: any[];
 declare let _tubes: MpSdk.Scene.IObject;
 declare let _pathConfig: PathConfig;
 declare let _partitionNodes: PartitionNode[];
+declare let _currentSpace: any;
+declare let _spaceUsers: ScreenShareUser[];
+declare let _screenSharingHostUser: ScreenShareUser;
+declare let _screenSharingParticipantUsers: ScreenShareUser[];
 declare let _pipeCategories: IPipeCategory[];
 declare let _selectedPipeCategory: IPipeCategory;
 declare let _pipes: IPipe[];
@@ -135,7 +140,8 @@ declare function getAllSweeps(): {
 }[];
 declare function moveToSweep(sweepId: string, rotation?: Vector2, iframeId?: string): Promise<void>;
 declare function getNearbySweeps(sweepId: string): Promise<any>;
-declare function disableSweeps(iframeId?: string): Promise<void>;
+declare function disableSweeps(sweeps?: ISweep[], iframeId?: string): Promise<void>;
+declare function enableSweeps(sweeps?: ISweep[], iframeId?: string): Promise<void>;
 /**
  * Enables the current or an array of sweeps
  * @param sweepIds (optional) - If not set, will enable or disable the current sweep
@@ -669,6 +675,16 @@ declare function detachTagMedia(payload: {
     attachmentIds: string[];
 }): Promise<void>;
 declare function moveTag(tagId: string, callback?: Function): Promise<void>;
+declare function registerSandbox(payload: {
+    content: string;
+    options?: Partial<MpSdk.Tag.SandboxOptions>;
+    iframeId?: string;
+}): Promise<[sandboxId: string, messenger: MpSdk.Tag.IMessenger]>;
+declare function attachSandbox(payload: {
+    sandboxId: string;
+    tagIds: string[];
+    iframeId?: string;
+}): Promise<void>;
 declare function editTagLabel(payload: {
     tagId: string;
     label: string;
@@ -721,7 +737,7 @@ declare function setTagMessages(messages: Array<TagMessage>): void;
 declare function getTagMessages(): Array<TagMessage>;
 declare function setSelectedTagUuid(uuid: string): void;
 declare function getSelectedTagUuid(): string;
-declare function setCurrentSpace(space: ICurrentSpace): void;
+declare function setCurrentSpace(space: ICurrentSpace): any;
 declare function renderMeetingSidebar(template?: string, templateName?: MEETING_SIDEBAR): void;
 /**
  * Subscribes a method or an array of methods to a Matterport event.
@@ -808,6 +824,41 @@ declare function setSpaceMetadata(payload: SpaceMetadata | null): void;
  * @returns
  */
 declare function getSpaceMetadata(): SpaceMetadata;
+/**
+ * Set value to screen sharing host user
+ * @param {ScreenShareUser | null} user
+ * @returns
+ */
+declare function setScreenSharingHostUser(user: ScreenShareUser | null): ScreenShareUser;
+/**
+ * Set value to screen sharing participant users
+ * @param {ScreenShareUser[]} users
+ * @returns
+ */
+declare function setScreenSharingParticipantUsers(users: ScreenShareUser[]): ScreenShareUser[];
+/**
+ * Update the texture of the pointer reticle using a registered texture ID.
+ * Defaults to 'targetPointer' if no ID is provided.
+ * @param {string} [textureId] - Optional texture ID to apply to the pointer, if equal to 'resetTexture' it will reset texture
+ * @returns {Promise<void>}
+ */
+declare function updatePointerTexture(textureId?: string): Promise<void>;
+/**
+ * Syncs an object's position and rotation to align with a pointer intersection surface.
+ * If an object is provided, its transformation is updated. Otherwise, a new marker is added at the intersection point.
+ *
+ * @param {MpSdk.Pointer.Intersection} pointerIntersection - The pointer intersection from Matterport SDK
+ * @param {IObjectData} [_object] - Optional object to transform
+ * @param {string} [markerTexture] - Optional texture URL for a new marker
+ * @returns {Promise<IShowcaseObject | void>} - Returns the new object if created, otherwise void
+ */
+declare const renderCursorMarkerPointer: (pointerIntersection: MpSdk.Pointer.Intersection, _object?: IObjectData, markerTexture?: string) => Promise<IShowcaseObject>;
+/**
+ * Toggles the visibility of an HTML element by its ID.
+ * @param {string} id - The ID of the HTML element to be shown or hidden.
+ * @param {boolean} shouldShow - Boolean flag to show (true) or hide (false) the element.
+ */
+declare function toggleElementVisibility(id: string, shouldShow: boolean): void;
 /**
  * Set pipes categories value
  * @param {IPipeCategory[]} pipes
@@ -862,4 +913,10 @@ declare function setVertexPath(path: Vector2[]): void;
  * @returns - The current pipe.
  */
 declare function getPipeIsDrawingMode(): Boolean;
-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, _undoDrawActions, _redoDrawActions, 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, renderModel, 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, getTagDataCollection, 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, pathLineType, _sceneObject, _tubes, drawPath, toggleSpaceNavigation, startDraw, exitDraw, cancelDraw, setPolygonPath, setPathLine, setPathLineOptions, 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, getAssetUrl, renderPath, setDrawingConfig, resetDrawingConfig, _pipeCategories, _selectedPipeCategory, setPipeCategories, setSelectedPipeCategory, getSelectedPipeCategory, _pipes, _selectedPipe, setPipes, setSelectedPipe, getSelectedPipe, deleteVertex, setPipeIsDrawingMode, getPipeIsDrawingMode, setVertexPath, _pathConfig };
+/**
+ * Sets whether the screen sharing pointer is enabled
+ * @param value boolean
+ * @returns void
+ * */
+declare function setPointerEnabled(value: boolean): 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, _currentSpace, _spaceUsers, _screenSharingHostUser, _screenSharingParticipantUsers, _undoDrawActions, _redoDrawActions, 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, renderModel, 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, getTagDataCollection, getMpTag, showTags, attachTagMedia, detachTagMedia, moveTag, editTagLabel, editTagDescription, editTagStem, editTagIcon, editTagColor, attachSandbox, registerSandbox, 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, enableSweeps, enableSweep, disableSweep, tubeLineType, pathLineType, _sceneObject, _tubes, drawPath, toggleSpaceNavigation, startDraw, exitDraw, cancelDraw, setPolygonPath, setPathLine, setPathLineOptions, 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, getAssetUrl, setScreenSharingHostUser, setScreenSharingParticipantUsers, renderCursorMarkerPointer, updatePointerTexture, toggleElementVisibility, renderPath, setDrawingConfig, resetDrawingConfig, _pipeCategories, _selectedPipeCategory, setPipeCategories, setSelectedPipeCategory, getSelectedPipeCategory, _pipes, _selectedPipe, setPipes, setSelectedPipe, getSelectedPipe, deleteVertex, setPipeIsDrawingMode, getPipeIsDrawingMode, setPointerEnabled, removeScreenShareSessionData, setVertexPath, _pathConfig };