architwin 1.12.4 → 1.13.0
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/CORE_FEATURES.md +35 -0
- package/ONBOARDING.md +115 -0
- package/lib/architwin.d.ts +98 -6
- package/lib/architwin.js +1 -1
- package/lib/atwinui/components/toolbar/collapse.d.ts +18 -0
- package/lib/atwinui/components/toolbar/collapse.js +62 -0
- package/lib/atwinui/components/toolbar/i18n.js +52 -2
- package/lib/atwinui/components/toolbar/index.js +11 -1
- package/lib/atwinui/components/toolbar/menuBar.d.ts +1 -0
- package/lib/atwinui/components/toolbar/menuBar.js +11 -0
- package/lib/atwinui/components/toolbar/pipeFormPane.d.ts +31 -0
- package/lib/atwinui/components/toolbar/pipeFormPane.js +545 -0
- package/lib/atwinui/components/toolbar/pipeListPane.d.ts +19 -0
- package/lib/atwinui/components/toolbar/pipeListPane.js +388 -0
- package/lib/atwinui/components/toolbar/spaceUserListPane.d.ts +3 -0
- package/lib/atwinui/components/toolbar/spaceUserListPane.js +95 -0
- package/lib/atwinui/components/toolbar/tagIotForm.d.ts +20 -0
- package/lib/atwinui/components/toolbar/tagIotForm.js +391 -0
- package/lib/atwinui/components/toolbar/tagIotFormPane.d.ts +62 -0
- package/lib/atwinui/components/toolbar/tagIotFormPane.js +606 -0
- package/lib/atwinui/components/toolbar/tagMessagingPane.d.ts +4 -0
- package/lib/atwinui/components/toolbar/tagMessagingPane.js +117 -10
- package/lib/atwinui/components/toolbar/usersPane.d.ts +14 -0
- package/lib/atwinui/components/toolbar/usersPane.js +273 -0
- package/lib/atwinui/components/toolbar/viewingRemoteSpace.d.ts +7 -0
- package/lib/atwinui/components/toolbar/viewingRemoteSpace.js +77 -0
- package/lib/atwinui/events.d.ts +4 -1
- package/lib/atwinui/events.js +106 -26
- package/lib/atwinui/helpers.d.ts +15 -0
- package/lib/atwinui/helpers.js +49 -0
- package/lib/atwinui/index.js +2 -0
- package/lib/loaders/curosrMarkerLoader.d.ts +25 -0
- package/lib/loaders/curosrMarkerLoader.js +86 -0
- package/lib/loaders/index.d.ts +2 -1
- package/lib/loaders/index.js +2 -1
- package/lib/loaders/pathLoader.d.ts +99 -0
- package/lib/loaders/pathLoader.js +451 -0
- package/lib/tag.d.ts +1 -1
- package/lib/tag.js +2 -0
- package/lib/types.d.ts +80 -1
- package/lib/types.js +35 -0
- package/package.json +1 -1
- package/static/atwinui.css +267 -0
- package/static/utility.css +81 -1
package/CORE_FEATURES.md
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# ArchiTwin Library Core Features
|
|
2
|
+
|
|
3
|
+
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.
|
|
4
|
+
|
|
5
|
+
## 1. Matterport Bundle SDK Enhancement
|
|
6
|
+
|
|
7
|
+
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.
|
|
8
|
+
|
|
9
|
+
## 2. Zoom SDK Integration
|
|
10
|
+
|
|
11
|
+
The library provides pre-built methods for interacting with the Zoom SDK, allowing you to easily integrate video conferencing features into your application.
|
|
12
|
+
|
|
13
|
+
## 3. Custom Three.js Loaders
|
|
14
|
+
|
|
15
|
+
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.
|
|
16
|
+
|
|
17
|
+
## 4. Space Navigation and Camera Control
|
|
18
|
+
|
|
19
|
+
The library provides methods for navigating around the space and controlling the camera. This allows you to create custom navigation experiences for your users.
|
|
20
|
+
|
|
21
|
+
## 5. Points of Interest
|
|
22
|
+
|
|
23
|
+
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.
|
|
24
|
+
|
|
25
|
+
## 6. Object Transformation
|
|
26
|
+
|
|
27
|
+
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.
|
|
28
|
+
|
|
29
|
+
## 7. Media Screens
|
|
30
|
+
|
|
31
|
+
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.
|
|
32
|
+
|
|
33
|
+
## 8. Meeting UI
|
|
34
|
+
|
|
35
|
+
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/ONBOARDING.md
ADDED
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# ArchiTwin Library Onboarding
|
|
2
|
+
|
|
3
|
+
Welcome to the ArchiTwin library! This document provides an introduction to the codebase for new developers.
|
|
4
|
+
|
|
5
|
+
## Introduction
|
|
6
|
+
|
|
7
|
+
The ArchiTwin library is a powerful tool that enhances the Matterport Bundle SDK with additional features and a ready-to-use UI. It simplifies the development process by providing pre-built methods for interacting with the Matterport SDK, as well as the Zoom SDK. The library also includes custom Three.js loaders for Matterport, enabling advanced 3D object manipulation.
|
|
8
|
+
|
|
9
|
+
The main goal of this library is to provide a comprehensive solution for developers working with the Matterport SDK, offering both a robust API and a user-friendly interface.
|
|
10
|
+
|
|
11
|
+
## Getting Started
|
|
12
|
+
|
|
13
|
+
To start working with the ArchiTwin library, you will need to have Node.js and npm installed on your machine. Once you have cloned the repository, you can install the dependencies by running the following command:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
After the installation is complete, you can build the project by running:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm run build
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
This will compile the TypeScript code and create the necessary JavaScript files in the `lib` directory.
|
|
26
|
+
|
|
27
|
+
## Codebase Structure
|
|
28
|
+
|
|
29
|
+
The ArchiTwin library is organized into the following directories:
|
|
30
|
+
|
|
31
|
+
- **`bundle`**: Contains the Matterport Bundle SDK and other third-party libraries.
|
|
32
|
+
- **`lib`**: Contains the compiled JavaScript code.
|
|
33
|
+
- **`node_modules`**: Contains the project's dependencies.
|
|
34
|
+
- **`src`**: Contains the TypeScript source code.
|
|
35
|
+
- **`static`**: Contains static assets such as images and CSS files.
|
|
36
|
+
|
|
37
|
+
### `src` Directory
|
|
38
|
+
|
|
39
|
+
The `src` directory is where most of the development work takes place. It is further divided into the following subdirectories:
|
|
40
|
+
|
|
41
|
+
- **`atwinui`**: Contains the UI components of the library.
|
|
42
|
+
- **`loaders`**: Contains the custom Three.js loaders for Matterport.
|
|
43
|
+
- **`math`**: Contains math-related utility functions.
|
|
44
|
+
- **`meeting`**: Contains the Zoom SDK integration.
|
|
45
|
+
|
|
46
|
+
## Development Guidelines
|
|
47
|
+
|
|
48
|
+
To maintain a consistent code style and quality, please follow these guidelines when working on the ArchiTwin library:
|
|
49
|
+
|
|
50
|
+
- **Coding Style**: Follow the existing coding style and patterns in the codebase.
|
|
51
|
+
- **JSDoc Comments**: Write JSDoc comments for all new functions and methods.
|
|
52
|
+
- **Type Checking**: Use TypeScript to ensure type safety.
|
|
53
|
+
- **Linting**: Run the linter before committing your changes.
|
|
54
|
+
|
|
55
|
+
## UI Development
|
|
56
|
+
|
|
57
|
+
The UI components of the ArchiTwin library are located in the `src/atwinui` directory. When creating new UI components, please follow these guidelines:
|
|
58
|
+
|
|
59
|
+
- **Component Structure**: Each UI component should be in its own directory, with a TypeScript file for the component's logic. Styles should be handled via CSS classes.
|
|
60
|
+
- **Component Naming**: Use a consistent naming convention for your components.
|
|
61
|
+
- **Component Registration**: Register your new components in the `initToolbarUI` function in `src/atwinui/index.ts`.
|
|
62
|
+
- **CSS Styling**: Before creating new CSS classes, always check `static/atwinui.css` and `static/utility.css` to see if an existing class already serves your purpose.
|
|
63
|
+
- **CSS Variables**: Make use of the CSS variables defined in `static/atwinui.css` as much as possible to maintain a consistent look and feel across the UI.
|
|
64
|
+
- **Utility Classes**: For general-purpose styling, use the utility classes in `static/utility.css`. For component-specific styles, create new classes in `static/atwinui.css`.
|
|
65
|
+
|
|
66
|
+
### Creating a New UI Component
|
|
67
|
+
|
|
68
|
+
To create a new UI component, you can follow these steps:
|
|
69
|
+
|
|
70
|
+
1. Create a new directory for your component in `src/atwinui`.
|
|
71
|
+
2. Create a TypeScript file for your component's logic.
|
|
72
|
+
3. If needed, add new CSS classes to `static/atwinui.css` or `static/utility.css`, making sure to use existing CSS variables and classes as much as possible.
|
|
73
|
+
4. Register your new component in the `initToolbarUI` function in `src/atwinui/index.ts`.
|
|
74
|
+
|
|
75
|
+
## Loaders
|
|
76
|
+
|
|
77
|
+
The custom Three.js loaders for Matterport are located in the `src/loaders` directory. These loaders are responsible for loading and parsing 3D models and other assets.
|
|
78
|
+
|
|
79
|
+
**Notice**: Before working on any of the files in the `loaders` directory, you must have a good understanding of Three.js.
|
|
80
|
+
|
|
81
|
+
## Available Scripts
|
|
82
|
+
|
|
83
|
+
The following scripts are available in the `package.json` file:
|
|
84
|
+
|
|
85
|
+
- **`build`**: Builds the project.
|
|
86
|
+
- **`deploy:package`**: Deploys the package (ONLY FOR PERSON RESPONSIBLE FOR PUBLISHING TO NPM).
|
|
87
|
+
|
|
88
|
+
## Dependencies
|
|
89
|
+
|
|
90
|
+
The ArchiTwin library uses the following dependencies:
|
|
91
|
+
|
|
92
|
+
- **`@aws-sdk/client-s3`**: AWS SDK for S3 (no longer in use).
|
|
93
|
+
- **`@mdi/font`**: Material Design Icons font.
|
|
94
|
+
- **`@superviz/matterport-plugin`**: SuperViz Matterport plugin.
|
|
95
|
+
- **`@superviz/sdk`**: SuperViz SDK (no longer in use, package abandoned by devs).
|
|
96
|
+
- **`@zoom/videosdk`**: Zoom Video SDK.
|
|
97
|
+
- **`axios`**: Promise-based HTTP client (library no longer makes application specific api calls and should never do so).
|
|
98
|
+
- **`buffer`**: Buffer implementation for the browser.
|
|
99
|
+
- **`date-fns`**: Modern JavaScript date utility library.
|
|
100
|
+
- **`i18next`**: Internationalization framework.
|
|
101
|
+
- **`i18next-browser-languagedetector`**: i18next language detector.
|
|
102
|
+
- **`i18next-http-backend`**: i18next HTTP backend.
|
|
103
|
+
- **`jsrsasign`**: JavaScript RSA signing library.
|
|
104
|
+
- **`jsrsasign-util`**: Utility library for jsrsasign.
|
|
105
|
+
- **`jszip`**: Library for creating, reading and editing .zip files.
|
|
106
|
+
- **`jszip-utils`**: Utility functions for JSZip.
|
|
107
|
+
- **`lit`**: Simple library for building fast, lightweight web components.
|
|
108
|
+
- **`loglevel`**: Minimal lightweight logging for JavaScript.
|
|
109
|
+
- **`merge-images`**: Merge images together.
|
|
110
|
+
- **`notyf`**: A minimalistic, responsive, vanilla JavaScript library to show toast notifications.
|
|
111
|
+
- **`pdfjs-dist`**: PDF.js is a Portable Document Format (PDF) viewer that is built with HTML5.
|
|
112
|
+
- **`short-unique-id`**: A fast and simple library for generating short, unique IDs.
|
|
113
|
+
- **`socket.io-client`**: Socket.IO client.
|
|
114
|
+
- **`ts-loader`**: TypeScript loader for webpack.
|
|
115
|
+
- **`tweakpane`**: A compact pane to tweak parameters and see results in real-time.
|
package/lib/architwin.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { AxiosInstance } from "axios";
|
|
2
2
|
import { MpSdk, Scene, Vector3, Vector2, Renderer } from "../bundle/sdk";
|
|
3
|
-
import { tubeLineType } from "./loaders";
|
|
3
|
+
import { tubeLineType, pathLineType } from "./loaders";
|
|
4
4
|
import { getAssetUrl } from "./utils";
|
|
5
5
|
import { initToolbarUI, themeManager } from "./atwinui";
|
|
6
|
-
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";
|
|
6
|
+
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";
|
|
7
7
|
import * as minimap from './minimap';
|
|
8
8
|
import '../static/sidebar.css';
|
|
9
9
|
import '../static/map.css';
|
|
@@ -58,6 +58,10 @@ declare let _modelDetails: MpSdk.Model.ModelDetails;
|
|
|
58
58
|
declare const tagColors: string[];
|
|
59
59
|
declare let _tubes: MpSdk.Scene.IObject;
|
|
60
60
|
declare let _partitionNodes: PartitionNode[];
|
|
61
|
+
declare let _pipeCategories: IPipeCategory[];
|
|
62
|
+
declare let _selectedPipeCategory: IPipeCategory;
|
|
63
|
+
declare let _pipes: IPipe[];
|
|
64
|
+
declare let _selectedPipe: IPipe;
|
|
61
65
|
/**
|
|
62
66
|
* Initializes the axios API instance. Use this if you want to make an API call using the library without
|
|
63
67
|
* invoking the connectSpace method
|
|
@@ -263,12 +267,19 @@ declare function getTargetPosition(callback?: Function, continousClick?: boolean
|
|
|
263
267
|
*/
|
|
264
268
|
declare function cancelModelPlacement(): Promise<void>;
|
|
265
269
|
declare function setPointerCoordinates(position: Vector3): void;
|
|
270
|
+
/**
|
|
271
|
+
* Renders a 3D model into the space.
|
|
272
|
+
* @param {ModelPayload} payload
|
|
273
|
+
* @returns {Promise<IShowcaseObject>}
|
|
274
|
+
*/
|
|
275
|
+
declare function renderModel(payload: ModelPayload): Promise<IShowcaseObject>;
|
|
266
276
|
/**
|
|
267
277
|
* Reusable method that adds an object to the space locally.
|
|
268
278
|
* @param {string} mediaUrl - The url pointing to the model/media resource
|
|
269
279
|
* @param {string} objectType - The file type of the object
|
|
270
280
|
* @param {ObjectConfig} config - Object that contains the configuration for the object to be rendered like
|
|
271
281
|
* position, rotation, and scale to name an example
|
|
282
|
+
* @deprecated - Use renderModel instead
|
|
272
283
|
* @returns {Promise<IShowcaseObject>}
|
|
273
284
|
*/
|
|
274
285
|
declare function addObjectToSpace(mediaUrl: string, objectType: string, config?: ObjectConfig, object_data?: I3DObject): Promise<IShowcaseObject>;
|
|
@@ -464,10 +475,18 @@ declare function toggleSpaceNavigation(state?: boolean): void;
|
|
|
464
475
|
/**
|
|
465
476
|
* Draws a semi transparent tube line along a path
|
|
466
477
|
* @param {Array<Vector3>} vertices - Array of coordinates or vertices
|
|
478
|
+
* @deprecated - Use renderPath instead to render a path and setPathLine to update an existing path
|
|
467
479
|
* @returns
|
|
468
480
|
*/
|
|
469
481
|
declare function drawPath(vertices: Array<Vector3>, options?: ComponentOptions): Promise<void>;
|
|
470
|
-
declare function
|
|
482
|
+
declare function setPathLine(id: number, path: Array<Vector3>): void;
|
|
483
|
+
/**
|
|
484
|
+
* Update the inputs of a rendered path line
|
|
485
|
+
* @param id - id of the object/path
|
|
486
|
+
* @param {ComponentOptions} options - keys you want to update, you should only populate keys that you explicitly wanted to update
|
|
487
|
+
* @returns
|
|
488
|
+
*/
|
|
489
|
+
declare function setPathLineOptions(id: number, options: ComponentOptions): void;
|
|
471
490
|
/**
|
|
472
491
|
* Destroys the current path line instance
|
|
473
492
|
* @param payload
|
|
@@ -478,6 +497,13 @@ declare function disposePathLine(): void;
|
|
|
478
497
|
* @returns
|
|
479
498
|
*/
|
|
480
499
|
declare function getCurrentTubeLine(): IObjectData;
|
|
500
|
+
/**
|
|
501
|
+
* 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.
|
|
502
|
+
* @param vertices - array of xyz coordinates
|
|
503
|
+
* @param options - customization options to dictate the look and behavior of the path
|
|
504
|
+
* @returns
|
|
505
|
+
*/
|
|
506
|
+
declare function renderPath(vertices: Array<Vector3>, options?: ComponentOptions): void;
|
|
481
507
|
/**
|
|
482
508
|
* Renders a polygon from an array of coordinates or an object containing an array of coordinates
|
|
483
509
|
* @param {PartitionPayload|Array<Vector3>} payload
|
|
@@ -492,6 +518,12 @@ declare function renderPolygon(payload: PartitionPayload | Array<Vector3>, optio
|
|
|
492
518
|
* @returns {void}
|
|
493
519
|
*/
|
|
494
520
|
declare function setPolygonPath(id: number, vertices: Array<Vector3>): void;
|
|
521
|
+
/**
|
|
522
|
+
* Removes a vertex sphere from the space. If no argument is passed it will remove the last vertex that has been added
|
|
523
|
+
* @param {number} index - (optional) Index of an element of vertex path
|
|
524
|
+
* @returns
|
|
525
|
+
*/
|
|
526
|
+
declare function deleteVertex(index?: number): void;
|
|
495
527
|
/**
|
|
496
528
|
* Enables vertice controls on an existing polygon
|
|
497
529
|
* @param component
|
|
@@ -505,7 +537,18 @@ declare function enableVerticeControls(component: MpSdk.Scene.IComponent): void;
|
|
|
505
537
|
* @returns
|
|
506
538
|
*/
|
|
507
539
|
declare function deleteEdge(component: MpSdk.Scene.IComponent, endPoint: Vector3): void;
|
|
508
|
-
|
|
540
|
+
/**
|
|
541
|
+
* 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.
|
|
542
|
+
* You only need to run this once unless you intend to switch the configuration again.
|
|
543
|
+
* @param {PathConfig} config - Configuration to be used by the drawing system
|
|
544
|
+
* @returns
|
|
545
|
+
*/
|
|
546
|
+
declare function setDrawingConfig(config: PathConfig): void;
|
|
547
|
+
/**
|
|
548
|
+
* Resets the configuration for the drawing system to its defaults
|
|
549
|
+
*/
|
|
550
|
+
declare function resetDrawingConfig(): void;
|
|
551
|
+
declare function startDraw(config?: PathConfig): void;
|
|
509
552
|
declare function exitDraw(): void;
|
|
510
553
|
declare function cancelDraw(): void;
|
|
511
554
|
declare function setCurrentPolygon(polygonData: IObjectData): void;
|
|
@@ -604,6 +647,7 @@ declare function renderTag(payload: {
|
|
|
604
647
|
}, addTo_tags?: boolean, iframeId?: string): Promise<MpSdk.Tag.TagData>;
|
|
605
648
|
declare function addTag(tagData: MpSdk.Tag.TagData): ITag;
|
|
606
649
|
declare function getMpTags(): ITag[];
|
|
650
|
+
declare function getTagDataCollection(): MpSdk.Dictionary<MpSdk.Tag.TagData>;
|
|
607
651
|
declare function disposeTag(payload: {
|
|
608
652
|
tagId: string;
|
|
609
653
|
}): Promise<void>;
|
|
@@ -616,7 +660,7 @@ declare function disposeTags(iframeId?: string): Promise<void>;
|
|
|
616
660
|
declare function attachTagMedia(payload: {
|
|
617
661
|
tagId: string;
|
|
618
662
|
attachments: string[];
|
|
619
|
-
}): Promise<
|
|
663
|
+
}): Promise<string[]>;
|
|
620
664
|
declare function detachTagMedia(payload: {
|
|
621
665
|
tagId: string;
|
|
622
666
|
attachmentIds: string[];
|
|
@@ -761,4 +805,52 @@ declare function setSpaceMetadata(payload: SpaceMetadata | null): void;
|
|
|
761
805
|
* @returns
|
|
762
806
|
*/
|
|
763
807
|
declare function getSpaceMetadata(): SpaceMetadata;
|
|
764
|
-
|
|
808
|
+
/**
|
|
809
|
+
* Set pipes categories value
|
|
810
|
+
* @param {IPipeCategory[]} pipes
|
|
811
|
+
* @returns
|
|
812
|
+
*/
|
|
813
|
+
declare function setPipeCategories(pipes: IPipeCategory[]): IPipeCategory[];
|
|
814
|
+
/**
|
|
815
|
+
* Set selected pipes catrgory value
|
|
816
|
+
* @param {IPipeCategory} pipe
|
|
817
|
+
* @returns
|
|
818
|
+
*/
|
|
819
|
+
declare function setSelectedPipeCategory(pipe: IPipeCategory): IPipeCategory;
|
|
820
|
+
/**
|
|
821
|
+
* Gets the current pipe category for the pipe form.
|
|
822
|
+
*
|
|
823
|
+
* @returns - The current category.
|
|
824
|
+
*/
|
|
825
|
+
declare function getSelectedPipeCategory(): IPipeCategory;
|
|
826
|
+
/**
|
|
827
|
+
* Set pipes value
|
|
828
|
+
* @param {IPipe[]} pipes
|
|
829
|
+
* @returns
|
|
830
|
+
*/
|
|
831
|
+
declare function setPipes(pipes: IPipe[]): IPipe[];
|
|
832
|
+
/**
|
|
833
|
+
* Set selected pipes value
|
|
834
|
+
* @param {IPipe} pipe
|
|
835
|
+
* @returns
|
|
836
|
+
*/
|
|
837
|
+
declare function setSelectedPipe(pipe: IPipe): IPipe;
|
|
838
|
+
/**
|
|
839
|
+
* Gets the current pipe for the pipe form.
|
|
840
|
+
*
|
|
841
|
+
* @returns - The current pipe.
|
|
842
|
+
*/
|
|
843
|
+
declare function getSelectedPipe(): IPipe;
|
|
844
|
+
/**
|
|
845
|
+
* Set selected pipes value
|
|
846
|
+
* @param {Boolean} status
|
|
847
|
+
* @returns
|
|
848
|
+
*/
|
|
849
|
+
declare function setPipeIsDrawingMode(status: Boolean): Boolean;
|
|
850
|
+
/**
|
|
851
|
+
* Gets the current pipe for the pipe form.
|
|
852
|
+
*
|
|
853
|
+
* @returns - The current pipe.
|
|
854
|
+
*/
|
|
855
|
+
declare function getPipeIsDrawingMode(): Boolean;
|
|
856
|
+
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 };
|