architwin 1.8.2 → 1.8.3

package/README.md

@@ -179,6 +179,7 @@ ArchiTwin Library
       - [setupMeetingSession()](#setupMeetingSession)
       - [sendCommand()](#sendCommand)
       - [attachParticipantVideo()](#attachParticipantVideo)
+      - [setAvatarMeetingImage()](#setAvatarMeetingImage)
     - [Viewpoint](#viewpoint)
       - [renderViewpointMarker()](#renderViewpointMarker)
       - [toggleViewpointVisibility()](#toggleViewpointVisibility)
@@ -6478,6 +6479,26 @@ import * as atwin from 'architwin'
 await atwin.meet.attachParticipantVideo(userId)
 ````
 
+### setAvatarMeetingImage()
+This function will set the avatar image source link to the current user
+
+*Function Signature*
+```typescript
+async function setAvatarMeetingImage(avatarSrc: string): Promise<void>
+```
+
+*Parameter Table*
+| parameter | type | required | default | values |
+| :----: | :----: | :---: | :---: | :---: |
+| avatarSrc | string | yes | null  | Avatar image source link |
+
+*Example:*
+````typescript
+import * as atwin from 'architwin'
+
+await atwin.meet.setAvatarMeetingImage(avatarSrc)
+````
+
 ## Viewpoint
 
 Viewpoints are pointers composed of a 2 dimensional line and a 2D marker at the opposite that can be used to act as markers of where a user or object is looking at. This can be especially useful for if you plan on implementing multiplayer functionalities in your space. The next few sections will explain how you can render, customize, and manipulate viewpoints.

package/lib/architwin.d.ts

@@ -1,7 +1,8 @@
 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 } 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, RoomNode, PartitionPayload } from "./types";
 import * as minimap from './minimap';
 import '../static/sidebar.css';
 import '../static/map.css';
@@ -41,6 +42,7 @@ declare let selectedObject: IObjectData;
 declare let previousObjTransform: Object3DPosition;
 declare let currentObjTransform: Object3DPosition;
 declare let actionHistory: Array<string>;
+declare let _sceneObject: Scene.IObject;
 declare let _pointerCoord: Vector3;
 declare let _generatedObjectIds: number[];
 declare let state: State;
@@ -50,6 +52,8 @@ declare let isCdnMapDataAvailable: boolean;
 declare let _onMouseClickInstance: any;
 declare let _modelDetails: MpSdk.Model.ModelDetails;
 declare const tagColors: string[];
+declare let _tubes: MpSdk.Scene.IObject;
+declare let _roomNodes: RoomNode[];
 /**
  * Initializes the axios API instance. Use this if you want to make an API call using the library without
  * invoking the connectSpace method
@@ -101,6 +105,7 @@ declare function setRenderDistance(distance: number): void;
  * @returns {void}
  */
 declare function setAnimationState(action: string, modelId: number): void;
+declare function getSpaceId(url: string): string;
 declare function getCurrentSweep(): ISweep;
 declare function getCurrentCameraPose(): MpSdk.Camera.Pose;
 declare function getCurrentCameraZoom(): MpSdk.Camera.ZoomData;
@@ -353,6 +358,7 @@ declare function updateShowcaseObject(payload: IShowcaseObject): Promise<IShowca
  * @param id - The object id of the object that needs to be updated
  * @param {FileUpload} payload - The payload that contains the file object information that will be used to update
  * @returns {Promise<I3DObject>}
+ * @deprecated - All non matterport api calls should be done in application side
  */
 declare function updateObject(id: number, payload: FileUpload): Promise<I3DObject>;
 /**
@@ -394,6 +400,42 @@ declare function goToPosition(pos: Vector3): Promise<MpSdk.Vector3>;
 declare function showMinimap(): void;
 declare function hideMinimap(): void;
 declare function getMapConfig(): IMapConfig;
+declare function toggleSpaceNavigation(state?: boolean): void;
+/**
+ * Draws a semi transparent tube line along a path
+ * @param {Array<Vector3>} vertices - Array of coordinates or vertices
+ * @returns
+ */
+declare function drawLine(vertices: Array<Vector3>, options?: ComponentOptions): Promise<void>;
+declare function setTubeLinePath(id: number, path: Array<Vector3>): void;
+/**
+ * Returms the current tube line and data instance
+ * @returns
+ */
+declare function getCurrentTubeLine(): IObjectData;
+/**
+ * Renders a polygon from an array of coordinates
+ * @param {Vector3} path - Array of coordinates
+ * @returns {void}
+ */
+declare function renderPolygonFromPath(path: Array<Vector3>): void;
+/**
+ * Renders a polygon from an array of coordinates or an object containing an array of coordinates
+ * @param {PartitionPayload|Array<Vector3>} payload
+ * @returns {void}
+ */
+declare function renderPolygon(payload: PartitionPayload | Array<Vector3>): IShowcaseObject;
+/**
+ * Updates the polygons by passing a new array of vertices. Do note that any vertex markers visible will not automatically update their position
+ * @param {number} id - id of the polygon object
+ * @param {Array<Vector3>} vertices - array of vertices that are used to render the geometry of the polygon
+ * @returns {void}
+ */
+declare function setPolygonPath(id: number, vertices: Array<Vector3>): void;
+declare function startDraw(): void;
+declare function exitDraw(): void;
+declare function cancelDraw(): void;
+declare function getCurrentPolygon(): IObjectData;
 declare function setTagIcon(payload: {
     tag: MpSdk.Tag.TagData;
     iconName: string;
@@ -532,4 +574,9 @@ declare function getMediaScreenHUDs(): {
 declare function getParticipants(): Promise<import("./types").IO_Participant[]>;
 declare function followParticipant(followParticipant: any): void;
 declare function unFollowParticipant(unFollowParticipant: any): 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, initAtwinApi, getAtwinSdk, connectSpace, disconnectSpace, clearActionHistory, getSweeps, getCurrentSweep, getCurrentSweepPosition, moveToSweep, getNearbySweeps, getAllSweeps, getCurrentCameraPose, getCurrentCameraZoom, getCameraPosition, 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, 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, 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, };
+/**
+ * Sets the space room nodes in the state
+ * @param roomNodes Array of room nodes
+ */
+declare function setSpaceRoomNodes(roomNodes: Array<RoomNode>): 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, _roomNodes, initAtwinApi, getAtwinSdk, connectSpace, disconnectSpace, clearActionHistory, getSweeps, getCurrentSweep, getCurrentSweepPosition, moveToSweep, getNearbySweeps, getAllSweeps, getCurrentCameraPose, getCurrentCameraZoom, getCameraPosition, 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, 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, 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, drawLine, renderPolygonFromPath, toggleSpaceNavigation, startDraw, exitDraw, cancelDraw, setPolygonPath, setTubeLinePath, getCurrentTubeLine, renderPolygon, setSpaceRoomNodes, getSpaceId, getCurrentPolygon };