Skip to content

editor › Globals › AnnotationHint

Class: AnnotationHint

An AnnotationHint combines an AngledHintLine with another content hint so that the HintLine connects the object with the content hint ("annotates").

Hierarchy

↳ FilterableHint

↳ AnnotationHint

↳ UserInputAnnotationHint

↳ MenuItemHint

↳ HtmlAnnotationHint

Index

Constructors

Properties

Methods

Constructors

constructor

+ new AnnotationHint(positionProvider: HintPositionProvider, assembly: Assembly, skipCreatingContentHint: boolean): AnnotationHint

Overrides FilterableHint.constructor

Defined in src/renderContext/hints/AnnotationHint.ts:18

Parameters:

Name Type Default Description
positionProvider HintPositionProvider - HintPositionProvider that calculates the position for the annotation.
assembly Assembly - For backwards compatibility. Deprecated, to be removed.
skipCreatingContentHint boolean false the UserInputAnnotationHint needs a custom creation of the contentHint

Returns: AnnotationHint

Properties

Protected assembly

• assembly: Assembly | null

Inherited from FilterableHint.assembly

Defined in src/renderContext/hints/Hint.ts:38

Protected children

• children: Hint[] = []

Inherited from FilterableHint.children

Defined in src/renderContext/hints/Hint.ts:37

Protected contentHint

• contentHint: HtmlHint | UserInputHint | null = null

Defined in src/renderContext/hints/AnnotationHint.ts:16

Protected destroyed

• destroyed: boolean = false

Inherited from FilterableHint.destroyed

Defined in src/renderContext/hints/Hint.ts:36

Protected domNode

• domNode: HTMLElement | null = null

Inherited from FilterableHint.domNode

Defined in src/renderContext/hints/Hint.ts:33

Protected Readonly externalChangeEventEmitter

• externalChangeEventEmitter: EventEmitter‹number | any[] | [number, number, EdgeHint‹›] | [number, Hint‹›] | [number, number, RoundEdgeHint‹›]› = new EventEmitter< [number, number, EdgeHint] | [number, Hint] | number | [number, number, RoundEdgeRadiusHint] | any[]

()

Inherited from FilterableHint.externalChangeEventEmitter

Defined in src/renderContext/hints/Hint.ts:43

Protected Readonly hintLine

• hintLine: AngledHintLine = null

Defined in src/renderContext/hints/AnnotationHint.ts:18

Protected manager

• manager: any = null

Inherited from FilterableHint.manager

Defined in src/renderContext/hints/Hint.ts:34

Protected Readonly positionProvider

• positionProvider: HintPositionProvider = null

Defined in src/renderContext/hints/AnnotationHint.ts:17

Protected scale

• scale: number = 1

Inherited from FilterableHint.scale

Defined in src/renderContext/hints/Hint.ts:47

Protected threeMaterial

• threeMaterial: Material | null = null

Inherited from FilterableHint.threeMaterial

Defined in src/renderContext/hints/Hint.ts:48

Protected threeNode

• threeNode: Object3D | null = null

Inherited from FilterableHint.threeNode

Defined in src/renderContext/hints/Hint.ts:39

Protected Readonly unitConversionErrorEventEmitter

• unitConversionErrorEventEmitter: EventEmitter‹void› = new EventEmitter()

Inherited from FilterableHint.unitConversionErrorEventEmitter

Defined in src/renderContext/hints/Hint.ts:46

Protected visible

• visible: boolean = true

Inherited from FilterableHint.visible

Defined in src/renderContext/hints/Hint.ts:35

Methods

Protected _applyDOMScale

▸ _applyDOMScale(): void

Inherited from FilterableHint._applyDOMScale

Defined in src/renderContext/hints/Hint.ts:406

Returns: void

Protected _applyVisibility

▸ _applyVisibility(): void

Inherited from FilterableHint._applyVisibility

Defined in src/renderContext/hints/Hint.ts:391

Returns: void

Protected Abstract _createContentHint

▸ _createContentHint(assembly: Assembly): HtmlHint | UserInputHint

Defined in src/renderContext/hints/AnnotationHint.ts:78

Parameters:

Name Type
assembly Assembly

Returns: HtmlHint | UserInputHint

Protected _createHintLine

▸ _createHintLine(assembly: Assembly): AngledHintLine

Defined in src/renderContext/hints/AnnotationHint.ts:80

Parameters:

Name Type
assembly Assembly

Returns: AngledHintLine

Protected _onExternalChange

▸ _onExternalChange(args: any[]): any[]

Inherited from FilterableHint._onExternalChange

Defined in src/renderContext/hints/Hint.ts:380

propagate event fired by child

Parameters:

Name Type
args any[]

Returns: any[]

Protected _onUnitConversionError

▸ _onUnitConversionError(): any[]

Inherited from FilterableHint._onUnitConversionError

Defined in src/renderContext/hints/Hint.ts:387

propagate event fired by child

Returns: any[]

Protected _projectAssemblyToCanvas

▸ _projectAssemblyToCanvas(point: Vector3): Vector3

Inherited from FilterableHint._projectAssemblyToCanvas

Defined in src/renderContext/hints/Hint.ts:373

Parameters:

Name Type
point Vector3

Returns: Vector3

Protected _updateContentHint

▸ _updateContentHint(): void

Defined in src/renderContext/hints/AnnotationHint.ts:91

Returns: void

Protected _updateContentHintAlignment

▸ _updateContentHintAlignment(): void

Defined in src/renderContext/hints/AnnotationHint.ts:100

Returns: void

Protected _updateHintLine

▸ _updateHintLine(): void

Defined in src/renderContext/hints/AnnotationHint.ts:84

Returns: void

add

▸ add(child: Hint): void

Inherited from FilterableHint.add

Defined in src/renderContext/hints/Hint.ts:182

This adds a child hint to this hint. Using this method takes care of calling all required setters on the child hint.

Parameters:

Name Type
child Hint

Returns: void

calculatePosition

▸ calculatePosition(): void

Overrides FilterableHint.calculatePosition

Defined in src/renderContext/hints/AnnotationHint.ts:44

Returns: void

cancelFade

▸ cancelFade(): void

Inherited from FilterableHint.cancelFade

Defined in src/renderContext/hints/Hint.ts:348

Returns: void

destroy

▸ destroy(): void

Inherited from FilterableHint.destroy

Defined in src/renderContext/hints/Hint.ts:305

Subclasses should override this method to clean up all references such as event listeners.

Returns: void

fadeOut

▸ fadeOut(duration: number, delay: number): KyubAnimation‹any›

Inherited from FilterableHint.fadeOut

Defined in src/renderContext/hints/Hint.ts:317

Start a fade animation. If one is already ongoing, that animation is canceled before starting the new animation.

Parameters:

Name Type Default Description
duration number - in ms
delay number 0 in ms

Returns: KyubAnimation‹any›

the animation that is used to fade the THREE.js part of this hint. This animation still needs to be started (by passing it to the RenderContext).

focus

▸ focus(): void

Inherited from FilterableHint.focus

Defined in src/renderContext/hints/Hint.ts:273

Returns: void

getAssembly

▸ getAssembly(): Assembly | null

Inherited from FilterableHint.getAssembly

Defined in src/renderContext/hints/Hint.ts:224

Returns: Assembly | null

getCanvasAABB

▸ getCanvasAABB(): AABB

Inherited from FilterableHint.getCanvasAABB

Defined in src/renderContext/hints/FilterableHint.ts:45

Returns: AABB

the rough AABB of this hint in canvas coordinates

getCanvasPoints

▸ getCanvasPoints(): Vector3[]

Inherited from FilterableHint.getCanvasPoints

Defined in src/renderContext/hints/FilterableHint.ts:52

Returns: Vector3[]

the points in canvas coordinates that this hint refers to

getCanvasPosition

▸ getCanvasPosition(): Vector3

Inherited from FilterableHint.getCanvasPosition

Defined in src/renderContext/hints/FilterableHint.ts:38

Returns: Vector3

the position of this hint in canvas coordinates

getChildren

▸ getChildren(): Hint[]

Inherited from FilterableHint.getChildren

Defined in src/renderContext/hints/Hint.ts:257

Returns: Hint[]

getContentHint

▸ getContentHint(): UserInputHint‹› | HtmlHint‹›

Defined in src/renderContext/hints/AnnotationHint.ts:54

Returns: UserInputHint‹› | HtmlHint‹›

getDOMNode

▸ getDOMNode(): HTMLElement | null

Inherited from FilterableHint.getDOMNode

Defined in src/renderContext/hints/Hint.ts:286

Returns: HTMLElement | null

getExternalChangeEventEmitter

▸ getExternalChangeEventEmitter(): IPublicEventEmitterInterface‹number | any[] | [number, number, EdgeHint‹›] | [number, Hint‹›] | [number, number, RoundEdgeHint‹›]›

Inherited from FilterableHint.getExternalChangeEventEmitter

Defined in src/renderContext/hints/Hint.ts:64

Returns: IPublicEventEmitterInterface‹number | any[] | [number, number, EdgeHint‹›] | [number, Hint‹›] | [number, number, RoundEdgeHint‹›]›

getPrefixedText

▸ getPrefixedText(): string

Inherited from FilterableHint.getPrefixedText

Defined in src/renderContext/hints/FilterableHint.ts:24

Returns: string

the string representation of this hint. This is used to deduplicate hints, but can also group them by using prefixes.

getPriority

▸ getPriority(): number

Inherited from FilterableHint.getPriority

Defined in src/renderContext/hints/FilterableHint.ts:75

Returns: number

getScale

▸ getScale(): number

Overrides FilterableHint.getScale

Defined in src/renderContext/hints/AnnotationHint.ts:62

Returns: number

getText

▸ getText(): string

Inherited from FilterableHint.getText

Defined in src/renderContext/hints/FilterableHint.ts:31

Returns: string

the string representation of this hint. This is used to deduplicate hints.

getThreeNode

▸ getThreeNode(): Object3D

Inherited from FilterableHint.getThreeNode

Defined in src/renderContext/hints/Hint.ts:290

Returns: Object3D

getUnitConversionErrorEventEmitter

▸ getUnitConversionErrorEventEmitter(): IPublicEventEmitterInterface‹void›

Inherited from FilterableHint.getUnitConversionErrorEventEmitter

Defined in src/renderContext/hints/Hint.ts:68

Returns: IPublicEventEmitterInterface‹void›

getWorldPosition

▸ getWorldPosition(): Vector3

Inherited from FilterableHint.getWorldPosition

Defined in src/renderContext/hints/FilterableHint.ts:59

Get the position of the object, that this hint annotates in world coordinates

Returns: Vector3

hasMaterial

▸ hasMaterial(): boolean

Inherited from FilterableHint.hasMaterial

Defined in src/renderContext/hints/Hint.ts:162

Returns: boolean

hide

▸ hide(): void

Inherited from FilterableHint.hide

Defined in src/renderContext/hints/Hint.ts:269

Returns: void

initDOMNode

▸ initDOMNode(): void

Inherited from FilterableHint.initDOMNode

Defined in src/renderContext/hints/Hint.ts:104

Returns: void

initThreeNode

▸ initThreeNode(): void

Inherited from FilterableHint.initThreeNode

Defined in src/renderContext/hints/Hint.ts:80

This method is called, before the Hint is rendered. Note: It may be called multiple times on the same Hint instance.

Returns: void

isFilterable

▸ isFilterable(): boolean

Inherited from FilterableHint.isFilterable

Defined in src/renderContext/hints/FilterableHint.ts:16

Return true if you want hints of this class to be filtered, false otherwise. If you return true, you must implement all the pseudo-abstract methods of FilterableHint

Returns: boolean

isToolHint

▸ isToolHint(): boolean

Inherited from FilterableHint.isToolHint

Defined in src/renderContext/hints/Hint.ts:174

Returns: boolean

isValid

▸ isValid(): boolean

Overrides FilterableHint.isValid

Defined in src/renderContext/hints/AnnotationHint.ts:70

Returns: boolean

isVisible

▸ isVisible(): boolean

Inherited from FilterableHint.isVisible

Defined in src/renderContext/hints/Hint.ts:282

Returns: boolean

makeInteractable

▸ makeInteractable(): void

Inherited from FilterableHint.makeInteractable

Defined in src/renderContext/hints/Hint.ts:133

Makes this hint interactable. That means that tools that can work with hints will be provided with this instance if the user interacts with it.

Returns: void

remove

▸ remove(child: Hint): void

Inherited from FilterableHint.remove

Defined in src/renderContext/hints/Hint.ts:204

This removes a child hint from this hint.

Parameters:

Name Type
child Hint

Returns: void

removeAllListeners

▸ removeAllListeners(): void

Inherited from FilterableHint.removeAllListeners

Defined in src/renderContext/hints/Hint.ts:72

Returns: void

setAssembly

▸ setAssembly(assembly: Assembly): void

Inherited from FilterableHint.setAssembly

Defined in src/renderContext/hints/Hint.ts:220

Set the assembly this hint belongs to

Parameters:

Name Type Description
assembly Assembly assembly

Returns: void

setCanvasSizeGetter

▸ setCanvasSizeGetter(getCanvasSize: function): void

Inherited from FilterableHint.setCanvasSizeGetter

Defined in src/renderContext/hints/Hint.ts:298

Parameters:

▪ getCanvasSize: function

▸ (): IDimensions2

Returns: void

setConversionMethod

▸ setConversionMethod(worldToCanvas: function): void

Overrides FilterableHint.setConversionMethod

Defined in src/renderContext/hints/AnnotationHint.ts:66

Parameters:

▪ worldToCanvas: function

▸ (Vector3: any): Vector3

Parameters:

Name Type
Vector3 any

Returns: void

setDeduplicationGroup

▸ setDeduplicationGroup(groupId: string): void

Inherited from FilterableHint.setDeduplicationGroup

Defined in src/renderContext/hints/FilterableHint.ts:67

Assign the same group id to multiple hints in order to group them {@link FilterableHint#getPrefixedText}.

Parameters:

Name Type Description
groupId string the group id of this hint.

Returns: void

setFontSize

▸ setFontSize(fontSize: number): void

Inherited from FilterableHint.setFontSize

Defined in src/renderContext/hints/Hint.ts:248

Set the font size in px.

Parameters:

Name Type Default Description
fontSize number Config.get("hints.fontSize") -

Returns: void

setHintLineArrow

▸ setHintLineArrow(arrowHeadLength: number, arrowHeadWidth: number): void

Defined in src/renderContext/hints/AnnotationHint.ts:74

Parameters:

Name Type Default
arrowHeadLength number 0
arrowHeadWidth number arrowHeadLength

Returns: void

setHintLineStraightLength

▸ setHintLineStraightLength(length: number): void

Defined in src/renderContext/hints/AnnotationHint.ts:50

Parameters:

Name Type
length number

Returns: void

setManager

▸ setManager(manager: HintManager): void

Inherited from FilterableHint.setManager

Defined in src/renderContext/hints/Hint.ts:140

Parameters:

Name Type
manager HintManager

Returns: void

setMaterial

▸ setMaterial(material: Material): void

Inherited from FilterableHint.setMaterial

Defined in src/renderContext/hints/Hint.ts:147

Parameters:

Name Type
material Material

Returns: void

setOpacity

▸ setOpacity(opacity: number): void

Inherited from FilterableHint.setOpacity

Defined in src/renderContext/hints/Hint.ts:363

Parameters:

Name Type
opacity number

Returns: void

setPriority

▸ setPriority(priority: number): void

Inherited from FilterableHint.setPriority

Defined in src/renderContext/hints/FilterableHint.ts:71

Parameters:

Name Type
priority number

Returns: void

setScale

▸ setScale(scale: any): void

Overrides FilterableHint.setScale

Defined in src/renderContext/hints/AnnotationHint.ts:58

Parameters:

Name Type
scale any

Returns: void

setToolHint

▸ setToolHint(isToolHint: boolean): void

Inherited from FilterableHint.setToolHint

Defined in src/renderContext/hints/Hint.ts:170

Sets whether this hint is a tool hint. Tool hints will be cleared when another tool is selected

Parameters:

Name Type Description
isToolHint boolean Whether this hint belongs to a tool

Returns: void

setVisible

▸ setVisible(visible: boolean): void

Inherited from FilterableHint.setVisible

Defined in src/renderContext/hints/Hint.ts:277

Parameters:

Name Type
visible boolean

Returns: void

show

▸ show(): void

Inherited from FilterableHint.show

Defined in src/renderContext/hints/Hint.ts:265

Returns: void

update

▸ update(): void

Overrides FilterableHint.update

Defined in src/renderContext/hints/AnnotationHint.ts:39

Returns: void