Skip to main content
Version: Next

Interface: Image360Annotation<T>

Defined in: packages/360-images/src/annotation/Image360Annotation.ts:11

An annotation associated with a 360 image revision

Type Parameters

T

T extends DataSourceType = ClassicDataSourceType

Properties

annotation

readonly annotation: T["image360AnnotationType"]

Defined in: packages/360-images/src/annotation/Image360Annotation.ts:15

The underlying CDF annotation

Methods

getCenter()

getCenter(out?): Vector3

Defined in: packages/360-images/src/annotation/Image360Annotation.ts:40

Get center of annotation, to e.g. point the camera toward it

Parameters

out?

Vector3

Returns

Vector3


getColor()

getColor(): Color

Defined in: packages/360-images/src/annotation/Image360Annotation.ts:20

Get the individual display color of this annotation.

Returns

Color


getVisible()

getVisible(): boolean

Defined in: packages/360-images/src/annotation/Image360Annotation.ts:30

Get whether this annotation is visible

Returns

boolean


setColor()

setColor(color?): void

Defined in: packages/360-images/src/annotation/Image360Annotation.ts:25

Set the display color of this annotation. Default: Random, based on annotation label

Parameters

color?

Color

Returns

void


setVisible()

setVisible(visible?): void

Defined in: packages/360-images/src/annotation/Image360Annotation.ts:35

Set whether this annotation should be visible. Default: true

Parameters

visible?

boolean

Returns

void