Threedy

https://docs.threedy.io/3.11.4/
Admin
Threedy provides instant3Dhub, a platform for 3D data visualization, collaboration, and integration,...
Tokens:116,419
Snippets:1,419
Trust Score:8.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Execute the installation script

Source: https://docs.threedy.io/3.11.4/doc/integration/INSTALL_SINGLE_NODE.html

Run the installation script after configuring the necessary environment variables in the setup file.

```bash
./install.sh
```

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

### Install Helm

Source: https://docs.threedy.io/3.11.4/doc/integration/INSTALL_K8S.html

Download and install the Helm CLI tool.

```bash
curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 \
 && chmod 700 get_helm.sh \
 && ./get_helm.sh
```

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

### Default Render Setup

Source: https://docs.threedy.io/3.11.4/doc/webvis/enums/ViewerSettingStrings.html

The default render setup configuration.

```text
RenderSetup.LOCAL
```

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

### startXRPlayback()

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/RealityAPI.html

Starts the XR playback.

```APIDOC
## startXRPlayback()

### Description
Start the XR playback. Ensure the playback source is set before calling. Triggers a XRPlaybackStateChangedEvent.
```

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

### Deploy instant3Dhub

Source: https://docs.threedy.io/3.11.4/doc/integration/INSTALL_K8S.html

Install the instant3Dhub chart with required configuration parameters.

```bash
helm install [release-name] instant3dhub/instant3dhub \
  --set license.serialKey=key-here \
  --set storage.class=your-storage-class \
  --set entrypoints={https://proxy.yourdomain.com} \
  --set registry=registry.yourdomain.com
```

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

### Start License Server with Remote Database

Source: https://docs.threedy.io/3.11.4/doc/integration/LICENSE_SERVER.html

Starts the License Server service configured for an externally managed database.

```bash
systemctl start instant3DhubLicenseServerRemoteDB.service
systemctl status instant3DhubLicenseServerRemoteDB.service
```

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

### Install Ansible package

Source: https://docs.threedy.io/3.11.4/doc/integration/TOOLS_ANSIBLE.html

Install the Ansible package and verify the installation version.

```bash
yum -y install ansible
ansible --version

```

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

### Install PostgreSQL on Ubuntu

Source: https://docs.threedy.io/3.11.4/doc/integration/LICENSE_SERVER.html

Install the required PostgreSQL version 14 and its contributions.

```bash
apt install -y postgresql-14 postgresql-contrib
```

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

### Update system and install EPEL repository

Source: https://docs.threedy.io/3.11.4/doc/integration/TOOLS_ANSIBLE.html

Run these commands on a clean CentOS 7 installation to prepare the environment.

```bash
yum -y update
yum -y install epel-release
yum -y update

```

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

### Set label example

Source: https://docs.threedy.io/3.11.4/doc/webvis/types/AnnotationData.html

Example value for the label property.

```json
"This is a great annotation!"
```

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

### InstanceGraphAPI Quick Start

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/InstanceGraphAPI.html

Demonstrates basic node creation, custom property registration, and property access within the InstanceGraph.

```javascript
// Get the context
const context = webvis.getContext();

// Add a new node to the InstanceGraph
const nodeId = context.add(
{
    dataURI: "urn:x-i3d:shape:box",
    label: "My node",
    initialProperties: { enabled: true }
});

// Register a custom property
context.registerCustomProperty("myCustomProperty", 0);

// Getting and setting properties
await context.setProperty(nodeId, "myCustomProperty", 42);
const [label, customProp] = await context.getProperties(nodeId, [webvis.Property.LABEL, "myCustomProperty"]);

console.log(label, customProp); // My node 42
```

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

### Initialize and Start PostgreSQL Service

Source: https://docs.threedy.io/3.11.4/doc/integration/LICENSE_SERVER.html

Initializes the database and manages the PostgreSQL service via systemd.

```bash
/usr/pgsql-14/bin/postgresql-14-setup initdb
systemctl start postgresql-14
systemctl enable postgresql-14
systemctl status postgresql-14
```

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

### Install PostgreSQL 14

Source: https://docs.threedy.io/3.11.4/doc/integration/LICENSE_SERVER.html

Installs the required PostgreSQL 14 server and contribution packages.

```bash
yum install -y postgresql14
yum install -y postgresql14-server
yum install -y postgresql14-contrib
```

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

### Convert and Install License Server

Source: https://docs.threedy.io/3.11.4/doc/integration/LICENSE_SERVER.html

Convert the RPM package to DEB format using alien and install it via dpkg.

```bash
alien /root/source_files/license_server_ubuntu/instant3Dhub-licenseServer-CentOS-Linux-7-x64.x.x.rpm
```

```bash
dpkg -i /root/source_files/license_server_ubuntu/instant3dhub-licenseserver-centos-linux-7-x64_x.x-2_amd64.deb
```

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

### Logical Key Examples

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/QueryAPI.html

Examples of using logical operators within the conditions block.

```json
{"or": [{"nodeId": 15}, {"nodeId": 16}]}
```

```json
{"and": [{"metadata": "auxProperties.sizeA", "equals": 15}, {"metadata": "auxProperties.sizeB", "equals": 20}]}
```

```json
{"not": {"metadata": "sizeA", "equals": 15}}
```

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

### Webvis Initialization URL

Source: https://docs.threedy.io/3.11.4/tutorials/webvis_concepts/resources.html

Example of a URL used to initialize a 3D session with a specific resource via the initData parameter.

```url
https://example.instant3dhub.org/examples/webvis-app.html?initData=http://data.instant3dhub.org/repo/step/bloodhound/Bloodhound_SSC.stpx
```

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

### requestSupportedRenderSetups

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/HubAPI.html

Request all supported render setups available from the backend.

```APIDOC
## requestSupportedRenderSetups()

### Description
Request all supported render setups if one or more are available. The render setup is a key value pair where the key is the name of the render setup and the value could be used as an input value for the ViewerSettingStrings.RENDER_SETUP setting.

### Returns
Promise<{ name: string; value: string }[]> - A promise containing the list of supported render setups.
```

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

### Instantiate a primitive 3D model

Source: https://docs.threedy.io/3.11.4/tutorials/dev_tutorials/tutorials/webvis.html

Example of loading a specific primitive shape using the webvis-full component.

```html
<webvis-full autoplay src="urn:x-i3d:shape:box"></webvis-full>
```

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

### showXRBackgroundFeed()

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/RealityAPI.html

Starts putting the image feed into the viewer's background.

```APIDOC
## showXRBackgroundFeed()

### Description
Starts putting the image feed into the viewer's background. Triggers a XRStateChangedEvent.

### Returns
- **Promise<void>** - Resolves when the operation is successful.
```

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

### Set anchorPosition example

Source: https://docs.threedy.io/3.11.4/doc/webvis/types/AnnotationData.html

Example value for the anchorPosition property.

```json
[0, 1, 0]
```

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

### Enable Grafana via Helm

Source: https://docs.threedy.io/3.11.4/doc/integration/INSTALL_GRAFANA.html

Use Helm command-line flags to enable tracing and Grafana during installation.

```bash
# helm chart parameter
helm install --set tracing.withIntegrated.enabled=true --set tracing.withIntegrated.grafana.enabled=true ...
```

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

### Configure entrypoints in values.yaml

Source: https://docs.threedy.io/3.11.4/doc/integration/INSTALL_PROXY_GUIDE.html

Set the external URL path for the instant3Dhub installation to ensure internal components correctly resolve backend addresses.

```yaml
# entrypoints in values.yaml
entrypoints: [ "https://example-proxy-server/extra/path/" ]
```

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

### Invoke PostgreSQL Playbooks

Source: https://docs.threedy.io/3.11.4/doc/integration/INSTALL_EXT_POSTGRES_GUIDE.html

Execute the installation and initialization playbooks using the defined inventory.

```bash
ansible-playbook -i hosts.yml ./PostgreSQL/pgsql.install.i3dhub3.yml
ansible-playbook -i hosts.yml ./PostgreSQL/pgsql.init.i3dhub3.yml
```

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

### Set labelPosition example

Source: https://docs.threedy.io/3.11.4/doc/webvis/types/AnnotationData.html

Example value for the labelPosition property.

```json
[0, 2, 0]
```

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

### QueryAPI Usage Example

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/QueryAPI.html

Demonstrates executing asynchronous queries using the context object.

```typescript
const queryLabels = await context.query({ select: ['nodeId', 'label'], conditions: [{ nodeType: 'aux' }, { metadata: 'auxProperties.pmiType', equals: 'ModelView' }] }); const queryPMIType = await context.query({ select: ['nodeId', 'auxProperties.pmiType'], conditions: [{ nodeType: 'aux' }, { metadata: 'auxProperties.pmiType', equals: 'ModelView' }] });
```

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

### Result Specification Example

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/QueryAPI.html

Example mapping of a select specification to the returned result array structure.

```json
select: ["nodeId", "metadata.auxAttributes"]
```

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

### Download and Install License Server RPM

Source: https://docs.threedy.io/3.11.4/doc/integration/LICENSE_SERVER.html

Downloads the specific RPM package and installs it using the yum package manager.

```bash
wget https://repo.threedy.io/licenseserver/23.1/instant3Dhub-licenseServer-CentOS-Linux-7-x64.24.2.rpm
yum install -y ./instant3Dhub-licenseServer-CentOS-Linux-7-x64.24.2.rpm
```

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

### resetUserSettings()

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/SettingsAPI.html

Resets all user settings to their installation defaults.

```APIDOC
### resetUserSettings

#### Description
Resets all user settings to the installation default.

#### Returns
- **void**
```

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

### Reference nginx proxy configuration

Source: https://docs.threedy.io/3.11.4/doc/integration/INSTALL_PROXY_GUIDE.html

Example nginx configuration for proxying traffic to an instant3Dhub instance running on a specific port.

```nginx
user nginx;
worker_processes  3;
error_log  /var/log/nginx/error.log info;
events {
  worker_connections  10240;
}

http {
  access_log  /var/log/nginx/access.log;
  server {
  client_max_body_size 100M;
  listen  80;
  proxy_read_timeout 7d;
  proxy_http_version 1.1;
  location ~ /hubproxy/(.*) {
    proxy_pass http://146.140.211.12:30101/$1$is_args$args;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "Upgrade";
  }
  client_body_temp_path      /var/cache/nginx/client_body_temp;
  proxy_temp_path            /var/cache/nginx/proxy_temp;
  fastcgi_temp_path          /var/cache/nginx/fastcgi_temp;
  uwsgi_temp_path            /var/cache/nginx/uwsgi_temp;
  scgi_temp_path             /var/cache/nginx/scgi_temp;
  }
}
```

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

### startXRSpectate(sessionMemberId: number)

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/RealityAPI.html

Starts spectating the XRImage stream published by a session member.

```APIDOC
## startXRSpectate(sessionMemberId: number)

### Description
Starts spectating the XRImage stream published by the session member with the specified ID.

### Parameters
- **sessionMemberId** (number) - Required - The session member id to spectate.

### Returns
- **Promise<void>** - Resolves when the operation is successful.
```

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

### resetSetting(setting: ViewerSettingStrings | SettingStrings)

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/SettingsAPI.html

Resets a specific setting to its installation default value.

```APIDOC
### resetSetting

#### Description
Resets the value of a setting to the installation default.

#### Parameters
- **setting** (ViewerSettingStrings | SettingStrings) - Required - The name of the setting that should be reset.

#### Returns
- **void**
```

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

### Query Examples for Node Selection

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/QueryAPI.html

Various JSON query structures for selecting nodes based on metadata, topological handles, and specific attribute conditions.

```json
{ "select": [ "nodeId" ], "conditions": [ { "nodeType": "aux" }, { "faceHandle": { "entityType": 1, "shapeInstanceID": 2, "entityID": 814 } }, { "not": [ { "metadata": "auxProperties.pmiType", "equals": "Revision Index" } ] } ] }
```

```json
{ "select": [ "topoHandle" ], "conditions": [ { "nodeType": "aux" }, { "nodeId": 2502 } ] }
```

```json
{ "select":["nodeId", "metadata.auxProperties.label"], "conditions":[ {"nodeType": "aux"}, {"metadata": "auxProperties.pmiType", "equals": "Dimension"}, {"metadata": "auxProperties.type", "equals": "Diameter"}, {"metadata": "auxProperties.value", "greaterThan": 5.5} ] }
```

```json
{ "select": [ "nodeId", "metadata.auxProperties.label" ], "conditions": [ { "nodeType": "aux" }, { "metadata": "auxProperties.pmiType", "equals": "ModelView" }, { "metadata": "auxProperties.label", "equals": "2_51_*" } ] }
```

```json
{ "select": [ "nodeId", "metadata.auxProperties.*" ], "conditions": [ { "nodeType": "aux" }, { "metadata": "auxProperties.pmiType", "equals": "Dimension" }, { "metadata": "auxProperties.fit", "equals": "h8", "caseSensitive": true } ] }
```

```json
{ "select":["nodeId"], "conditions":[ {"nodeType": "aux"}, {"metadata": "auxAttributes.precision", "greaterThan": 2}, {"metadata": "auxAttributes.originAnchor", "equals": 4}, ] }
```

```json
{ "select": [ "nodeId", "metadata.auxAttributes.label" ], "conditions": [ { "nodeType": "aux" }, { "metadata": "auxProperties.pmiType", "equals": "DatumFeatureSymbol" }, { "metadata": "auxAttributes.label", "equals": { "select": [ "metadata.auxProperties.propertyName" ], "conditions": [ { "nodeType": "aux" }, { "metadata": "auxProperties.pmiType", "equals": "frame" }, { "nodeId": 7522 } ] } } ] }
```

```json
{ "select": [ "nodeId" ], "conditions": [ { "nodeType": "aux" }, { "metadata": "auxProperties.pmiType", "equals": "ModelView" }, { "pointsTo": 323 } ]
```

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

### Connect to XR System with Default Configuration

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/RealityAPI.html

Initializes the XR system using default settings to enable camera streaming and model tracking.

```javascript
await webvis.getContext().connectXR();
```

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

### License Server Configuration File

Source: https://docs.threedy.io/3.11.4/doc/integration/LICENSE_SERVER.html

Sample configuration file for the License Server located at /opt/instant3Dhub.custom/license_config.yml.

```yaml
# whether to use the BIOS ID of the current machine when performing host checks
use-bios-uuid: false

# license key to use
serial-key: YOUR_LICENSE_KEY_HERE

# interface and port to listen on
address: 0.0.0.0:8200

# log level to use. options: fatal panic error warning info debug trace
log-level: warning

# location of the license file
licenseFile: /opt/instant3Dhub.custom/license.xml

# location of tls certificate
tls-cert:

# location of tls private key
tls-key:

# postgres backend options
postgres:
  # connection string describing the postgres location and user. the given
  # user must have permissions to create schemas, tables and stored procedures.
  # expected format is the URI format described here: https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING
  connection-string: postgresql://postgres:postgres@localhost:5432/postgres?sslmode=disable

  # user to use once migrations are complete. this user also receives table write permissions during migrations
  # by default the user from the connection string is also used during runtime.
  runtime-user:

  # password for the runtime user to allow switching to this user once migrations are complete
  # this value must be given if a runtime user is also provided
  runtime-password:
```

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

### Load 3D resource via URL parameters

Source: https://docs.threedy.io/3.11.4/tutorials/dev_tutorials/tutorials/webvis.html

Configure the webvis instance by passing the initData and autoplay parameters directly in the page URL.

```text
http://somehost/some-page.html?initData=urn:x-i3d:shape:key&autoplay
```

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

### Configure and Connect XR Playback

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/RealityAPI.html

Sets up the XR configuration with a playback source and connects to the XR system.

```javascript
const xrPlaybackConfiguration = {
  imageSourceConfig: {
   type: webvis.XRImageSource.PLAYBACK,
   url: "https://example.com/manifest.json",
   autoPlay: true // Start playback automatically, default is false
  }
};
await ctx.connectXR(xrPlaybackConfiguration);
```

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

### Configure Heatmap Data

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/ViewerHeatmapAPI.html

Demonstrates how to initialize a viewer context, add a model, and create a heatmap with specific positions and configuration settings.

```javascript
// get an instance of the ContextAPI and the matching ViewerAPI
const context = webvis.getContext();
const viewer = context.getViewer();

// add the model
const model = context.add({ dataURI: MODEL, initialProperties: { enabled: true } });

// add matching heatmap data
const heatmapPositions = [
  0, 1, 0, // first point
  0, 1, 1, // second point
  0, 0, 2, // third point
];
const heatmapDataId = viewer.createHeatmap({ position: heatmapPositions });

// configure the heatmap
viewer.configureHeatmap({
  // set a color scheme
  colorScheme: "Blackbody",
  // calculated density is normalized, upper end of color scheme is mapped to maxValue
  maxValue: 100,
}
```

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

### Create License Server User

Source: https://docs.threedy.io/3.11.4/doc/integration/LICENSE_SERVER.html

Add the required system user if the service fails to launch.

```bash
adduser -u 901 --gecos "" --disabled-password instant3dhub
```

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

### Create and Manage Materials

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/MaterialAPI.html

Demonstrates the full lifecycle of a material, including creation, assignment to a node, updating properties, and removal.

```javascript
// Get the webvis context
const context = webvis.getContext();

// Create a node to assign the material to and enable the resource to make it visible
const nodeId = context.add({dataURI: "urn:x-i3d:shape:box", initialProperties: {enabled: true}});

// Create a material
const materialId = context.createMaterial({
     baseColor: [1, 0, 0],
     opacity: 1,
     roughness: 0.5,
     metallic: 0,
     name: "Red Material",
});

// Create an appearance URI which can be used to assign the material to a node
const appearanceURI = `urn:X-l3d:material:${materialId}`;

// Assign the material to the previously added node via the APPEARANCE_URI property
await context.setProperty(nodeId, webvis.Property.APPEARANCE_URI, appearanceURI);

 // Change the base color and the name of the material
context.changeMaterial(materialId, {
     baseColor: [0, 1, 0],
     name: "Green Material"
 });

// Unassign the material from the node
await context.setProperty(nodeId, webvis.Property.APPEARANCE_URI, null);

// Remove the material if no longer required
context.removeMaterial(materialId);
```

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

### Supported color formats

Source: https://docs.threedy.io/3.11.4/tutorials/dev_tutorials/tutorials/modifying.html

Examples of predefined color URNs supported by the system.

```text
urn:X-l3d:color:red
urn:X-l3d:color:rgb:ff0000
urn:X-l3d:color:rgba:ff0000ff
```

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

### Define ContentType properties

Source: https://docs.threedy.io/3.11.4/doc/webvis/types/ContentType.html

Examples of individual property values for a ContentType object.

```typescript
"http://www.web3d.org"
```

```typescript
"x3d-xml"
```

```typescript
"X3D, XML Encoding"
```

```typescript
["model/x3d+xml", "model/x3d"]
```

```typescript
"ISO/IEC IS 19775-1:2013"
```

```typescript
["x3d", "x3dz", "x3z"]
```

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

### Deploy instant3Dhub via Helm

Source: https://docs.threedy.io/3.11.4/doc/integration/INSTALL_WINDOWS.html

Deploys the instant3Dhub application to the i3dhub namespace with required configuration parameters.

```bash
helm install -n i3dhub --create-namespace i3dhub-windows instant3dhub/instant3dhub \
  --set licenseServer=http://license.yourdomain.com:8200 \
  --set storage.class=hostpath \
  --set entrypoints={http://localhost:30042} \
  --set registry=images.threedy.io
```

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

### URN to URL Translation Example

Source: https://docs.threedy.io/3.11.4/tutorials/webvis_concepts/resources.html

Shows the relationship between a location-independent URN and its corresponding URL.

```text
URL: www.website.de/models/cube
URN: urn:x-i3d:shape:cube
```

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

### Clone the release repository

Source: https://docs.threedy.io/3.11.4/doc/integration/INSTALL_SINGLE_NODE.html

Download the deployment scripts from the official release repository and navigate to the single-node directory.

```bash
git clone https://repo.threedy.io/instant3Dhub/release.git
cd release/reference/singleNode/
```

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

### enterXRInitMode

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/RealityAPI.html

Enters the XR initialization mode for model-based tracking.

```APIDOC
## enterXRInitMode(xrInitOptions?: XRInitOptions): Promise<void>

### Description
Enter the XR initialization mode. The initialization mode is used as an entry point for model-based tracking. It unanchors any previously anchored model and starts the model-based tracking process.

### Parameters
- **xrInitOptions** (XRInitOptions) - Optional - The options for the XR initialization mode.

### Returns
- **Promise<void>** - Returns a Promise which resolved when the operation was successful or rejects in an error case.
```

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

### getXRCapabilities()

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/ContextAPI.html

Get the array of XRCapability. The array of capabilities determines what parts of the API can be used.

```APIDOC
## getXRCapabilities()

### Description
Get the array of XRCapability. The array of capabilities determines what parts of the API can be used. The capabilities are mostly defined by the used device.

### Returns
- **XRCapability[]** - Returns an Array<XRCapability> containing the XR system's capabilities.
```

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

### registerFrameListener

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/FrameAPI.html

Registers a listener function which gets called once per internal update tick.

```APIDOC
## registerFrameListener(listener: FrameListener): void

### Description
Registers a listener function which gets called once per internal update tick.

### Parameters
- **listener** (FrameListener) - Required - The listener to register.

### Returns
- **void**
```

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

### Configure Viewer settings

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/ViewerAPI.html

Pass initial settings during viewer creation or modify them at runtime using changeSetting.

```javascript
const viewerSettings = {
  [ViewerSettingStrings.RENDER_MODE]: RenderMode.Topology,
  [ViewerSettingStrings.CAMERA_FIELD_OF_VIEW]: 60,
  // and other initial settings you would like to set ...
};
const viewer = webvis.getContext().createViewer("viewer-id", undefined, viewerSettings);
```

```javascript
viewer.changeSetting(ViewerSettingStrings.RENDER_MODE, RenderMode.Faces);
console.log(viewer.readSetting(ViewerSettingStrings.RENDER_MODE));
viewer.resetSetting(ViewerSettingStrings.RENDER_MODE);
```

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

### Define Ansible Inventory

Source: https://docs.threedy.io/3.11.4/doc/integration/INSTALL_EXT_POSTGRES_GUIDE.html

Create a hosts.yml file to define the local host for the Ansible installation process.

```yaml
hubs:
  hosts:
    localhost:
  vars:
    ansible_connection: local
```

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

### Extract Ansible Playbooks

Source: https://docs.threedy.io/3.11.4/doc/integration/INSTALL_EXT_POSTGRES_GUIDE.html

Unzip the provided archive containing the Ansible playbooks required for PostgreSQL installation.

```bash
tar zxvf ./instant3Dhub-ansible-*.tgz
```

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

### requestContext(name, settings)

Source: https://docs.threedy.io/3.11.4/doc/webvis/functions/requestContext.html

Initializes a context with the specified name and optional configuration settings.

```APIDOC
## requestContext(name, settings)

### Description
Initializes a new context with a given name and an optional settings object. This function returns a promise that resolves to a ContextAPI instance or undefined.

### Parameters
- **name** (string) - Required - The name of the context.
- **settings** (object) - Optional - A configuration object containing various viewer, rendering, and session settings (e.g., backgroundColor, navigationMode, xrFusionMode).

### Returns
- **Promise<ContextAPI | undefined>** - A promise that resolves to the ContextAPI or undefined if the context could not be created.
```

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

### Create and manage text attachments

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/AttachmentAPI.html

Demonstrates the basic workflow of creating an attachment, setting its data, and fetching it back.

```javascript
const context = webvis.getContext();

// Create a new attachment
const attachmentId = context.createAttachment(webvis.AttachmentType.TEXT);

// Set the attachment data
context.setAttachmentData(attachmentId, "hello world");

// Fetch the attachment data
await context.fetchAttachmentData(attachmentId); // returns "hello world"
```

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

### Manage Point Clouds with ViewerPointCloudAPI

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/ViewerPointCloudAPI.html

Demonstrates the lifecycle of a point cloud, including creation, property modification, and removal.

```javascript
// get an instance of the ContextAPI and the matching ViewerAPI
const context = webvis.getContext();
const viewer = context.getViewer();

// define a list of cloud points to visualize
const points = [
  { position: [0, 1, 0], color: [1, 0, 0, 1] }, // first point
  { position: [0, 1, 1], color: [1, 0, 0, 1] }, // second point
  { position: [0, 0, 2], color: [1, 0, 0, 1] }, // third point
];

// create a point cloud
const pointCloudId = viewer.createPointCloud(points, { enabled: true });

// change the scale of the point cloud
viewer.changePointCloud(pointCloudId, { scale: 2.0 });

// remove the point cloud
viewer.removePointCloud(pointCloudId);
```

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

### Implement basic React routing with webvis

Source: https://docs.threedy.io/3.11.4/tutorials/dev_tutorials/tutorials/initialization.html

Demonstrates a simple React application switching between a 3D view and an info tab using react-router-dom.

```javascript
import React from 'react';
import { BrowserRouter as Router, Switch, Route, Link } from 'react-router-dom';

function WebvisTab() {
  // This is not the most performant way for illustration purposes:
  return <webvis-viewer></webvis-viewer>;
}

function InfoTab() {
  return <p>Additional information</p>;
}

function App() {
  return (
    <Router>
      <div>
        <nav>
          <ul>
            <li>
              <Link to="/3d">3D View</Link>
            </li>
            <li>
              <Link to="/info">Additional Information</Link>
            </li>
          </ul>
        </nav>

        <Switch>
          <Route path="/3d" component={WebvisTab} />
          <Route path="/info" component={InfoTab} />
        </Switch>
      </div>
    </Router>
  );
}
```

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

### Define LINE_SEGMENT measurement target data

Source: https://docs.threedy.io/3.11.4/doc/webvis/enums/MeasurementTargetClass.html

Format for specifying a 3D line segment using start and end coordinates.

```text
[[start_x, start_y, start_z], [end_x, end_y, end_z]]
```

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

### Create Contexts and Add Models

Source: https://docs.threedy.io/3.11.4/tutorials/dev_tutorials/tutorials/initialization.html

Demonstrates asynchronous creation of multiple contexts and adding shapes to them using the webvis API.

```javascript
<script type="module">
    const myContext = await webvis.requestContext("my_context");
    const mySecondContext = await webvis.requestContext("my_context_2");

    myContext.add("urn:x-i3d:shape:box"); // Adds a box to the first context
    mySecondContext.add("urn:x-i3d:shape:box"); // Adds a box to the second context
</script>
```

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

### Configure language via webvis.config.json

Source: https://docs.threedy.io/3.11.4/tutorials/dev_tutorials/tutorials/settings.html

Define application-specific settings by placing a webvis.config.json file in the same directory as the document.

```json
{
    "language": "de"
}
```

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

### Registering Annotation Listeners for Node Changes

Source: https://docs.threedy.io/3.11.4/special_content/3_8_0_migration-guide.html

Example implementation for listening to node property changes and removal events to update or remove annotations accordingly.

```typescript
// Listen to property changes of the connected Node and reflect them to the annotation.
myContext.registerListener([webvis.EventType.NODE_CHANGED], (e : webvis.NodeChangedEvent) =>
{
    if ( e.property === webvis.Property.GLOBAL_TRANSFORM )
    {
        const inverseOldTrafo   : mat4 = mat4.invert(mat4.create(), e.oldValue),
              deltaTrafo        : mat4 = mat4.multiply(mat4.create(), e.newValue, inverseOldTrafo),
              newAnchorPosition : vec3 = vec3.transformMat4(vec3.create(), oldAnchorPosition, deltaTrafo);

        myContext.changeAnnotation( myAnnotationId, {
            anchorPosition : newAnchorPosition
        } );
    }
    else if ( e.property === webvis.Property.ENABLED )
    {
        myContext.changeAnnotation( myAnnotationId, {
            enabled : e.newValue === 1
        } );
    }
}, connectedNodeId, false));

// Listen to the removal of the connected Node and remove the annotation as well.
myContext.registerListener([webvis.EventType.NODE_REMOVED], (e : webvis.NodeRemovedEvent) =>
{
    myContext.removeAnnotation( myAnnotationId );
}, connectedNodeId, false));
```

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

### Download License Server Package

Source: https://docs.threedy.io/3.11.4/doc/integration/LICENSE_SERVER.html

Retrieve the CentOS RPM package for the License Server.

```bash
wget https://repo.threedy.io/licenseserver/23.1/instant3Dhub-licenseServer-CentOS-Linux-7-x64.x.x.rpm
```

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

### Export usage for a specific time interval

Source: https://docs.threedy.io/3.11.4/doc/integration/LICENSE_SERVER_USAGE.html

Specify start and end Unix timestamps as query parameters to export usage data for a defined period.

```bash
curl "http://your.license.server:8200/usage/export?start=1656626400&end=1659218400"
```

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

### GET /usage/export

Source: https://docs.threedy.io/3.11.4/doc/integration/LICENSE_SERVER_USAGE.html

Retrieves a ZIP archive containing usage statistics from the license server. Supports optional time-based filtering using Unix timestamps.

```APIDOC
## GET /usage/export

### Description
Downloads a zip file containing usage statistics. Optionally filter the export by providing a start and end time range.

### Method
GET

### Endpoint
http://your.license.server:8200/usage/export

### Parameters
#### Query Parameters
- **start** (integer) - Optional - Unix timestamp representing the start of the export interval.
- **end** (integer) - Optional - Unix timestamp representing the end of the export interval.

### Request Example
curl "http://your.license.server:8200/usage/export?start=1656626400&end=1659218400"
```

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

### Manage node selection with SelectionAPI

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/SelectionAPI.html

Demonstrates basic selection operations including adding a node, querying the selection list, and clearing the selection.

```javascript
const context = webvis.getContext()

// add node with ID 5 to the selection
await context.addToSelection(5)

// get selected nodes
context.getSelectedNodes() // returns [5]

// clear the selection
await context.clearSelection()
```

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

### Manage License Server Service

Source: https://docs.threedy.io/3.11.4/doc/integration/LICENSE_SERVER.html

Restart and check the status of the License Server service.

```bash
systemctl restart instant3DhubLicenseServer{RemoteDB}.service
systemctl status instant3DhubLicenseServer{RemoteDB}.service
```

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

### Customize Context Menu with CONTEXT_MENU_FUNCTION

Source: https://docs.threedy.io/3.11.4/doc/webvis/enums/SettingStrings.html

Examples of functions to modify context menu entries, such as filtering, reordering, or adding custom commands. Note that this setting is deprecated in favor of UISetting.CONTEXT_MENU_FUNCTION.

```javascript
function(defaultEntries){return defaultEntries}
```

```javascript
function(defaultEntries){ firstEntryPosition = 1; defaultEntries.splice(firstEntryPosition - 1, 1); return defaultEntries; }
```

```javascript
function(defaultEntries){ firstEntryPosition = 1; secondEntryPosition = 2; firstEntry = defaultEntries.splice(firstEntryPosition - 1, 1)[0]; defaultEntries.splice(secondEntryPosition - 1, 0, firstEntry); return defaultEntries; }
```

```javascript
function(defaultEntries){ secondEntryPosition = 2; secondEntryDefaultCommand = defaultEntries[secondEntryPosition - 1].command; defaultEntries[secondEntryPosition - 1].command = function(nodeId, pickInfo){ console.log("Second Entry was Executed", nodeId, pickInfo); webvis.getProperty(nodeId, "label").then( function(label){ webvis.postInfo("
Node:| " + nodeId + "  
---|---  
Label:| " + label + "  
2D Coords:| " + pickInfo.canvasCoords + "  
3D Pos:| " + pickInfo.position)+"  
"; }); secondEntryDefaultCommand(); }; return defaultEntries; }
```

```javascript
function(defaultEntries){ newEntry = { label : "Set Current Language", subEntries : [ { label : "English", command : function(){webvis.changeSetting("language", "en")} }, { label : "Deutsch", command : function(){webvis.changeSetting("language", "de")} }, { label : "Español", command : function(){webvis.changeSetting("language", "es")} } ] }; newEntryPosition = 3; defaultEntries.splice(newEntryPosition - 1, 0, newEntry); return defaultEntries; }
```

```javascript
function (defaultEntries) { const newEntry = { label : "Custom entry visible only when condition is fulfilled" , command : function(nodeID){webvis.postInfo("Custom entry clicked on Aux node:" + nodeID + "!!!")} , condition : function(nodeID){return webvis.getNodeType(nodeID) == webvis.NodeType.AUX} }; defaultEntries.push(newEntry); return defaultEntries; }
```

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

### Configure language via webvis-config element

Source: https://docs.threedy.io/3.11.4/tutorials/dev_tutorials/tutorials/settings.html

Initialize configuration directly in the UI by providing a JSON-formatted innerText within a webvis-config tag.

```html
<webvis-config>
  {
     "language": "de"
  }
</webvis-config>
```

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

### Define License File Path

Source: https://docs.threedy.io/3.11.4/doc/integration/LICENSE_SERVER.html

The target location for the license.xml file on the server.

```text
/opt/instant3Dhub.custom/license.xml
```

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

### importConfig(config: object): void

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/SettingsAPI.html

Imports a full configuration object to apply multiple settings at once.

```APIDOC
## importConfig

### Description
Applies a configuration object containing various viewer settings such as rendering modes, navigation speeds, and session parameters.

### Parameters
- **config** (object) - An object containing optional configuration keys like backgroundColor, navigationMode, renderMode, etc.
```

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

### createClippingRoom

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/ClipPlaneAPI.html

Creates a new clip room with optional initial properties.

```APIDOC
## createClippingRoom(properties?: ClipRoomProperties)

### Description
Creates a new clip room.

### Parameters
- **properties** (ClipRoomProperties) - Optional - Initial properties of the created clip room.

### Returns
- **void**
```

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

### Configure and Connect to Device Camera Stream

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/RealityAPI.html

Checks for specific XR capabilities before connecting with a custom configuration object.

```javascript
const ctx = webvis.getContext();

// Start by requesting the capabilities of the XR system
const capabilities = ctx.getXRCapabilities();

// Check if the XR system supports providing XR images from the device
if (!capabilities.includes(webvis.XRCapability.SUPPORTS_DEVICE_IMAGE_SOURCE)) {
   // The XR system does not support providing XR images from the device.
}

// Connect to the XR system with the desired configuration
const xrConfiguration = {
   imageSourceConfig: {
      type: webvis.XRImageSource.DEVICE // Use the device's camera stream
   },
   modelTrackingEnabled: capabilities.includes(webvis.XRCapability.MODELTRACKER), // If unset, defaults to true
   deviceScreenshotsEnabled: capabilities.includes(webvis.XRCapability.DEVICE_SCREENSHOTS), // If unset, defaults to false
   autoShowBackgroundFeed: true // Show the background feed automatically when available, default is true
};
await ctx.connectXR(xrConfiguration);
```

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

### createCollectionFromGizmo

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/ViewerGizmoAPI.html

Creates a collection from the current gizmo state.

```APIDOC
## createCollectionFromGizmo(includeOverlappingNodes: boolean)

### Description
Creates a collection from the gizmo, optionally including overlapping nodes.

### Parameters
- **includeOverlappingNodes** (boolean) - Required

### Returns
- **Promise<number>**
```

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

### importXRInitTemplate

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/RealityAPI.html

Imports an initialization template for model-based tracking.

```APIDOC
## importXRInitTemplate(template: string)

### Description
Imports an initialization template for model-based tracking. This method is only available if the XR system has the XRCapability.SUPPORTS_MODEL_TRACKING capability.

### Parameters
- **template** (string) - Required - The base64 encoded initialization template data

### Returns
- **Promise<void>** - Returns a Promise which resolved when the operation was successful or rejects in an error case
```

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

### getSetting(setting: UISetting): any

Source: https://docs.threedy.io/3.11.4/doc/webvis-ui/functions/getSetting.html

Retrieves the value of a specified UI setting.

```APIDOC
## getSetting

### Description
Retrieves the value of a specific UI setting from the webvisUI configuration.

### Signature
`getSetting(setting: UISetting): any`

### Parameters
- **setting** (UISetting) - Required - The identifier of the UI setting to retrieve.

### Returns
- **any** - The value associated with the requested setting.
```

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

### Create a Viewer instance

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/ViewerAPI.html

Use ContextAPI.createViewer to initialize a viewer associated with a specific DOM canvas element.

```javascript
const canvas1 = document.getElementById("canvas-element-1");
const canvas2 = document.getElementById("canvas-element-2");
const viewer1 = webvis.getContext().createViewer("viewer-id-1", canvas1);
const viewer2 = webvis.getContext().createViewer("viewer-id-2", canvas2);

console.log(viewer1.getID()); // "viewer-id-1"
console.log(viewer2.getID()); // "viewer-id-2"
```

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

### Configure Viewer Magnifier

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/ViewerMagnifierAPI.html

Demonstrates how to retrieve a viewer instance and apply magnifier settings using the changeMagnifier method.

```typescript
// Get an instance of the ContextAPI
const myContext : ContextAPI = webvis.getContext( "example" )

// Get default viewer
const viewer = myContext.getViewer();

// Enable magnifier for viewer
viewer.changeMagnifier({enabled: true}) 

// Change magnifier properties
viewer.changeMagnifier({roundness: 50, position: [1000,720], size: [500,300], zoomLevel: 2}) 

// Alternatively, enable magnifier and set all properties in one call
viewer.changeMagnifier({roundness: 50, enabled: true, position: [1000,720], size: [500,300], zoomLevel: 2})
```

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

### getContext

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/ViewerAPI.html

Retrieves the webvis context.

```APIDOC
## getContext(): ContextAPI

### Description
Returns the webvis context to which the viewer belongs.

### Returns
- **ContextAPI** - The context of the viewer.
```

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

### Create and apply an animation sequence

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/AnimationAPI.html

Demonstrates defining a rotation animation sequence using createAnimationFrames and applying it to a node via setProperty.

```javascript
const context = webvis.getContext();

// Create a simple animation sequence which does a full rotation around the Y-axis
context.createAnimationFrames( "rotate" , [
 { rotation: [ 0, 0,   0 ] },
 { rotation: [ 0, 180, 0 ] },
 { rotation: [ 0, 360, 0 ] }
]);

// Apply the animation sequence to an InstanceGraph node with a total duration of 1000ms
context.setProperty( 1, webvis.Property.ANIMATION, {
   name     : "rotate",
   duration : 1000,
});
```

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

### requestContext

Source: https://docs.threedy.io/3.11.4/doc/webvis/webvis_api.html

Requests the creation or initialization of a context.

```APIDOC
## requestContext

### Description
Initiates a request to create or obtain a new context instance.
```

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

### constructor

Source: https://docs.threedy.io/3.11.4/doc/webvis-ui/classes/UINotificationEvent.html

Creates a new instance of UINotificationEvent.

```APIDOC
## constructor

### Signature
`new UINotificationEvent(msg: string, level: UINotificationLevel): UINotificationEvent`

### Parameters
- **msg** (string) - The notification message content.
- **level** (UINotificationLevel) - The severity level of the notification.

### Returns
- **UINotificationEvent** - A new instance of the event.
```

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

### constructor

Source: https://docs.threedy.io/3.11.4/doc/webvis/classes/TopologyPointerEnterEvent.html

Creates a new instance of the TopologyPointerEnterEvent.

```APIDOC
## constructor

### Description
Creates a new TopologyPointerEnterEvent instance. This event occurs when the mouse pointer enters one of the topological elements.

### Signature
new TopologyPointerEnterEvent(topologyHandle: TopologyHandle, pointerInfo: PointerInfo): TopologyPointerEnterEvent

### Parameters
- **topologyHandle** (TopologyHandle) - The Handle of the target topological element.
- **pointerInfo** (PointerInfo) - Additional Pointer Information.
```

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

### Add license key parameter

Source: https://docs.threedy.io/3.11.4/doc/integration/INSTALL_WINDOWS.html

Optional parameter to include if a specific license serial key is provided.

```bash
--set license.serialKey=YOUR_LICENSE_KEY
```

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

### Retrieve Existing Contexts

Source: https://docs.threedy.io/3.11.4/tutorials/dev_tutorials/tutorials/initialization.html

Shows how to access previously created contexts by name or retrieve all active contexts.

```javascript
<script type="module">
    webvis.getContext("my_context"); // Will return the previously created context "my_context"
    webvis.getContext("my_context_2"); // Will return the previously created context "my_context_2"
    webvis.getContext() // Will return the first created context of your application, here "my_context"
    webvis.getContexts() // Will return an array with both contexts in creation order
</script>
```

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

### createViewer

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/ContextAPI.html

Initializes a new viewer instance with optional settings and a target HTML canvas element.

```APIDOC
## createViewer(viewerID?: string, canvas?: HTMLCanvasElement, settings?: object)

### Description
Creates and returns a new ViewerAPI instance. This method allows for custom configuration of viewer settings such as background color, navigation modes, and rendering effects.

### Parameters
- **viewerID** (string) - Optional - Unique identifier for the viewer.
- **canvas** (HTMLCanvasElement) - Optional - The DOM element to render the viewer into.
- **settings** (object) - Optional - Configuration object for viewer behavior and appearance.
```

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

### Manage PostgreSQL Service

Source: https://docs.threedy.io/3.11.4/doc/integration/LICENSE_SERVER.html

Restart, enable, and verify the status of the PostgreSQL service.

```bash
systemctl restart postgresql
systemctl enable postgresql
systemctl status postgresql
```

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

### exportXRInitTemplate

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/RealityAPI.html

Exports an initialization template for model-based tracking.

```APIDOC
## exportXRInitTemplate(): Promise<string>

### Description
Exports an initialization template for model-based tracking. This method is only available if the XR system has the XRCapability.SUPPORTS_MODEL_TRACKING capability.

### Returns
- **Promise<string>** - Returns a Promise which contains the base64 encoded initialization template data when the operation was successful or rejects in an error case.
```

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

### Add PostgreSQL Repository on RedHat

Source: https://docs.threedy.io/3.11.4/doc/integration/LICENSE_SERVER.html

Configures the official PostgreSQL repository for package management on RedHat-based systems.

```bash
yum -y install https://download.postgresql.org/pub/repos/yum/reporpms/EL-$(rpm -E %{rhel})-x86_64/pgdg-redhat-repo-latest.noarch.rpm
yum -y update
```

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

### showSelectionBoxGizmoFromVolume

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/ViewerAPI.html

Displays a selection box gizmo based on a provided volume.

```APIDOC
## showSelectionBoxGizmoFromVolume(volume?)

### Description
Displays a selection box gizmo derived from a BoxVolume.

### Parameters
- **volume** (BoxVolume) - Optional - The volume definition.

### Returns
- **void**
```

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

### Create and Manage Polylines with ViewerPolylineAPI

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/ViewerPolylineAPI.html

Demonstrates the lifecycle of a polyline, including creation, property modification, and removal.

```typescript
// Get an instance of the ContextAPI & ViewerAPI
const theContext : ContextAPI = webvis.getContext(),
      theViewer  : ViewerAPI  = theContext.getViewer();

// Create a list of 3D positions which defines the Polyline
const linePositions : number[] = [
 0, 0, 0,
 1, 0, 0,
 2, 0, 0
];

// Create a red Polyline with the given linePositions and a width of 6 pixels
const polylineId : number = theViewer.createPolyline( linePositions , {
    color: [1, 0, 0, 1],
    width: 6
});

// Change the color of the Polyline to green
theViewer.changePolyline( polylineId, {
    color: [0, 1, 0, 1]
};

// Removes the Polyline
theViewer.removePolyline(polylineId)
```

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

### XRPlaybackStateChangedEvent Constructor

Source: https://docs.threedy.io/3.11.4/doc/webvis/classes/XRPlaybackStateChangedEvent.html

Creates a new instance of the XRPlaybackStateChangedEvent.

```APIDOC
## constructor

### Description
Creates a new XRPlaybackStateChangedEvent instance.

### Signature
`new XRPlaybackStateChangedEvent(xrPlaybackState: Partial<XRPlaybackState>): XRPlaybackStateChangedEvent`

### Parameters
- **xrPlaybackState** (Partial<XRPlaybackState>) - The new state of the XR playback, containing only the changed properties.
```

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

### Add instant3Dhub Helm repository

Source: https://docs.threedy.io/3.11.4/doc/integration/INSTALL_WINDOWS.html

Adds the official instant3Dhub Helm chart repository and updates the local cache.

```bash
helm repo add instant3dhub https://repo.threedy.io/api/v4/projects/2/packages/helm/stable \
  && helm repo update
```

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

### constructor

Source: https://docs.threedy.io/3.11.4/doc/webvis/classes/ClipPlaneChangedEvent.html

Creates a new instance of the ClipPlaneChangedEvent.

```APIDOC
## constructor

### Description
Creates a new ClipPlaneChangedEvent instance when a clip plane is changed.

### Signature
`new ClipPlaneChangedEvent(clipPlaneID: number, properties: ClipPlaneProperties): ClipPlaneChangedEvent`

### Parameters
- **clipPlaneID** (number) - The ID of the clipplane.
- **properties** (ClipPlaneProperties) - An object with the changed properties.
```

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

### constructor

Source: https://docs.threedy.io/3.11.4/doc/webvis/classes/ClippingRoomRemovedEvent.html

Creates a new instance of the ClippingRoomRemovedEvent.

```APIDOC
## constructor

### Description
Creates a new ClippingRoomRemovedEvent instance when a clip room is removed.

### Signature
`new ClippingRoomRemovedEvent(clipRoomID: number): ClippingRoomRemovedEvent`

### Parameters
- **clipRoomID** (number) - The ID of the clip room that was removed.
```

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

### getXRState

Source: https://docs.threedy.io/3.11.4/doc/webvis/interfaces/RealityAPI.html

Retrieves the runtime state of the XR system.

```APIDOC
## getXRState()

### Description
Get the runtime state of the XR system.

### Returns
- **XRState** - Returns either the current XRState or undefined if the XR system is not connected.
```

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

### constructor

Source: https://docs.threedy.io/3.11.4/doc/webvis/classes/XRMemberAddedEvent.html

Creates a new instance of the XRMemberAddedEvent.

```APIDOC
### constructor

`new XRMemberAddedEvent(xrMemberId: number): XRMemberAddedEvent`

#### Parameters
- **xrMemberId** (number) - The ID of the session member that started publishing XR images.
```

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

### constructor

Source: https://docs.threedy.io/3.11.4/doc/webvis/classes/ViewerStateChangedEvent.html

Creates a new instance of the ViewerStateChangedEvent.

```APIDOC
## constructor

### Description
Creates a new ViewerStateChangedEvent instance when the state of a viewer changes.

### Signature
new ViewerStateChangedEvent(state: ViewerState, viewer: ViewerAPI): ViewerStateChangedEvent

### Parameters
- **state** (ViewerState) - The new state of the Viewer.
- **viewer** (ViewerAPI) - The related Viewer instance.
```

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

### XRInitOptions

Source: https://docs.threedy.io/3.11.4/doc/webvis/types/XRInitOptions.html

The XRInitOptions type defines the behavior of the initialization mode for modeltracking.

```APIDOC
## XRInitOptions

### Description
Defines the behavior of the initialization mode for modeltracking.

### Properties
- **fitView** (boolean) - Optional - Specify if a view fitting should be performed. If set to true the model will be fitted to the current view volume. Default: true.
- **resetHard** (boolean) - Optional - Specify if a reset hard should be executed. If set to true all runtime data learned during tracking will be omitted. Default: false.
- **resetInitTemplate** (boolean) - Optional - Specify if a reset should also reset Init data. Default: false.
```
Tokens:
Raw