Class MeasurementController

The MeasurementController is responsible for performing measurements of registered entities, and updating the model with their measurement results.

Index

Constructors

Methods

addEntity clearEntities removeEntity setDebugLogs setEntities

Constructors

constructor

new MeasurementController(
    model: MeasurementModel,
    client: SceneViewAPIClient,
    jwtProvider: JwtProvider,
    deviceId: string | undefined,
): MeasurementController
Parameters
- model: MeasurementModel
- client: SceneViewAPIClient
- jwtProvider: JwtProvider
- deviceId: string | undefined
Returns MeasurementController
- Defined in packages/viewer/src/lib/measurement/controller.ts:25

Methods

addEntity

addEntity(entity: MeasurementEntity): Promise<MeasurementOutcome | undefined>
Registers an entity to measure and performs a measurement if this entity has not been previously registered.
Parameters
- entity: MeasurementEntity
  The entity to measure.
Returns Promise<MeasurementOutcome | undefined>
A promise that resolves with the results after registering this entity.
- Defined in packages/viewer/src/lib/measurement/controller.ts:40

clearEntities

clearEntities(): Promise<MeasurementOutcome | undefined>
Clears all entities and returns a promise that resolves with an empty list of measurement results.

Returns Promise<MeasurementOutcome | undefined>
- Defined in packages/viewer/src/lib/measurement/controller.ts:60

removeEntity

removeEntity(entity: MeasurementEntity): Promise<MeasurementOutcome | undefined>
Deregisters an entity and performs a measurement if this entity was removed.
Parameters
- entity: MeasurementEntity
  The entity to remove.
Returns Promise<MeasurementOutcome | undefined>
A promise that resolves with the results after removing this entity.
- Defined in packages/viewer/src/lib/measurement/controller.ts:78

setDebugLogs

setDebugLogs(debugLogs: boolean): void
Parameters
- debugLogs: boolean
Returns void
- Defined in packages/viewer/src/lib/measurement/controller.ts:117

setEntities

setEntities(
entities: Set<MeasurementEntity>,
): Promise<MeasurementOutcome | undefined>
Registers a set of entities and performs a measurement
Parameters
- entities: Set<MeasurementEntity>
  The entities to measure.
Returns Promise<MeasurementOutcome | undefined>
A promise that resolves with the results after registering these entities.
- Defined in packages/viewer/src/lib/measurement/controller.ts:101