architwin 1.4.6 → 1.4.8

package/README.md

@@ -4690,13 +4690,9 @@ This function captures a screenshot of a virtual space and retrieves details abo
 
 *Function Signature*
 ```typescript
-function captureScreenshotAndCameraDetails(
-  callback?: Function | null, 
-  resolution?: Renderer.Resolution, 
-  visibility?: Renderer.Visibility): Promise<{
+function captureScreenshotAndCameraDetails(callback?: Function | null, resolution?: Renderer.Resolution, visibility?: Renderer.Visibility, iframeId?: string): Promise<{
     base64Screenshot: string;
-    cameraPosition: MpSdk.Vector3;
-    cameraRotation: MpSdk.Vector2;
+    cameraPose: MpSdk.Camera.Pose;
 }>
 ```
 
@@ -4706,6 +4702,7 @@ function captureScreenshotAndCameraDetails(
 | callback | Function | optional |  | |
 | resolution | Renderer.Resolution | optional | { width : 1920, height : 1080 }  | { width : 600, height : 800 } or any values exceed to 4096 |
 | visibility | Renderer.Visbility | optional | { mattertags : false, measurements : false, sweeps: false, views : false }  | {mattertags : true, measurements : false, sweeps: false, views : true}   |
+| iframeId | string | optional |  | |
 
 *Example:*
 ```typescript
@@ -4733,6 +4730,10 @@ async function captureScreenshotAndCameraDetails() {
   // Without Parameters
   const screenshotDetails = await atwin.captureScreenshotAndCameraDetails();
   log.info("Screenshot Details: ", screenshotDetails)
+
+  // With iframe id
+  const screenshotDetails = await atwin.captureScreenshotAndCameraDetails(iframeId: 'iframe-id');
+  log.info("Screenshot Details: ", screenshotDetails)
 }
 ```
 

package/lib/architwin.d.ts

@@ -1,7 +1,7 @@
 import { AxiosInstance } from "axios";
 import { MpSdk, Scene, Vector3, Vector2, Renderer } from "../bundle/sdk";
 import { initToolbarUI } 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, 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 } from "./types";
 import * as minimap from './minimap';
 import '../static/sidebar.css';
 import '../static/map.css';
@@ -46,7 +46,7 @@ declare let state: State;
 declare let domMousePosition: Vector3;
 declare let isFitScreenOccupied: boolean;
 declare let isCdnMapDataAvailable: boolean;
-declare let _atwinSdks: Array<MpSdk>;
+declare let _onMouseClickInstance: any;
 declare let _modelDetails: MpSdk.Model.ModelDetails;
 declare const tagColors: string[];
 /**
@@ -71,7 +71,7 @@ declare function connectSpace(url: string, auth: {
     onLoad: Function;
     onStart: Function;
     onPlay: Function;
-}): Promise<MpSdk>;
+}): Promise<void>;
 declare function getAtwinSdk(): MpSdk | null;
 declare function getFloors(): IAtwinFloor[];
 declare function getLabels(): IAtwinLabel[];
@@ -110,7 +110,7 @@ declare function getAllSweeps(): {
     position: Vector3;
     neighbors: string[];
 }[];
-declare function moveToSweep(sweepId: string, rotation?: Vector2, sdk?: MpSdk): Promise<void>;
+declare function moveToSweep(sweepId: string, rotation?: Vector2, iframeId?: string): Promise<void>;
 declare function getNearbySweeps(sweepId: string): Promise<any>;
 /**
  * Stores the selected object captured by the ClickSpy class attached to the object upon creation in
@@ -160,12 +160,12 @@ declare function captureSpaceScreenshot(callback?: Function | null, resolution?:
  * @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 Object with screenshot and camera details.
  */
-declare function captureScreenshotAndCameraDetails(callback?: Function | null, resolution?: Renderer.Resolution, visibility?: Renderer.Visibility): Promise<{
+declare function captureScreenshotAndCameraDetails(callback?: Function | null, resolution?: Renderer.Resolution, visibility?: Renderer.Visibility, iframeId?: string): Promise<{
     base64Screenshot: string;
-    cameraPosition: MpSdk.Vector3;
-    cameraRotation: MpSdk.Vector2;
+    cameraPose: MpSdk.Camera.Pose;
 }>;
 /**
  * Moves the camera position in the direction of the argument provided.
@@ -215,7 +215,16 @@ declare function setSpaceAvatar(avatar: {
  * @param position - x,y,z position of the anchor of the marker
  * @param rotation - (optional) x,y,z rotation of the anchor
  */
-declare function renderViewpointMarker(position: Vector3, rotation?: Vector3): Promise<void>;
+declare function renderViewpointMarker(transform: {
+    position: Vector3;
+    rotation?: Vector3;
+}, options?: ComponentOptions): Promise<void>;
+/**
+ * Toggle the visibility of a single, group, or all viewpoints. This method requires the object id of the viewpoint
+ * @param {number|Array<number>} viewpointIds - (optional) Pass as single or an array of ids of the viewpoints. If undefined will toggle all viewpoints' visibility instead
+ * @returns
+ */
+declare function toggleViewpointVisibility(viewpointIds?: number | Array<number>): void;
 /**
  * Creates a copy of an object in the 3D space. You can specify a custom offset position and rotation of the cloned object
  * @param payload The object that you want to duplicate
@@ -259,16 +268,17 @@ declare function attachMediaScreenContent(mediaScreenId: number, mediaUrl: strin
  * Controls video media displayed on an HTML video element, works on videos used as textures for meshes
  * @param action Playback function, accepts play,pause,mute,unmute
  * @param element HTML video element
+ * @param objectId id of the object
  * @returns
  */
-declare function setVideoPlayback(action: string, element: HTMLVideoElement, objectId?: number): void;
+declare function setVideoPlayback(action: string, element: HTMLVideoElement | undefined, objectId: number, isMediascreenDocked?: boolean): void;
 /**
  * Set a model's visibility
  * @param id - Object id
  * @param visible - true or false
  * @returns
  */
-declare function setModelVisibility(id: number, visible: boolean): void;
+declare function setModelVisibility(id: number, visible?: boolean): void;
 /**
  * Toggles the display position of a media screen.
  * @param {string} id - The id of the media screen model
@@ -493,4 +503,4 @@ 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, _atwinSdks, minimap, _modelDetails, initAtwinApi, getAtwinSdk, connectSpace, disconnectSpace, clearActionHistory, getSweeps, getCurrentSweep, getCurrentSweepPosition, moveToSweep, getNearbySweeps, getAllSweeps, getCurrentCameraPose, getCameraPosition, moveInDirection, cameraLookAt, cameraPan, cameraRotate, 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, 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, isMeetingInitialized, getMeetingParticipants, createMeeting, startMeeting, stopMeeting, generateMeetingURL, updateMeetingTitle, updateMeetingStart, updateMeetingStatus, updateMeetingSpace, getMeeting, getSpaceMeetings, isMeetingExists, isMeetingActive, initSocketIo, socketEmit, getParticipants, followParticipant, unFollowParticipant, enableHUD, disableHUD, getMediaScreenHUDs, canSetHud, saveMediaScreenHud, removeMediaScreenHud, enableFitScreen, disableFitScreen, initToolbarUI, convertToEuler };
+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, initAtwinApi, getAtwinSdk, connectSpace, disconnectSpace, clearActionHistory, getSweeps, getCurrentSweep, getCurrentSweepPosition, moveToSweep, getNearbySweeps, getAllSweeps, getCurrentCameraPose, getCameraPosition, moveInDirection, cameraLookAt, cameraPan, cameraRotate, 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, 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, isMeetingInitialized, getMeetingParticipants, createMeeting, startMeeting, stopMeeting, generateMeetingURL, updateMeetingTitle, updateMeetingStart, updateMeetingStatus, updateMeetingSpace, getMeeting, getSpaceMeetings, isMeetingExists, isMeetingActive, initSocketIo, socketEmit, getParticipants, followParticipant, unFollowParticipant, enableHUD, disableHUD, getMediaScreenHUDs, canSetHud, saveMediaScreenHud, removeMediaScreenHud, enableFitScreen, disableFitScreen, initToolbarUI, convertToEuler };