open-index/open-npm huggingface dataset:
npm package: @superviz/cesium-plugin
Description: Cesium Plugin for SuperViz SDK
Latest version: 1.0.1
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# SuperViz Cesium SDK Plugin

## DISCLAIMER: this version is only compatible with SuperViz SDK version 4.7.2 or higher

<p align="center">
  <a href="https://superviz.com/" target="blank"><img src="https://avatars.githubusercontent.com/u/56120553?s=200&v=4" width="120" alt="Nest Logo" /></a>
</p>

<p align="center">
The SuperViz Cesium Plugin connects the cesium sdk to the superviz sdk, injecting mouses and functionality into the cesium 3D world.
</p>

<p align="center">
<img alt="npm type definitions" src="https://img.shields.io/npm/types/@superviz/cesium-plugin">
<img alt="npm" src="https://img.shields.io/npm/dw/@superviz/cesium-plugin">
</p>

## Description

`@superviz/cesium-plugin` is a plug and play package that you can use together with the superviz sdk to easily inject custom mouses and functionality to your cesium 3d world.

* current cesium sdk version supported: **1.106.1** or above


## Getting started
	import SuperViz, {
		MeetingEvent
	} from '@superviz/sdk';

	import { CesiumPlugin } from '@superviz/cesium-plugin';

	const supervizSdk = await SuperViz.init(DEVELOPER_KEY, { // for more info on the superviz sdk check docs.superviz.com
		group: {
				id: "<GROUP-ID>",
				name: "<GROUP-NAME>"
		},
		participant: {
				id: "<MY-USER-ID>",
				name: "<MY-USER-NAME>",
				type: 'host'
		},
		roomId: "<ROOM-ID>",
		debug: false
	});

	const plugin = new CesiumPlugin(cesiumSdk);

	supervizSdk.subscribe(MeetingEvent.MY_USER_JOINED, () => {
		this.cesiumPluginInstance = supervizSdk.loadPlugin(plugin, {
			avatarConfig: {},
			isNameEnabled: true,
		});
	});

## Plugin initialization options

`const plugin = new CesiumPlugin(cesiumSdk);`

When creating the Cesium Plugin instance you need to pass your Cesium SDK instance. For example: 

```
Cesium.Ion.defaultAccessToken = CESIUM_KEY  //your cesium key

const cesiumSdk = new Cesium.Viewer('cesiumContainer', {
  // ...options
});
const plugin = new CesiumPlugin(cesiumSdk);
```

## SDK Methods
  * getParticipantsOn3D()
  
  To access users current 3D properties like position, rotation use: `this.cesiumPluginInstance.getParticipantsOn3D();`

  * e.g
  
		[{
			id: 123,
			name: "John Doe",
			avatar: {
				model: "model.gltf"
			},
			avatarConfig: {
				scale: 1,
				height: 0,
				laserOrigin: { x:0,y:0,z:0 }
			},
			position: { x: 0, y: 0, z: 0 },
			rotation: { x: 0, y: 0 }
		}]

## Issues
  To report a new bug or request a new feature, please contact us at contact@superviz.com


  Superviz cesium-plugin is [BSD 2 licensed](LICENSE).
npm package: @superviz/matterport-plugin
Description: Matterport Plugin for SuperViz SDK
Latest version: 1.3.0

<p align="center">
  <a href="https://superviz.com/" target="blank"><img src="https://avatars.githubusercontent.com/u/56120553?s=200&v=4" width="120" alt="Nest Logo" /></a>
</p>

<p align="center">
<img alt="npm type definitions" src="https://img.shields.io/npm/types/@superviz/matterport-plugin">
<img alt="npm" src="https://img.shields.io/npm/dw/@superviz/matterport-plugin">
</p>

# SuperViz Matterport SDK Plugin

SuperViz provides a suite of programmable low-code Collaboration and Communication components, all synchronized with an advanced Real-time Data Engine, enabling real-time and asynchronous collaboration and communication within any JavaScript based application.

The SuperViz Matterport Plugin, when integrated, connects a Matterport scene to the SuperViz SDK, [allowing avatars](https://docs.superviz.com/init/initialization#avatar), [pinned comments](https://docs.superviz.com/components/contextual-comments/contextual-comments-for-Matterport), and other [collaborative features](https://docs.superviz.com/components/presence/presence3d/MatterportPresence) within the 3D environment for a shared participant experience.

Note: to use this package, you must also have the following minimum versions:

- SuperViz SDK, minimum version 6.4.0
- Matterport SDK Bundle, minimum version 3.1.77.2-1-g3baaac4893

## Getting started

### 1. Installing SuperViz Matterport extension

The Presence3D component is not available from the `@superviz/sdk` package, instead, to use Presence 3D you must use the `@superviz/matterport-plugin` package.

To install the `@superviz/matterport-plugin` package with npm, run the following command:

```bash
npm install --save @superviz/matterport-plugin
```

Or with Yarn:

```bash
yarn add @superviz/matterport-plugin
```

### 2. Adding Matterport to SuperViz SDK

To add a Matterport Presence3D component, you can use the following code:

```jsx
import { Presence3D } from '@superviz/matterport-plugin';

const matterportPresence = new Presence3D(mpSdk, {
  isAvatarsEnabled: true,
  isLaserEnabled: true,
  isNameEnabled: true,
  avatarConfig: {
    height: 0,
    scale: 1,
    laserOrigin: { x: 0, y: 0, z: 0 },
  },
});

sdk.addComponent(matterportPresence);
```

Please check the documentation for more information about the [Presence3D component](https://docs.superviz.com/components/presence/presence3d/MatterportPresence).

## Contributing

### Issues

To report a new bug, request a new feature, or if you need any help, you can [file an issue on GitHub](https://github.com/SuperViz/sdk/issues/new/choose). We have a few templates to help you out.

## License

SuperViz SDK is licensed under the [BSD 2-Clause License](https://github.com/SuperViz/sdk/blob/main/LICENSE).