Pilot ComponentKit

https://pilot.ascon.ru/componentkit/
Admin
Pilot ComponentKit is a cloud platform (PaaS) for creating custom BIM solutions, providing...
Tokens:78,603
Snippets:861
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Integration Example

Source: https://pilot.ascon.ru/componentkit/extensions3d/ModelsBrowser

How to include and initialize the ModelsBrowserExtension in your project.

```APIDOC
### HTML Inclusion
<link rel="stylesheet" href="https://pilot.ascon.ru/componentkit/components/26.5.0/extensions/ModelsBrowser/ModelsBrowser.css">
<script src="https://pilot.ascon.ru/componentkit/components/26.5.0/extensions/ModelsBrowser/ModelsBrowser.min.js"></script>

### JavaScript Initialization
let htmlDiv = document.getElementById('pilotViewer');
viewer = PilotWeb3D.CreateViewer(htmlDiv);
await viewer.start();
viewer.extensionsLoader.loadExtension("PilotWeb3D.ModelsBrowser");
```

--------------------------------

### Load and Start ModelsBrowserExtension

Source: https://pilot.ascon.ru/componentkit/extensions3d/ModelsBrowser

Load the ModelsBrowserExtension after creating and starting the viewer. Ensure the viewer is initialized with a valid HTML element.

```javascript
let htmlDiv = document.getElementById('pilotViewer')
viewer = PilotWeb3D.CreateViewer(htmlDiv);
await viewer.start();
viewer.extensionsLoader.loadExtension("PilotWeb3D.ModelsBrowser");

```

--------------------------------

### Viewer2D start method

Source: https://pilot.ascon.ru/componentkit/reference2d/Viewer2D

Initializes the internal mechanisms of the component.

```typescript
 start(): Promise<number>;
```

--------------------------------

### Initialize GizmoControl

Source: https://pilot.ascon.ru/componentkit/reference3d/gizmo/GizmoControl

Example of retrieving navigation dependencies and instantiating GizmoControl.

```typescript
//Пример создания:
const cameraControl = PilotWeb3D.ViewerInstance.navigation.getCameraControl();
const navAgent = PilotWeb3D.ViewerInstance.navigation.getNavigationAgent();
const gizmoControl = new PilotWeb3D.GizmoControl(camera, navAgent);
```

--------------------------------

### Viewer3D Start and Finish Methods

Source: https://pilot.ascon.ru/componentkit/comparison

Methods for initializing and terminating the 3D viewer session.

```typescript
start(url, options, onSuccessCallback, onErrorCallback, initOptions): number
```

```typescript
start(): Promise<number>
```

```typescript
finish(): void
```

```typescript
finish(): Promise<void>
```

--------------------------------

### Load ZoomExtension via JavaScript

Source: https://pilot.ascon.ru/componentkit/extensions2d/Zoom

Dynamically load the extension after the viewer has been initialized and started.

```javascript
const htmlDiv = document.getElementById('pilotViewer')
const configuration = new PilotWeb2D.Viewer2DConfiguration();
const viewer = PilotWeb2D.CreateViewer(htmlDiv, configuration);
await viewer.start();
// загружаем расширение. Расширение активируется автоматически
const extension = await viewer.extensionsLoader.loadExtension("PilotWeb2D.Zoom");
```

--------------------------------

### Load and Initialize ModelPartGizmo Extension in JavaScript

Source: https://pilot.ascon.ru/componentkit/extensions3d/ModelPartGizmoExtension

Initialize the Pilot Web3D viewer and load the ModelPartGizmo extension. Ensure the viewer is started before loading extensions.

```javascript
let htmlDiv = document.getElementById('pilotViewer')
viewer = PilotWeb3D.CreateViewer(htmlDiv);
await viewer.start();
await viewer.extensionsLoader.loadExtension("PilotWeb3D.ModelPartGizmo");

```

--------------------------------

### Initialize Viewer and Load RemarksExtension

Source: https://pilot.ascon.ru/componentkit/extensions2d/Remarks

Initialize the 2D viewer and then load and activate the Remarks extension. Ensure the viewer is started before loading extensions.

```javascript
const htmlDiv = document.getElementById('pilotViewer')
const configuration = new PilotWeb2D.Viewer2DConfiguration();
const viewer = PilotWeb2D.CreateViewer(htmlDiv, configuration);
await viewer.start();
// загружаем расширение и активируем его
const remarksExtension = await viewer.extensionsLoader.loadExtension("PilotWeb2D.Remarks");
remarksExtension.activate();

```

--------------------------------

### Load ZoomToFitExtension via JavaScript

Source: https://pilot.ascon.ru/componentkit/extensions3d/ZoomToFit

Initialize the viewer and load the extension using the extensionsLoader after the viewer has started.

```javascript
let htmlDiv = document.getElementById('pilotViewer')
viewer = PilotWeb3D.CreateViewer(htmlDiv);
await viewer.start();
viewer.extensionsLoader.loadExtension("PilotWeb3D.ZoomToFit");
```

--------------------------------

### Initialize Localization

Source: https://pilot.ascon.ru/componentkit/reference/Localization

Defines the method signature for initializing localization and provides an example options object.

```typescript
static initialize(options: any): Promise<void>
```

```javascript
  const options = {
    language: "ru"
  }
```

--------------------------------

### Get All Model Versions

Source: https://pilot.ascon.ru/componentkit/reference3d/Model

Asynchronously retrieves a list of all available versions for the model.

```typescript
getAllModelVersions(): Promise<bigint[]>; 
```

--------------------------------

### Load and Activate BoxSelectionExtension in JavaScript

Source: https://pilot.ascon.ru/componentkit/extensions3d/BoxSelection

Load the BoxSelectionExtension using the viewer's extensionsLoader after creating and starting the viewer. Ensure the viewer is properly initialized.

```javascript
let htmlDiv = document.getElementById('pilotViewer')
viewer = PilotWeb3D.CreateViewer(htmlDiv);
await viewer.start();
viewer.extensionsLoader.loadExtension("PilotWeb3D.BoxSelection");

```

--------------------------------

### Get Model Part Element Properties

Source: https://pilot.ascon.ru/componentkit/bim-dataprovider/BimDataProvider

Fetches the latest properties for a specific model element using its GUID. BimDataBigIntMaxValue ensures retrieval of the most current version.

```typescript
// Получаем последнюю версию свойств элемента модели.
const properties = await modelPart.getElementProperties(elements[5].guid, BimDataBigIntMaxValue);
```

--------------------------------

### Set Start Point

Source: https://pilot.ascon.ru/componentkit/reference3d/gizmo/GizmoAxis

Calculates the initial cursor position on the axis plane using NDC coordinates and the provided camera.

```typescript
  protected setStartPt(ndcPos: THREE.Vector2, camera: THREE.Camera): void;
```

--------------------------------

### Get Clicked Page from Mouse Event

Source: https://pilot.ascon.ru/componentkit/extensions2d/Remarks

Protected method to get the document page associated with a mouse click event. Returns undefined if no page is found.

```typescript
protected getClickPage(event: MouseEvent): PilotWeb2D.IDocumentPage | undefined 

```

--------------------------------

### Get Clicked Point Coordinates

Source: https://pilot.ascon.ru/componentkit/extensions2d/Remarks

Protected method to get the coordinates of a click point relative to the page, without considering zoom. Multiply by page scale for scaled coordinates.

```typescript
protected getClickPoint(event: MouseEvent, offsetX = 0, offsetY = 0): PilotWeb2D.Point2

```

--------------------------------

### Register and Load an Extension

Source: https://pilot.ascon.ru/componentkit/reference3d/extension/ExtensionLoader

Demonstrates defining a custom extension, registering it with the ExtensionManager, and loading it into a viewer instance.

```javascript
// описываем расширение
class MyExtension extends PilotWeb3D.Extension {
  ...
}
// регистрируем
PilotWeb3D.theExtensionManager.registerExtensionType('myExtension', MyExtension);

// загружаем в компонент
let viewer = PilotWeb3D.CreateViewer(div);
viewer.extensionLoader.loadExtension('myExtension');
```

--------------------------------

### Load ClippingPlaneExtension in JavaScript

Source: https://pilot.ascon.ru/componentkit/extensions3d/ClippingPlane

Load the ClippingPlaneExtension using the viewer's extensionsLoader after creating and starting the viewer.

```javascript
let htmlDiv = document.getElementById('pilotViewer')
viewer = PilotWeb3D.CreateViewer(htmlDiv);
await viewer.start();
viewer.extensionsLoader.loadExtension("PilotWeb3D.ClippingPlane");

```

--------------------------------

### Get element name

Source: https://pilot.ascon.ru/componentkit/reference3d/modelelement/ModelElement

Retrieves the name of the element.

```typescript
get name(): string;
```

--------------------------------

### Get extension name

Source: https://pilot.ascon.ru/componentkit/reference2d/Extension

Retrieves the name of the extension.

```typescript
getName(): string;
```

--------------------------------

### Load ViewerSettingsExtension in JavaScript

Source: https://pilot.ascon.ru/componentkit/extensions3d/ViewerSettings

Initialize the viewer and load the extension using the extensionsLoader.

```javascript
let htmlDiv = document.getElementById('pilotViewer')
viewer = PilotWeb3D.CreateViewer(htmlDiv);
await viewer.start();
viewer.extensionsLoader.loadExtension("PilotWeb3D.ViewerSettings");
```

--------------------------------

### Initialize Viewer and Load WasdNavigationExtension

Source: https://pilot.ascon.ru/componentkit/extensions3d/WasdNavigation

Initialize the Pilot3D viewer and load the WasdNavigation extension using its API.

```javascript
let htmlDiv = document.getElementById('pilotViewer')
viewer = PilotWeb3D.CreateViewer(htmlDiv);
await viewer.start();
viewer.extensionsLoader.loadExtension("PilotWeb3D.WasdNavigation");
```

--------------------------------

### GizmoAxis Constructor

Source: https://pilot.ascon.ru/componentkit/reference3d/gizmo/GizmoAxis

Details on how to instantiate the GizmoAxis class, including its parameters.

```APIDOC
### Constructor

```typescript
constructor(axisDir: THREE.Vector3, 
            handle: IGizmoObject,
            picker?: IGizmoObject,
            helper?: IGizmoObject);
```

Where:

- `axisDir`: The direction of the axis in local coordinates. More details: THREE.Vector3.
- `handle`: Defines the handle – the geometry of the axis drawn on the scene. More details: IGizmoObject.
- `picker`: Defines the picker – the geometry of the axis used for intersection checks. Optional parameter. More details: IGizmoObject.
- `helper`: Defines the helper – auxiliary geometry of the axis. Optional parameter. More details: IGizmoObject.
```

--------------------------------

### Get child elements

Source: https://pilot.ascon.ru/componentkit/reference3d/modelelement/ModelElement

Retrieves an array of child elements.

```typescript
get children(): ModelElement[];
```

--------------------------------

### Get element identifier

Source: https://pilot.ascon.ru/componentkit/reference3d/modelelement/ModelElement

Retrieves the unique identifier for the element.

```typescript
get id(): string;
```

--------------------------------

### GET getLatestVersion()

Source: https://pilot.ascon.ru/componentkit/bim-dataprovider/IBimDataModelPart

Retrieves the latest version of the model as a bigint.

```APIDOC
## GET getLatestVersion()

### Description
Returns the latest version of the model.

### Method
GET

### Response
- **version** (bigint) - The latest version of the model.
```

--------------------------------

### Register and Load Extension in Pilot-ComponentKit

Source: https://pilot.ascon.ru/componentkit/reference2d/ExtensionLoader

Demonstrates how to define, register, and then load a custom extension using the ExtensionLoader. Ensure the extension is registered with ExtensionManager before attempting to load it.

```javascript
// описываем расширение
class MyExtension extends PilotWeb2D.Extension {
  ...
}
// регистрируем
PilotWeb2D.theExtensionManager.registerExtensionType('myExtension', MyExtension);

// загружаем в компонент
let viewer = PilotWeb2D.CreateViewer(div);
viewer.extensionLoader.loadExtension('myExtension');

```

--------------------------------

### Get Current Model Version

Source: https://pilot.ascon.ru/componentkit/reference3d/Model

Retrieves the current version of the model.

```typescript
getModelVersion(): bigint;
```

--------------------------------

### Extension Integration

Source: https://pilot.ascon.ru/componentkit/extensions3d/ViewerSettings

How to load and initialize the ViewerSettings extension in a web application.

```APIDOC
### HTML Integration
<script src="https://pilot.ascon.ru/componentkit/components/26.5.0/extensions/ViewerSettings/ViewerSettings.min.js"></script>

### JavaScript Initialization
let htmlDiv = document.getElementById('pilotViewer');
viewer = PilotWeb3D.CreateViewer(htmlDiv);
await viewer.start();
viewer.extensionsLoader.loadExtension("PilotWeb3D.ViewerSettings");
```

--------------------------------

### ModelElementTree Methods

Source: https://pilot.ascon.ru/componentkit/comparison

This section details the methods available for the ModelElementTree class, including retrieving root and all elements, checking detachment, getting nesting levels, and enumerating children.

```APIDOC
## ModelElementTree Class Methods

### getRootId

#### Description
Returns the ID of the root element of the tree.

#### Method
`getRootId(): number`

### getRootElement

#### Description
Retrieves the root element of the tree.

#### Method
`getRootElement(): ModelElement`

### getAllElements

#### Description
Returns a list of all elements within the tree.

#### Method
`getAllElements(): ModelElement[]`

### isDetachedElement

#### Description
Checks if a given element is detached from the tree.

#### Method
`isDetachedElement(element: string | ModelElement): boolean`

### getChildLevelNumber

#### Description
Gets the nesting level number for a specified element.

#### Method
`getChildLevelNumber(element: string | ModelElement): number`

### enumElementChildren

#### Description
Applies an action to all child elements of a given element. Can be recursive.

#### Method
`enumElementChildren(element: string | ModelElement, callback: (guid: string) => void, recursive?: boolean): void`
```

--------------------------------

### Get Active Status

Source: https://pilot.ascon.ru/componentkit/reference3d/gizmo/GizmoAxis

Retrieves the current activity status of the axis.

```typescript
  getActive(): boolean;
```

--------------------------------

### Get element type

Source: https://pilot.ascon.ru/componentkit/reference3d/modelelement/ModelElement

Retrieves the string representation of the element type.

```typescript
get type(): string;
```

--------------------------------

### RemarkViewObject statusParameters Getter

Source: https://pilot.ascon.ru/componentkit/extensions3d/RemarksExtension

Gets the current status parameters of the RemarkViewObject.

```typescript
get statusParameters(): RemarkStatusParameters;
```

--------------------------------

### Initialize RemarksExtension in JavaScript

Source: https://pilot.ascon.ru/componentkit/extensions3d/RemarksExtension

Load the extension into the viewer instance after initialization.

```javascript
let htmlDiv = document.getElementById('pilotViewer')
viewer = PilotWeb3D.CreateViewer(htmlDiv);
await viewer.start();
await viewer.extensionsLoader.loadExtension("PilotWeb3D.Remarks");
```

--------------------------------

### Load FullScreenExtension in JavaScript

Source: https://pilot.ascon.ru/componentkit/extensions3d/FullScreen

Load the extension into the viewer instance after initialization.

```javascript
let htmlDiv = document.getElementById('pilotViewer')
viewer = PilotWeb3D.CreateViewer(htmlDiv);
await viewer.start();
viewer.extensionsLoader.loadExtension("PilotWeb3D.FullScreen");
```

--------------------------------

### RemarkViewObject remarkParameters Getter

Source: https://pilot.ascon.ru/componentkit/extensions3d/RemarksExtension

Gets the current remark parameters of the RemarkViewObject.

```typescript
get remarkParameters(): RemarkObjectParameters;
```

--------------------------------

### Model Version Management

Source: https://pilot.ascon.ru/componentkit/reference3d/Model

Methods for setting, getting, and comparing model versions.

```APIDOC
## setModelVersion()

### Description
Метод задает версию модели.

### Method
POST

### Endpoint
/api/model/version/set

### Parameters
#### Query Parameters
- **value** (bigint) - Required - Версия модели.

### Response
#### Success Response (200)
- **Success** (void) - Indicates the operation was successful.
```

```APIDOC
## getModelVersion()

### Description
Метод возвращает текущую версию модели.

### Method
GET

### Endpoint
/api/model/version/current

### Response
#### Success Response (200)
- **version** (bigint) - Текущая версия модели.
```

```APIDOC
## getAllModelVersions()

### Description
Метод возвращает список версий модели.

### Method
GET

### Endpoint
/api/model/versions/all

### Response
#### Success Response (200)
- **versions** (bigint[]) - Список версий модели.
```

```APIDOC
## compareVersions()

### Description
Метод переключает часть консолидированной модели в режим сравнения версий и возвращает различия между двумя версиями.

### Method
POST

### Endpoint
/api/model/versions/compare

### Parameters
#### Query Parameters
- **modelPart** (string | ModelPart) - Required - Идентификатор или экземпляр части модели.
- **versionFrom** (bigint) - Required - Версия, которая в режиме сравнения станет текущей.
- **versionToCompare** (bigint) - Required - Версия для сравнения.

### Response
#### Success Response (200)
- **diff** (ModelPartVersionsDiff) - Различия между двумя версиями модели.
```

--------------------------------

### ViewerConfiguration Methods

Source: https://pilot.ascon.ru/componentkit/reference/ViewerConfiguration

Methods for merging configurations, creating settings objects, and updating the viewer theme.

```APIDOC
## mergeConfigurationAndSettings()

### Description
Merges the provided configuration with settings, replacing configuration values with those from the settings object.

### Parameters
- **configuration** (ViewerSettings) - Required - The base configuration object.
- **settings** (ISettings) - Required - The settings to merge into the configuration.

## createConfiguration()

### Description
Merges properties from the configuration into the origin object. If configuration is empty or null, origin is assigned by reference.

### Parameters
- **configuration** (ViewerSettings) - Required - The configuration to apply.
- **origin** (ViewerSettings) - Required - The target object to update.

## changeTheme()

### Description
Updates the visual theme of the viewer.

### Parameters
- **newTheme** (string) - Required - The new theme value from SettingsTheme.
```

--------------------------------

### SettingsNames Configuration Constants

Source: https://pilot.ascon.ru/componentkit/reference3d/configuration/SettingNames

A list of available configuration keys for the PilotWeb3D viewer.

```APIDOC
## SettingsNames Constants

### Description
Defines the keys used for configuring the PilotWeb3D viewer.

### Constants
- **TELEMETRY** (string) - Enables/disables debug information (true/false/undefined).
- **ANTI_ALIASING** (string) - Enables/disables 3D model anti-aliasing (true/false/undefined).
- **HIDE_EDGES_WHEN_NAVIGATING** (string) - Hides edges during navigation (true/false/undefined).
- **DISPLAY_MODE** (string) - Sets display mode (DisplayMode.FACES_AND_EDGES / DisplayMode.FACES / undefined).
- **CAMERA_MODE** (string) - Sets camera projection type (CAMERA_MODE.ORTHOGRAPHIC / CAMERA_MODE.PERSPECTIVE / undefined).
- **NAVIGATION_CUBE** (string) - Toggles visibility of the navigation cube (true/false/undefined).
- **HIDE_SMALL_ELEMENTS** (string) - Toggles hiding of small objects (true/false/undefined).
- **SMALL_ELEMENT_SIZE** (string) - Sets the size threshold for small objects in pixels (number/undefined).
- **SHOW_SPACE_ELEMENTS** (string) - Toggles loading of IfcSpace elements (boolean).
- **SHOW_VOID_ELEMENTS** (string) - Toggles loading of IfcVoidElements and IfcVoidingFeature (boolean).
```

--------------------------------

### Extension Event and UI Methods

Source: https://pilot.ascon.ru/componentkit/reference2d/Extension

Methods for handling toolbar creation and mouse interaction events.

```APIDOC
## Extension Event and UI Methods

### getName()
- **Description**: Returns the name of the extension.
- **Returns**: string

### onToolbarCreated(builder: ToolbarBuilder)
- **Description**: Called when the toolbar is built, allowing modification of controls.
- **Parameters**: builder (ToolbarBuilder)

### onMouseDown(event: MouseEvent)
- **Description**: Triggered on left mouse button press.

### onMouseMove(event: MouseEvent)
- **Description**: Triggered on mouse movement.

### onMouseUp(event: MouseEvent)
- **Description**: Triggered on left mouse button release.
```

--------------------------------

### Get ModelPart ID

Source: https://pilot.ascon.ru/componentkit/reference3d/ModelPart

Retrieves the unique identifier for the consolidated model part.

```typescript
get id() : string;
```

--------------------------------

### Include ViewerSettingsExtension via HTML

Source: https://pilot.ascon.ru/componentkit/extensions3d/ViewerSettings

Include the extension script in your HTML file to enable the functionality.

```html
<script src="https://pilot.ascon.ru/componentkit/components/26.5.0/extensions/ViewerSettings/ViewerSettings.min.js"></script>
```

--------------------------------

### GET getToolbar()

Source: https://pilot.ascon.ru/componentkit/reference2d/GuiViewer2D

Retrieves the toolbar object associated with the 2D document viewer.

```APIDOC
## GET getToolbar()

### Description
Retrieves the ViewerToolbar object to manage and interact with the viewer's toolbar controls.

### Method
GET

### Endpoint
getToolbar()

### Response
#### Success Response (200)
- **ViewerToolbar** (object) - The toolbar instance associated with the GuiViewer2D component.
```

--------------------------------

### PilotWeb2D.Initializer

Source: https://pilot.ascon.ru/componentkit/reference2d/pilot-web-2d

Initializes the PilotWeb2D component. This method must be called before any other component methods.

```APIDOC
## PilotWeb2D.Initializer

### Description
Initializes the PilotWeb2D component. All other methods should be called only after this initialization is complete.

### Parameters
- **options** (Object) - Required - Configuration settings for the component.
- **callback** (Function) - Required - A callback function (InitializeSuccessCallback) executed upon successful initialization.

### Request Example
```javascript
let options = {};
let myCallback = function() {
   console.log("initialization complete, creating the viewer...");
};
PilotWeb2D.Initializer(options, myCallback);
```
```

--------------------------------

### Manage valid state

Source: https://pilot.ascon.ru/componentkit/reference/Input

Gets or sets the validation status of the input field.

```typescript
get valid(): boolean;
set valid(value: boolean);
```

--------------------------------

### Get Active Extension Name

Source: https://pilot.ascon.ru/componentkit/reference/ExtensionActivationController

Retrieves the name of the currently active extension.

```typescript
getActive(): string;
```

--------------------------------

### GizmoControl Constructor

Source: https://pilot.ascon.ru/componentkit/reference3d/gizmo/GizmoControl

Initializes a new instance of the GizmoControl class.

```APIDOC
## Constructor

```typescript
constructor(cameraControl: THREE.Camera | ICameraControl, navAgent: INavigationAgent);
```

Parameters:
`cameraControl` - The camera controller or camera used in the scene. See: ICameraControl.
`navAgent` - The navigation agent. See: INavigationAgent.
The camera controller and navigation agent can be obtained from INavigation.

```javascript
// Example of creation:
const cameraControl = PilotWeb3D.ViewerInstance.navigation.getCameraControl();
const navAgent = PilotWeb3D.ViewerInstance.navigation.getNavigationAgent();
const gizmoControl = new PilotWeb3D.GizmoControl(camera, navAgent);
```
```

--------------------------------

### Get Full-Screen Mode

Source: https://pilot.ascon.ru/componentkit/extensions3d/FullScreen

Method to retrieve the current display mode status.

```typescript
getMode(): FullScreenExtension.FullScreenMode;
```

--------------------------------

### Disable Built-in Extension

Source: https://pilot.ascon.ru/componentkit/reference3d/configuration/ViewerConfiguration

Example of disabling the PilotWeb3D.ViewCube extension via configuration.

```typescript

const configuration = new PilotWeb3D.Viewer3DConfiguration();
configuration.extensionsOptions = {
  'PilotWeb3D.ViewCube': {
    disabled: true
  },
}
const htmlDiv = document.getElementById("viewer");
this._viewer = PilotWeb3D.CreateViewer(htmlDiv, configuration);
await this._viewer.start();
...
```

--------------------------------

### WindowStater Methods

Source: https://pilot.ascon.ru/componentkit/reference/WindowStater

Methods for restoring and saving the window state.

```APIDOC
## WindowStater Methods

### restore()

#### Description
Restores the window's position and its width/height based on `IWindowStyle`.

#### Method
`restore(): void`

### saveWindowState()

#### Description
Saves the window's styles to localStorage if a `saveKey` was provided in `IWindowStateOptions`.

#### Method
`saveWindowState(): void`
```

--------------------------------

### Configure Extension Options

Source: https://pilot.ascon.ru/componentkit/reference3d/configuration/ViewerConfiguration

Property definition for passing initial settings to extensions.

```typescript
extensionsOptions: Array<{ name: string, options: ViewerSettings }>;
```

--------------------------------

### GizmoBuilder - build()

Source: https://pilot.ascon.ru/componentkit/reference3d/gizmo/GizmoBuilder

Constructs a GizmoControl with default implementations. This is the primary method for creating a GizmoControl instance.

```APIDOC
## GizmoBuilder - build()

### Description
Builds a GizmoControl with default implementation.

### Method
`public static build(camera: THREE.Camera, navAgent: INavigationAgent, translation: GizmoAxisDir = GizmoAxisDir.XYZ, rotation: GizmoAxisDir = GizmoAxisDir.XYZ, scale: GizmoAxisDir = GizmoAxisDir.XYZ): GizmoControl`

### Parameters
*   **camera** (THREE.Camera) - The camera used for rendering the GizmoControl on the scene.
*   **navAgent** (INavigationAgent) - The navigation agent.
*   **translation** (GizmoAxisDir) - Optional. An enumeration of translation axes to add to the controller. Defaults to `GizmoAxisDir.XYZ`.
*   **rotation** (GizmoAxisDir) - Optional. An enumeration of rotation axes to add to the controller. Defaults to `GizmoAxisDir.XYZ`.
*   **scale** (GizmoAxisDir) - Optional. An enumeration of scale axes to add to the controller. Defaults to `GizmoAxisDir.XYZ`.

### Returns
*   GizmoControl - The constructed GizmoControl object.
```

--------------------------------

### activate()

Source: https://pilot.ascon.ru/componentkit/reference/ExtensionActivationController

Activates a new extension by its name and triggers an asynchronous event.

```APIDOC
## POST /activate

### Description
Activates a new extension. The active extension is set to the provided name and an asynchronous event is triggered with the field 'extensionName' set to the provided name.

### Method
POST

### Parameters
#### Request Body
- **name** (string) - Required - The name of the new extension to activate.
```

--------------------------------

### Get view object

Source: https://pilot.ascon.ru/componentkit/reference3d/modelelement/ModelElement

Retrieves the IViewObject geometry if available, otherwise returns undefined.

```typescript
get viewObject(): IViewObject | undefined;
```

--------------------------------

### Define IWindowStateOptions Interface

Source: https://pilot.ascon.ru/componentkit/reference/WindowStater

Defines configuration options for window resizing and dragging persistence.

```typescript
export interface IWindowStateOptions {
  // Ключ по которому будут сохранены настройки для восстановления при последующем открытии окна
  saveKey: string;
  // Свойство, которое обозначает надо ли устанавливать окну сохранённые настройки размера при последующем открытии
  restoreWindowSize: boolean;
  // Свойство, которое обозначает надо ли устанавливать окну сохранённые настройки позиции при последующем открытии
  restoreWindowPosition: boolean;
}
```

--------------------------------

### Get parent element

Source: https://pilot.ascon.ru/componentkit/reference3d/modelelement/ModelElement

Returns the parent element or undefined if the element is a root node.

```typescript
get parent(): ModelElement | undefined;
```

--------------------------------

### Pilot-ComponentKit Input Class Overview

Source: https://pilot.ascon.ru/componentkit/reference/Input

This section details the properties and methods available for the Input class in Pilot-ComponentKit.

```APIDOC
## Pilot-ComponentKit Input Class

### Description
The Input class is used to create text input fields with support for placeholders, validation, and error display.

### Properties

- **inputElement** (HTMLInputElement) - Readonly - The HTML representation of the input element.
- **error** (HTMLElement) - Readonly - The HTML element containing the error message for the field.
- **valid** (boolean) - Readwrite - The validation state of the input field.

### Methods

- **setPlaceholder(placeholder: string): void**
  Sets the placeholder text for the input field.
  - `placeholder` (string) - The hint text displayed inside the field.

- **setDisabled(value: boolean): void**
  Sets the disabled state of the input field.
  - `value` (boolean) - `true` to disable the field; `false` to enable it.

- **onChange(value: string): void**
  Subscribes to changes in the input field's value.
  - `value` (string) - The current value of the field after the change.

- **setText(text: string): void**
  Sets the text value of the input field.
  - `text` (string) - The new value to be displayed in the field.

- **destroy(): void**
  Removes the input field and cleans up associated event handlers.
```

--------------------------------

### Get model part identifier

Source: https://pilot.ascon.ru/componentkit/reference3d/modelelement/ModelElement

Retrieves the identifier of the model part associated with the element.

```typescript
get modelPartId(): string;
```

--------------------------------

### Initialize PilotWeb2D Component

Source: https://pilot.ascon.ru/componentkit/reference2d/pilot-web-2d

Use this method to initialize the PilotWeb2D component. All other methods should be called after successful initialization. The callback is invoked upon completion.

```typescript
type InitializeSuccessCallback = () => void;
function Initializer(options, callback: InitializeSuccessCallback): void;
```

```javascript
let options = {};
let myCallback = function() {
   console.log("initialization complete, creating the viewer...");
};
PilotWeb2D.Initializer(options, myCallback);
```

--------------------------------

### Get View Object

Source: https://pilot.ascon.ru/componentkit/reference3d/ModelPart

Returns the geometric object corresponding to the model part on the scene.

```typescript
  getViewObject(): IViewObject;
```

--------------------------------

### Initialize and Open Model Part

Source: https://pilot.ascon.ru/componentkit/bim-dataprovider/BimDataProvider

Initializes the BimDataProvider and opens a model part from a buffer. Ensure the model part ID is unique and the bmFileBuffer is valid.

```typescript
import { BimDataBigIntMaxValue, BimDataProvider } from "@pilotdev/pilot-bim-dataprovider";

// --- Работа с файлами частей модели ---
// Создаем и инициализируем компонент.
const bimDataProvider = new BimDataProvider();
await bimDataProvider.init();

// Получаем объект-посредник для чтения .bm файла.
const modelPart = await bimDataProvider.openModelPart("uniqueModelPartId", bmFileBuffer);
```

--------------------------------

### Get Overlays Method

Source: https://pilot.ascon.ru/componentkit/reference2d/IAnnotationLayer

Retrieves all HTML elements currently added to the annotation layer.

```typescript
getOverlays(): HTMLElement[];
```

--------------------------------

### Get Source Data

Source: https://pilot.ascon.ru/componentkit/reference2d/IDocument

Asynchronously retrieves the raw source data of the document as an ArrayBuffer.

```typescript
getSourceData(): Promise<ArrayBuffer>;
```

--------------------------------

### GizmoObject Class

Source: https://pilot.ascon.ru/componentkit/reference3d/gizmo/IGizmoObject

Implementation of IGizmoObject that handles material switching based on interaction states.

```APIDOC
## GizmoObject Class

### Description
Implementation of IGizmoObject that updates geometry materials based on hover and active states.

### Constructor Parameters
- **_meshes** (THREE.Mesh[]) - Required - Geometries used for rendering and raycasting.
- **baseMaterial** (THREE.Material) - Optional - Material used when inactive and not hovered.
- **hoverMaterial** (THREE.Material) - Optional - Material used when hovered.
- **activeMaterial** (THREE.Material) - Optional - Material used when active.

### Methods
- **getHovered()** (boolean) - Returns hover status.
- **setHovered(value: boolean)** (void) - Sets hover status and updates material.
- **getActive()** (boolean) - Returns active status.
- **setActive(value: boolean)** (void) - Sets active status and updates material.
- **raycast(raycaster, intersects)** (void) - Overridden method to check intersections for all object meshes.
```

--------------------------------

### Get nesting level with getChildLevelNumber

Source: https://pilot.ascon.ru/componentkit/reference3d/modelelement/ModelElementTree

Returns the nesting level of the specified element within the tree.

```typescript
getChildLevelNumber(element: string | ModelElement): number
```

--------------------------------

### Toolbar Configuration

Source: https://pilot.ascon.ru/componentkit/reference3d/configuration/ViewerConfiguration

Details on configuring the toolbar direction and content alignment.

```APIDOC
## Toolbar Configuration

### Description
Settings to control the positioning and alignment of the viewer toolbar.

### Properties
- **direction** (string) - Controls toolbar position. Values: 'ascn-toolbar-fixed-top', 'ascn-toolbar-top', 'ascn-toolbar-fixed-bottom', 'ascn-toolbar-bottom'.
- **content** (string) - Controls button alignment. Values: 'ascn-toolbar-content-center', 'ascn-toolbar-content-start', 'ascn-toolbar-content-end'.
```

--------------------------------

### MeasurementToolsExtension Overview

Source: https://pilot.ascon.ru/componentkit/extensions3d/MeasurementToolsExtension

Information on how to include and initialize the MeasurementToolsExtension.

```APIDOC
## MeasurementToolsExtension

**MeasurementToolsExtension** provides various measurement tools. The extension's name is `PilotWeb3D.MeasurementTools`.

### Installation

Include the extension script in your HTML:

```html
<script src="https://pilot.ascon.ru/componentkit/components/26.5.0/extensions/MeasurementTools/MeasurementTools.min.js"></script>
```

Initialize the viewer and load the extension in JavaScript:

```javascript
let htmlDiv = document.getElementById('pilotViewer')
viewer = PilotWeb3D.CreateViewer(htmlDiv);
await viewer.start();
viewer.extensionsLoader.loadExtension("PilotWeb3D.MeasurementTools");
```
```

--------------------------------

### Get ModelPart Placement

Source: https://pilot.ascon.ru/componentkit/reference3d/ModelPart

Returns the global transformation matrix (4x4, column-major) for the model part.

```typescript
  getModelPartPlacement(): THREE.Matrix4;
```

--------------------------------

### IWindowStateOptions Interface

Source: https://pilot.ascon.ru/componentkit/reference/WindowStater

Defines options for resizing and dragging dialog windows, including saving and restoring window states.

```APIDOC
## IWindowStateOptions Interface

### Description
Interface storing properties for resizing and dragging dialog windows.

### Properties
- **saveKey** (string) - The key under which settings will be saved for restoration upon subsequent opening.
- **restoreWindowSize** (boolean) - Indicates whether to apply saved size settings when the window is reopened.
- **restoreWindowPosition** (boolean) - Indicates whether to apply saved position settings when the window is reopened.
```

--------------------------------

### Get ModelPart Element Tree

Source: https://pilot.ascon.ru/componentkit/reference3d/ModelPart

Retrieves the element tree instance associated with the model part.

```typescript
get elementTree() : ModelElementTree
```

--------------------------------

### Get Toolbar Object - GuiViewer2D

Source: https://pilot.ascon.ru/componentkit/reference2d/GuiViewer2D

Retrieves the toolbar object for interaction. Refer to ViewerToolbar for more details.

```typescript
getToolbar(): ViewerToolbar;
```

--------------------------------

### Create PilotWeb2D Viewer Instance

Source: https://pilot.ascon.ru/componentkit/reference2d/pilot-web-2d

Creates a component instance for viewing documents within a specified HTML container element.

```typescript
function CreateViewer(container: HTMLElement) : GuiViewer2D;
```

```javascript
let htmlDiv = document.getElementById('pilotViewer');
let viewer = PilotWeb2D.CreateViewer(htmlDiv);
```

--------------------------------

### Get Button State

Source: https://pilot.ascon.ru/componentkit/reference/Button

The getState method returns the current state of the button, which is of type Button.State.

```typescript
getState(): Button.State;
```

--------------------------------

### activate() Method for Extension

Source: https://pilot.ascon.ru/componentkit/reference3d/extension/Extension

Activates the extension's functionality. Returns true if activation is successful.

```typescript
activate() : boolean;
```

--------------------------------

### Manage Checkbox State

Source: https://pilot.ascon.ru/componentkit/reference/Checkbox

Use the checked property to get or set the current state of the checkbox.

```typescript
get checked(): boolean;
set checked(value: boolean);
```

--------------------------------

### getAllVersions() Method

Source: https://pilot.ascon.ru/componentkit/bim-dataprovider/IBimDataModelPart

Retrieves a list of all available versions for the model.

```APIDOC
## getAllVersions()

Returns a list of all versions of the model.

### Method
GET

### Endpoint
`/websites/pilot_ascon_ru_componentkit/versions/all`

### Response
#### Success Response (200)
- **bigint[]** - An array of version numbers (bigint).

### Response Example
```json
[
  1678886400000,
  1678972800000
]
```
```

--------------------------------

### BimDataProvider Methods

Source: https://pilot.ascon.ru/componentkit/bim-dataprovider/BimDataProvider

Detailed documentation for each method available in the BimDataProvider class.

```APIDOC
## Методы

### init()

Метод инициализирует компонент.
```typescript
  init(): Promise<void>;
```
```

```APIDOC
### createDataFile(id: string)

Метод создает файл в файловой системе для чтения и записи.
```typescript
  createDataFile(id: string): Promise<IBimDataPart>;
```

где:
`id` – уникальный идентификатор файла модели.
Возвращает объект-посредник для чтения и записи файла данных. Подробнее: IBimDataPart.
```

```APIDOC
### openModelPart()

Метод открывает файл модели для чтения и записи.
```typescript
  openModelPart(dataFile: IBimDataPart): Promise<IBimDataModelPart>;
  openModelPart(id: string, sourceData?: ArrayBuffer | ArrayBufferView | Blob | string, options?: OpenOptions): Promise<IBimDataModelPart>;
```

где:
`dataFile` – объект посредник для чтения или записи файла данных. Подробнее: IBimDataPart.
или:
`id` – уникальный идентификатор файла модели.
`sourceData` – источник данных файла модели, может быть как массивом данных, так и строкой URL. Необязательный параметр.
`options` – опции открытия файла данных модели. Необязательный параметр.
Возвращает объект-посредник для чтения или записи файла модели, если удалось открыть файл. Подробнее: IBimDataModelPart.
```

```APIDOC
### openCloudPart()

Метод открывает файл облака точек для чтения.
```typescript
  openCloudPart(dataFile: IBimDataPart): Promise<IBimDataModelPart>;
  openCloudPart(id: string, sourceData?: ArrayBuffer | ArrayBufferView | Blob | string, options?: OpenOptions): Promise<IBimDataCloudPart>;
```

где:
`dataFile` – объект посредник для чтения или записи файла облака точек. Подробнее: IBimDataPart.
или:
`id` – уникальный идентификатор файла модели.
`sourceData` – источник данных файла модели, может быть как массивом данных, так и строкой URL. Необязательный параметр.
`options` – опции открытия файла данных модели. Необязательный параметр.
Возвращает объект-посредник для чтения файла облака точек, если удалось открыть файл. Подробнее: IBimDataCloudPart.
```

```APIDOC
### dispose()

Метод завершает работу компонента и освобождает выделенные ресурсы.
```typescript
  dispose(): Promise<void>;
```

> __
> После завершения работы компонента чтение файлов модели и облаков точек через объекты-посредники невозможно.
```

```APIDOC
### flushMemory(options?: FlushMemoryOptions)

Метод освобождает память, выделенную компонентом, без завершения работы компонента.
```typescript
  flushMemory(options?: FlushMemoryOptions): Promise<void>;
```

где:
`options` – опции освобождения памяти. Необязательный параметр.

> __
> Метод не должен вызываться одновременно с чтением или записью файлов модели или облаков точек через объекты-посредники.
```

--------------------------------

### Get Current Camera Impulse Direction

Source: https://pilot.ascon.ru/componentkit/extensions3d/WasdNavigation

Retrieve the current combined direction of camera movement.

```typescript
getImpulseDirection(): Direction;
```

--------------------------------

### activate()

Source: https://pilot.ascon.ru/componentkit/extensions3d/BoxSelection

Activates the BoxSelectionExtension, subscribing to keyboard and mouse events.

```APIDOC
## activate()

### Description
Activates the extension. The extension subscribes to keyboard and mouse events.

### Method
```typescript
activate(): void;
```
```

--------------------------------

### Theming and Event Handling

Source: https://pilot.ascon.ru/componentkit/comparison

Methods for applying colors and managing event listeners.

```typescript
setThemingColor(dbId, color, model, recursive): void
```

```typescript
model.setColor(elementIds: string[] | string, r: number, g: number, b: number, a: number, modelPart?: string | ModelPart): void
```

```typescript
clearThemingColors(model): void
```

```typescript
model.clearColors(modelPart? : string | ModelPart): void
```

```typescript
addEventListener(type, listener, options)
```

```typescript
events.addEventListener(type: string, listener: EventListener, options?: any): void
```

```typescript
dispatchEvent(event)
```

```typescript
events.dispatchEvent(event: string | Event): void
```

```typescript
hasEventListener(type, listener)
```

```typescript
events.hasEventListener(type: string, listener: EventListener): boolean
```

```typescript
removeEventListener(type, listener)
```

```typescript
events.removeEventListener(type: string, listener: EventListener): void
```

```typescript
clearListeners(): void
```

```typescript
events.clearListeners(): void
```

--------------------------------

### ClippingDescription Guid Property

Source: https://pilot.ascon.ru/componentkit/extensions3d/ClippingPlane

An optional unique identifier for a clipping plane, useful for selective removal.

```typescript
guid?: string 

```

--------------------------------

### Open and Read Point Cloud Part

Source: https://pilot.ascon.ru/componentkit/bim-dataprovider/BimDataProvider

Opens a point cloud part from a buffer and retrieves its metadata, hierarchy, and points. Ensure the cloudbmFileBuffer is valid.

```typescript
// --- Работа с файлами облаков точек ---
// Получаем объект-посредник для чтения .cloudbm файла.
const cloudPart = await bimDataProvider.openCloudPart("uniqueCloudPartId", cloudbmFileBuffer);

// Получаем метаданные облака точек.
const metadata = cloudPart.getCloudMetadata();

// Получаем данные об иерархии октодерева облака точек.
const hierarchy = cloudPart.getCloudHierarchy();

// Получаем список точек узла октодерева.
const points = cloudPart.getCloudPoints(hierarchy[0].dataIndex, hierarchy[0].offset, hierarchy[0].size);
```

--------------------------------

### WindowStater Constructor

Source: https://pilot.ascon.ru/componentkit/reference/WindowStater

Initializes a new instance of the WindowStater class.

```APIDOC
## WindowStater Constructor

### Description
Initializes a new instance of the WindowStater class.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **savedStateOptions** (IWindowStateOptions) - An object storing properties for window operation.
- **containerToRestore** (HTMLElement) - The HTML element for which save/restore settings are applied (CSS styles). See IWindowStyle for more details.
```

--------------------------------

### Get All Model Parts

Source: https://pilot.ascon.ru/componentkit/reference3d/Model

Retrieves all loaded parts of the consolidated model. Returns an array of ModelPart objects.

```typescript
getAllModelParts(): ModelPart[];
```

--------------------------------

### Get Extensions Method Signature

Source: https://pilot.ascon.ru/componentkit/reference2d/ExtensionLoader

The signature for the getExtensions method, which returns an array of all currently loaded extensions.

```typescript
getExtensions(): Extension[] ;

```

--------------------------------

### Viewer3D Utility Methods

Source: https://pilot.ascon.ru/componentkit/reference3d/Viewer3D

Methods for capturing screenshots and retrieving viewer configuration.

```typescript
makeScreenshot(mimeType?: string, quality?: number): Promise<Blob>;
```

```typescript
getConfiguration(): Viewer3DConfiguration;
```

--------------------------------

### GizmoBuilder build() Method

Source: https://pilot.ascon.ru/componentkit/reference3d/gizmo/GizmoBuilder

Constructs a GizmoControl with default implementations. Use this method to quickly create a GizmoControl with standard translation, rotation, and scale axes.

```typescript
public static build(camera: THREE.Camera, navAgent: INavigationAgent, 
  translation: GizmoAxisDir, 
  rotation: GizmoAxisDir, 
  scale: GizmoAxisDir): GizmoControl;
```

--------------------------------

### Get All Loaded Extensions using ExtensionLoader

Source: https://pilot.ascon.ru/componentkit/reference/ExtensionLoader

Use this method to retrieve an array of all currently loaded extensions.

```typescript
getExtensions(): Extension[] ;
```

--------------------------------

### Get Control ID

Source: https://pilot.ascon.ru/componentkit/reference/Control

Retrieves the unique identifier for the control. This can be used for referencing the control in various contexts.

```typescript
getId(): string
```

--------------------------------

### Register and Use a Custom Extension

Source: https://pilot.ascon.ru/componentkit/reference2d/ExtensionManager

Defines a custom extension by inheriting from PilotWeb2D.Extension and then registers it with the ExtensionManager using a unique ID. This allows the extension to be loaded later.

```javascript
// описываем расширение
class MyExtension extends PilotWeb2D.Extension {
  ...
}
// регистрируем
PilotWeb2D.theExtensionManager.registerExtensionType('myExtension', MyExtension);

```

--------------------------------

### GizmoControl Methods

Source: https://pilot.ascon.ru/componentkit/reference3d/gizmo/GizmoControl

Details the methods available for interacting with the GizmoControl instance.

```APIDOC
## Methods

### attachTo()

Attaches `GizmoControl` to a 3D object in the scene. The control synchronizes its position with the object's position, and manipulations on `GizmoControl` affect the associated object's position.
If `GizmoControl` is added as a child, it is placed at the origin of the attachment object's local space by default. Use .updateGizmoOffset() to offset `GizmoControl` relative to the attachment object.

```typescript
attachTo(object: THREE.Object3D, asChild = false): void;
```

Parameters:
`object` – The attachment object.
`asChild` – Parameter indicating whether to add `GizmoControl` as a child of the object. Optional parameter, defaults to `false`.
If `asChild` is `true`, `GizmoControl` does not need to be added to the scene manually. It will be automatically placed on the same scene as the parent object. Otherwise, `GizmoControl` must be manually added to the desired scene and its coordinates set.

### detach()

Detaches `GizmoControl` from the attachment object, if an attachment exists.

```typescript
detach(): void;
```

### updateGizmoOffset()

Sets the offset and rotation of `GizmoControl` relative to the attachment object.

```typescript
updateGizmoOffset(position?: THREE.Vector3, quaternion?: THREE.Quaternion): void;
```

Parameters:
`position` – The position of `GizmoControl` in the local coordinates of the attachment object. Optional parameter. See: THREE.Vector3.
`quaternion` – The rotation of `GizmoControl` in the local coordinates of the attachment object. Optional parameter. See: THREE.Quaternion.

### addAxis()

Adds a new manipulation axis to `GizmoControl`.

```typescript
addAxis(axis: GizmoAxis): void;
```

Parameters:
`axis` – The controller axis. See: GizmoAxis.

### dispose()

Frees resources allocated by the controller, breaks the attachment, and removes `GizmoControl` from the scene.

```typescript
dispose(): void;
```
```

--------------------------------

### Get Hidden Model Parts

Source: https://pilot.ascon.ru/componentkit/reference3d/Model

Retrieves all hidden parts of the consolidated model. Returns an array of ModelPart objects.

```typescript
getHiddenModelParts(): ModelPart[]
```

--------------------------------

### Select Component Methods

Source: https://pilot.ascon.ru/componentkit/reference/Select

Methods available for the Select component.

```APIDOC
## Select Component Methods

### onChange()
Subscribe to the event of the selected value changing in the list.

#### Parameters
- **index** (number) - The index of the selected value.
- **value** (string) - The value of the list item.

### update()
Method to update the list items.

#### Parameters
- **array** (ISelectItem []) - Array of new items. See ISelectItem for details.
- **selectedIndex** (number) - The item selected in the new list.
```

--------------------------------

### Get ComboButton SubMenu

Source: https://pilot.ascon.ru/componentkit/reference/ComboButton

Access the ContextMenu object associated with the ComboButton. This property returns the context menu instance.

```typescript
get subMenu(): ContextMenu;
```

--------------------------------

### Toolbar Methods

Source: https://pilot.ascon.ru/componentkit/reference/Toolbar

Methods for managing toolbar layout and control elements.

```APIDOC
## changeToolbarPosition(direction: string)

### Description
Changes the toolbar position to the specified direction.

### Parameters
- **direction** (string) - Required - The target position direction.

## changeToolbarContentAlignment(content: ToolbarContentAlignment)

### Description
Changes the content alignment order within the toolbar.

### Parameters
- **content** (ToolbarContentAlignment) - Required - The alignment configuration.

## addControl(control: Control, index: number)

### Description
Adds a control element to the toolbar at the specified index.

### Parameters
- **control** (Control) - Required - The control object to add.
- **index** (number) - Optional - The position index (default: 0).

## addDropdown(id: string, tooltip: string, positionIndex: number, selectedIndex: number, dropdownEmitter: Control, controls: Control[], itemClicked: Function)

### Description
Adds a dropdown menu to the toolbar.

### Parameters
- **id** (string) - Required - Element identifier.
- **tooltip** (string) - Required - Tooltip text.
- **positionIndex** (number) - Optional - Position index (default: 0).
- **selectedIndex** (number) - Required - Index of selected item (-1 if none).
- **dropdownEmitter** (Control) - Required - Trigger element for the menu.
- **controls** (Control[]) - Required - List of menu items.
- **itemClicked** (Function) - Required - Callback for item click events.

## removeControl(id: string)

### Description
Removes a control element from the toolbar by its ID.

### Parameters
- **id** (string) - Required - The identifier of the control to remove.
```

--------------------------------

### Button Caption Property

Source: https://pilot.ascon.ru/componentkit/reference/Button

Use the caption property to set or get the name of the button. This property is of type string.

```typescript
caption: string;
```

--------------------------------

### GizmoObject Constructor

Source: https://pilot.ascon.ru/componentkit/reference3d/gizmo/IGizmoObject

Constructor for initializing GizmoObject with meshes and materials.

```typescript
  constructor(protected _meshes: THREE.Mesh[], 
    readonly baseMaterial: THREE.Material,
    readonly hoverMaterial: THREE.Material,
    readonly activeMaterial: THREE.Material
  );
```
Tokens:
Raw