Interface: Sensor.ISensor

ISensor | Matterport SDK

Usage of the SDK constitutes your agreement with the Matterport SDK Agreement. Email developers@matterport.com with any questions.

A Sensor that detects Sources and provides information about the reading of each.

Hierarchy

IObservable<Sensor.ISensor>
- ISensor

Index

Properties

Methods

Properties

forward

forward: Vector3

The world-space "forward" direction describing which direction the sensor is facing.

origin

origin: Vector3

The world-space position of the sensor.

readings

readings: object

An observable used to get information about assocated ISources added with ISensor.addSource

Type declaration

subscribe: function
- subscribe(observer: Sensor.ISensorObserver): ISubscription
- Start receiving updates about the current set of sources added to this sensor.
  
  Parameters
  - observer: Sensor.ISensorObserver
  Returns ISubscription

Methods

addSource

addSource(...sources: Sensor.ISource[]): void

Add a source, to add its readings to the set of readings provided by .subscribe.

Parameters
- Rest ...sources: Sensor.ISource[]
Returns void

dispose

dispose(): void

Teardown and cleanup the sensor, and stop receiving updates.

Returns void

showDebug

showDebug(show: boolean): void

Show debug visuals for this sensor. Existing visuals are disposed.

Parameters
- show: boolean
Returns void

subscribe

subscribe<DataT>(observer: IObserver<DataT> | ObserverCallback<DataT>): ISubscription

Overrides IObservable.subscribe

Start receiving updates when properties of this sensor change, e.g. origin or forward, not its readings.
Subscribe to readings to receive updates about associated ISources

Type parameters
- DataT
Parameters
- observer: IObserver<DataT> | ObserverCallback<DataT>
Returns ISubscription

waitUntil

waitUntil(condition: ICondition<Sensor.ISensor> | ConditionCallback<Sensor.ISensor>): Promise<Sensor.ISensor>

Inherited from IObservable.waitUntil
Wait for a specific condition on this object to be met. When this observable detects a change, the condition provided will be called. When the condition returns true, the returned Promise will be resolved.
```
 // Example: pause execution of code until the app state is in the "playing" phase
 await sdk.App.state.waitUntil(
  appState => appState.phase == sdk.App.Phase.PLAYING
 );
```
or:
```
await sdk.App.state.waitUntil({
  waitUntil(appState) {
    return appState.phase == sdk.App.Phase.PLAYING;
  }
});
```
Parameters
- condition: ICondition<Sensor.ISensor> | ConditionCallback<Sensor.ISensor>
Returns Promise<Sensor.ISensor>

A promise that is resolved when condition returns true.