architwin 1.4.6 → 1.4.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -4690,13 +4690,9 @@ This function captures a screenshot of a virtual space and retrieves details abo
4690
4690
 
4691
4691
  *Function Signature*
4692
4692
  ```typescript
4693
- function captureScreenshotAndCameraDetails(
4694
- callback?: Function | null,
4695
- resolution?: Renderer.Resolution,
4696
- visibility?: Renderer.Visibility): Promise<{
4693
+ function captureScreenshotAndCameraDetails(callback?: Function | null, resolution?: Renderer.Resolution, visibility?: Renderer.Visibility, iframeId?: string): Promise<{
4697
4694
  base64Screenshot: string;
4698
- cameraPosition: MpSdk.Vector3;
4699
- cameraRotation: MpSdk.Vector2;
4695
+ cameraPose: MpSdk.Camera.Pose;
4700
4696
  }>
4701
4697
  ```
4702
4698
 
@@ -4706,6 +4702,7 @@ function captureScreenshotAndCameraDetails(
4706
4702
  | callback | Function | optional | | |
4707
4703
  | resolution | Renderer.Resolution | optional | { width : 1920, height : 1080 } | { width : 600, height : 800 } or any values exceed to 4096 |
4708
4704
  | visibility | Renderer.Visbility | optional | { mattertags : false, measurements : false, sweeps: false, views : false } | {mattertags : true, measurements : false, sweeps: false, views : true} |
4705
+ | iframeId | string | optional | | |
4709
4706
 
4710
4707
  *Example:*
4711
4708
  ```typescript
@@ -4733,6 +4730,10 @@ async function captureScreenshotAndCameraDetails() {
4733
4730
  // Without Parameters
4734
4731
  const screenshotDetails = await atwin.captureScreenshotAndCameraDetails();
4735
4732
  log.info("Screenshot Details: ", screenshotDetails)
4733
+
4734
+ // With iframe id
4735
+ const screenshotDetails = await atwin.captureScreenshotAndCameraDetails(iframeId: 'iframe-id');
4736
+ log.info("Screenshot Details: ", screenshotDetails)
4736
4737
  }
4737
4738
  ```
4738
4739
 
@@ -46,7 +46,6 @@ declare let state: State;
46
46
  declare let domMousePosition: Vector3;
47
47
  declare let isFitScreenOccupied: boolean;
48
48
  declare let isCdnMapDataAvailable: boolean;
49
- declare let _atwinSdks: Array<MpSdk>;
50
49
  declare let _modelDetails: MpSdk.Model.ModelDetails;
51
50
  declare const tagColors: string[];
52
51
  /**
@@ -71,7 +70,7 @@ declare function connectSpace(url: string, auth: {
71
70
  onLoad: Function;
72
71
  onStart: Function;
73
72
  onPlay: Function;
74
- }): Promise<MpSdk>;
73
+ }): Promise<void>;
75
74
  declare function getAtwinSdk(): MpSdk | null;
76
75
  declare function getFloors(): IAtwinFloor[];
77
76
  declare function getLabels(): IAtwinLabel[];
@@ -110,7 +109,7 @@ declare function getAllSweeps(): {
110
109
  position: Vector3;
111
110
  neighbors: string[];
112
111
  }[];
113
- declare function moveToSweep(sweepId: string, rotation?: Vector2, sdk?: MpSdk): Promise<void>;
112
+ declare function moveToSweep(sweepId: string, rotation?: Vector2, iframeId?: string): Promise<void>;
114
113
  declare function getNearbySweeps(sweepId: string): Promise<any>;
115
114
  /**
116
115
  * Stores the selected object captured by the ClickSpy class attached to the object upon creation in
@@ -160,12 +159,12 @@ declare function captureSpaceScreenshot(callback?: Function | null, resolution?:
160
159
  * @param callback - Optional callback function.
161
160
  * @param resolution - Optional screenshot resolution. Default: { width: 1920, height: 1080 }.
162
161
  * @param visibility - Optional visibility settings. Default: { mattertags: false, measurements: false, sweeps: false, views: false }.
162
+ * @param iframeId - Optional id of iframe
163
163
  * @returns Object with screenshot and camera details.
164
164
  */
165
- declare function captureScreenshotAndCameraDetails(callback?: Function | null, resolution?: Renderer.Resolution, visibility?: Renderer.Visibility): Promise<{
165
+ declare function captureScreenshotAndCameraDetails(callback?: Function | null, resolution?: Renderer.Resolution, visibility?: Renderer.Visibility, iframeId?: string): Promise<{
166
166
  base64Screenshot: string;
167
- cameraPosition: MpSdk.Vector3;
168
- cameraRotation: MpSdk.Vector2;
167
+ cameraPose: MpSdk.Camera.Pose;
169
168
  }>;
170
169
  /**
171
170
  * Moves the camera position in the direction of the argument provided.
@@ -493,4 +492,4 @@ declare function getMediaScreenHUDs(): {
493
492
  declare function getParticipants(): Promise<import("./types").IO_Participant[]>;
494
493
  declare function followParticipant(followParticipant: any): void;
495
494
  declare function unFollowParticipant(unFollowParticipant: any): void;
496
- 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 };
495
+ 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, 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 };