Usage of the SDK constitutes your agreement with the Matterport SDK Agreement. Email developers@matterport.com with any questions.
Type parameters
-
Volume
-
UserData: Record<string, unknown>
Hierarchy
- ISource
Index
Properties
type
The type of source.
userData
Arbitrary data that can be used to set additional metadata, for example.
volume
The volume that represents the range of emissions from this ISource
.
Methods
commit
-
Let the sensor system know there is an update to this
ISource
.
When changing any properties onvolume
, no changes will be reflected on the source or in Showcase untilcommit
is called.Returns Promise<void>
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
ofSourceType.SPHERE
thevolume
is aSphereVolume
; aSourceType.BOX
has aBoxVolume
.