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

A Source represents a volume that will be detected by a Sensor. The type of the source, describes the type of volume associated with it. For example, with a type of SourceType.SPHERE the volume is a SphereVolume; a SourceType.BOX has a BoxVolume.

Type parameters

  • Volume

  • UserData: Record<string, unknown>

Hierarchy

  • ISource

Index

Properties

Methods

Properties

type

type: Sensor.SourceType

The type of source.

userData

userData: UserData

Arbitrary data that can be used to set additional metadata, for example.

volume

volume: Volume

The volume that represents the range of emissions from this ISource.

Methods

commit

  • commit(): Promise<void>

  • Let the sensor system know there is an update to this ISource.
    When changing any properties on volume, no changes will be reflected on the source or in Showcase until commit is called.

    Returns Promise<void>