AnnotationData

Interface AnnotationData

AnnotationData defines the properties and content of an annotation.

AnnotationAPI

interface AnnotationData {
    active: boolean;
    anchorPosition: Vector3 | Float32Array<ArrayBufferLike>;
    explicitOffset: boolean;
    label: string;
    labelPosition: Vector3 | Float32Array<ArrayBufferLike>;
    nodeID: number;
    transform: Matrix4x4 | Float32Array<ArrayBufferLike>;
    trustedSource: boolean;
    visible: boolean;
}
Index

Properties

active anchorPosition explicitOffset label labelPosition nodeID transform trustedSource visible

Properties

active: boolean

Determines whether the annotation is active or not.

anchorPosition: Vector3 | Float32Array<ArrayBufferLike>

Determines the annotation's anchor position.

[0, 1, 0]
explicitOffset: boolean

Determines whether an explicit offset should be used or not.

label: string

The label of the annotation.

"This is a great annotation!"
labelPosition: Vector3 | Float32Array<ArrayBufferLike>

Determines the annotation's label position.

[0, 2, 0]
nodeID: number

The ID of a node the annotation is linked to.

transform: Matrix4x4 | Float32Array<ArrayBufferLike>

Provides the transform of the annotation.

trustedSource: boolean

Determines whether the annotation source is trusted or not.

visible: boolean

Determines whether the annotation is visible or not.



Was this page helpful? Please leave a thumbs up or down.