Skip to main content

PointAnnotation

class PointAnnotation extends Annotation

Annotation that stays at one point

constructor

new PointAnnotation(view3D, )
PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
view3DView3D
Partial<PointAnnotationOptions>✔️{}

Properties

position

readonlyinherited

3D position of the annotation

Type: THREE.Vector3

element

readonlyinherited

Element of the annotation

Type: HTMLElement

renderable

readonlyinherited

Whether this annotation is renderable in the screen

Type: boolean

focusing

readonlyinherited

Whether this annotation is focused

Type: boolean

focusPose

readonlyinherited

An array of values in order of [yaw, pitch, zoom]

Type: Array<number>

focusDuration

inherited

Duration of the focus animation

Type: number

focusOffset

readonlyinherited

Offset vector from the pivot when focused

Type: Array<number>

baseFov

inherited

Base fov value that annotation is referencing

Type: number

baseDistance

inherited

Base dsitance value that annotation is referencing

Type: number | null

hidden

readonlyinherited

Whether the annotation is hidden and not rendered

Type: boolean

Methods

focus

inherited

Focus camera to this annotation
This will add a class selected to this annotation element.

unfocus

inherited

Unfocus camera.
This will remove a class selected to this annotation element.
To reset camera to the original position, use Camera#reset

toJSON

inherited

Serialize anntation data to JSON format.

destroy

inherited

Destroy annotation and release all resources.

resize

inherited

Resize annotation to the current size

render

inherited

Render annotation element

PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
paramsobject

show

inherited

Show annotation.
A class "hidden" will be removed from the annotation element.

hide

inherited

Hide annotation and prevent it from being rendered.
A class "hidden" will be added to the annotation element.

setOpacity

inherited

Set opacity of the annotation
Opacity is automatically controlled with annotationBreakpoints

PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
opacitynumberOpacity to apply, number between 0 and 1

enableEvents

inherited

Add browser event handlers

disableEvents

inherited

Remove browser event handlers