architwin 1.12.5 → 1.13.0

package/CORE_FEATURES.md

@@ -0,0 +1,35 @@
+# ArchiTwin Library Core Features
+
+This document outlines the core features of the ArchiTwin library, a powerful tool that enhances the Matterport Bundle SDK with additional features and a ready-to-use UI.
+
+## 1. Matterport Bundle SDK Enhancement
+
+The ArchiTwin library simplifies the development process by providing pre-built methods for interacting with the Matterport SDK. It offers a comprehensive solution for developers working with the Matterport SDK, offering both a robust API and a user-friendly interface.
+
+## 2. Zoom SDK Integration
+
+The library provides pre-built methods for interacting with the Zoom SDK, allowing you to easily integrate video conferencing features into your application.
+
+## 3. Custom Three.js Loaders
+
+The library includes custom Three.js loaders for Matterport, enabling advanced 3D object manipulation. This allows you to create more immersive and interactive experiences for your users.
+
+## 4. Space Navigation and Camera Control
+
+The library provides methods for navigating around the space and controlling the camera. This allows you to create custom navigation experiences for your users.
+
+## 5. Points of Interest
+
+The library allows you to add, remove, and customize tags, as well as access a list of rendered objects and their structure. This allows you to create interactive and informative experiences for your users.
+
+## 6. Object Transformation
+
+The library provides methods for transforming objects, including translating, scaling, and rotating them. This allows you to create dynamic and interactive experiences for your users.
+
+## 7. Media Screens
+
+The library allows you to create customizable media screens that can display images or videos. This allows you to create rich and engaging experiences for your users.
+
+## 8. Meeting UI
+
+The library provides a set of methods to create, start, and stop meetings. This allows you to easily integrate video conferencing features into your application.

package/lib/architwin.d.ts

@@ -1,9 +1,9 @@
 import { AxiosInstance } from "axios";
 import { MpSdk, Scene, Vector3, Vector2, Renderer } from "../bundle/sdk";
-import { tubeLineType } from "./loaders";
+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 } 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, PathConfig, ModelPayload, IPipeCategory, IPipe } from "./types";
 import * as minimap from './minimap';
 import '../static/sidebar.css';
 import '../static/map.css';
@@ -58,6 +58,10 @@ declare let _modelDetails: MpSdk.Model.ModelDetails;
 declare const tagColors: string[];
 declare let _tubes: MpSdk.Scene.IObject;
 declare let _partitionNodes: PartitionNode[];
+declare let _pipeCategories: IPipeCategory[];
+declare let _selectedPipeCategory: IPipeCategory;
+declare let _pipes: IPipe[];
+declare let _selectedPipe: IPipe;
 /**
  * Initializes the axios API instance. Use this if you want to make an API call using the library without
  * invoking the connectSpace method
@@ -263,12 +267,19 @@ declare function getTargetPosition(callback?: Function, continousClick?: boolean
  */
 declare function cancelModelPlacement(): Promise<void>;
 declare function setPointerCoordinates(position: Vector3): void;
+/**
+ * Renders a 3D model into the space.
+ * @param {ModelPayload} payload
+ * @returns {Promise<IShowcaseObject>}
+ */
+declare function renderModel(payload: ModelPayload): Promise<IShowcaseObject>;
 /**
  * Reusable method that adds an object to the space locally.
  * @param {string} mediaUrl - The url pointing to the model/media resource
  * @param {string} objectType - The file type of the object
  * @param {ObjectConfig} config - Object that contains the configuration for the object to be rendered like
  * position, rotation, and scale to name an example
+ * @deprecated - Use renderModel instead
  * @returns {Promise<IShowcaseObject>}
  */
 declare function addObjectToSpace(mediaUrl: string, objectType: string, config?: ObjectConfig, object_data?: I3DObject): Promise<IShowcaseObject>;
@@ -464,10 +475,18 @@ declare function toggleSpaceNavigation(state?: boolean): void;
 /**
  * Draws a semi transparent tube line along a path
  * @param {Array<Vector3>} vertices - Array of coordinates or vertices
+ * @deprecated - Use renderPath instead to render a path and setPathLine to update an existing path
  * @returns
  */
 declare function drawPath(vertices: Array<Vector3>, options?: ComponentOptions): Promise<void>;
-declare function setTubeLinePath(id: number, path: Array<Vector3>): void;
+declare function setPathLine(id: number, path: Array<Vector3>): void;
+/**
+ * Update the inputs of a rendered path line
+ * @param id - id of the object/path
+ * @param {ComponentOptions} options - keys you want to update, you should only populate keys that you explicitly wanted to update
+ * @returns
+ */
+declare function setPathLineOptions(id: number, options: ComponentOptions): void;
 /**
  * Destroys the current path line instance
  * @param payload
@@ -478,6 +497,13 @@ declare function disposePathLine(): void;
  * @returns
  */
 declare function getCurrentTubeLine(): IObjectData;
+/**
+ * Renders a 3D path in the space, the path can display any valid ASCII value and display it as an animated value that follows along the line.
+ * @param vertices - array of xyz coordinates
+ * @param options - customization options to dictate the look and behavior of the path
+ * @returns
+ */
+declare function renderPath(vertices: Array<Vector3>, options?: ComponentOptions): void;
 /**
  * Renders a polygon from an array of coordinates or an object containing an array of coordinates
  * @param {PartitionPayload|Array<Vector3>} payload
@@ -492,6 +518,12 @@ declare function renderPolygon(payload: PartitionPayload | Array<Vector3>, optio
  * @returns {void}
  */
 declare function setPolygonPath(id: number, vertices: Array<Vector3>): void;
+/**
+ * Removes a vertex sphere from the space. If no argument is passed it will remove the last vertex that has been added
+ * @param {number} index - (optional) Index of an element of vertex path
+ * @returns
+ */
+declare function deleteVertex(index?: number): void;
 /**
  * Enables vertice controls on an existing polygon
  * @param component
@@ -505,7 +537,18 @@ declare function enableVerticeControls(component: MpSdk.Scene.IComponent): void;
  * @returns
  */
 declare function deleteEdge(component: MpSdk.Scene.IComponent, endPoint: Vector3): void;
-declare function startDraw(): void;
+/**
+ * Configure the loader to be used for the vertice and path of the drawing system. You can also pass different customization options for both path and vertex compnents.
+ * You only need to run this once unless you intend to switch the configuration again.
+ * @param {PathConfig} config - Configuration to be used by the drawing system
+ * @returns
+ */
+declare function setDrawingConfig(config: PathConfig): void;
+/**
+ * Resets the configuration for the drawing system to its defaults
+ */
+declare function resetDrawingConfig(): void;
+declare function startDraw(config?: PathConfig): void;
 declare function exitDraw(): void;
 declare function cancelDraw(): void;
 declare function setCurrentPolygon(polygonData: IObjectData): void;
@@ -762,4 +805,52 @@ declare function setSpaceMetadata(payload: SpaceMetadata | null): void;
  * @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, 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, _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, getAssetUrl };
+/**
+ * Set pipes categories value
+ * @param {IPipeCategory[]} pipes
+ * @returns
+ */
+declare function setPipeCategories(pipes: IPipeCategory[]): IPipeCategory[];
+/**
+ * Set selected pipes catrgory value
+ * @param {IPipeCategory} pipe
+ * @returns
+ */
+declare function setSelectedPipeCategory(pipe: IPipeCategory): IPipeCategory;
+/**
+ * Gets the current pipe category for the pipe form.
+ *
+ * @returns - The current category.
+ */
+declare function getSelectedPipeCategory(): IPipeCategory;
+/**
+* Set pipes value
+* @param {IPipe[]} pipes
+* @returns
+*/
+declare function setPipes(pipes: IPipe[]): IPipe[];
+/**
+ * Set selected pipes value
+ * @param {IPipe} pipe
+ * @returns
+ */
+declare function setSelectedPipe(pipe: IPipe): IPipe;
+/**
+ * Gets the current pipe for the pipe form.
+ *
+ * @returns - The current pipe.
+ */
+declare function getSelectedPipe(): IPipe;
+/**
+* Set selected pipes value
+* @param {Boolean} status
+* @returns
+*/
+declare function setPipeIsDrawingMode(status: Boolean): Boolean;
+/**
+ * Gets the current pipe for the pipe form.
+ *
+ * @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, 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 };