editor › Globals › HtmlHint

Class: HtmlHint

Hierarchy

• Hint

↳ HtmlHint

Index

Constructors

• constructor

Properties

• alignHorizontal
• alignVertical
• assembly
• children
• destroyed
• domNode
• externalChangeEventEmitter
• manager
• position
• scale
• threeMaterial
• threeNode
• unitConversionErrorEventEmitter
• visible

Methods

• _applyDOMScale
• _applyVisibility
• _getAlignmentOffset
• _onExternalChange
• _onUnitConversionError
• _projectAssemblyToCanvas
• add
• cancelFade
• destroy
• fadeOut
• focus
• getAssembly
• getChildren
• getDOMNode
• getDimensions
• getExternalChangeEventEmitter
• getHtml
• getScale
• getThreeNode
• getUnitConversionErrorEventEmitter
• hasMaterial
• hide
• initDOMNode
• initThreeNode
• isToolHint
• isValid
• isVisible
• makeInteractable
• remove
• removeAllListeners
• setAlignHorizontal
• setAlignVertical
• setAssembly
• setCanvasSizeGetter
• setClickThrough
• setConversionMethod
• setFontSize
• setHtml
• setManager
• setMaterial
• setOpacity
• setPosition
• setScale
• setToolHint
• setVisible
• show
• update

Constructors

constructor

+ new HtmlHint(assembly: Assembly): HtmlHint

Inherited from FilterableHint.constructor

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

Parameters:

Name	Type
assembly	Assembly

Returns: HtmlHint

Properties

Private alignHorizontal

• alignHorizontal: string = "left"

Defined in src/renderContext/hints/HtmlHint.ts:7

---

Private alignVertical

• alignVertical: string = "center"

Defined in src/renderContext/hints/HtmlHint.ts:8

---

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 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 manager

• manager: any = null

Inherited from FilterableHint.manager

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

---

Private position

• position: Vector3 = new Vector3()

Defined in src/renderContext/hints/HtmlHint.ts:6

---

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

Overrides FilterableHint._applyVisibility

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

Returns: void

---

Private _getAlignmentOffset

▸ _getAlignmentOffset(): object

Defined in src/renderContext/hints/HtmlHint.ts:83

Returns: object

• offsetX: string

• offsetY: string

---

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

---

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

---

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

---

getChildren

▸ getChildren(): Hint[]

Inherited from FilterableHint.getChildren

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

Returns: Hint[]

---

getDOMNode

▸ getDOMNode(): HTMLElement | null

Inherited from FilterableHint.getDOMNode

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

Returns: HTMLElement | null

---

getDimensions

▸ getDimensions(): object

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

Returns: object

• height: number = clientRect.height

• width: number = clientRect.width

---

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‹›]›

---

getHtml

▸ getHtml(): string

Defined in src/renderContext/hints/HtmlHint.ts:14

Returns: string

---

getScale

▸ getScale(): number

Inherited from FilterableHint.getScale

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

Returns: number

---

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›

---

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

Overrides FilterableHint.initDOMNode

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

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

---

isToolHint

▸ isToolHint(): boolean

Inherited from FilterableHint.isToolHint

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

Returns: boolean

---

isValid

▸ isValid(): boolean

Inherited from FilterableHint.isValid

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

The hint may use this to indicate that the object it annotates no longer exists.

Returns: boolean

Whether or not the hint is (still) valid.

---

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

---

setAlignHorizontal

▸ setAlignHorizontal(align: string): this

Defined in src/renderContext/hints/HtmlHint.ts:63

Parameters:

Name	Type
align	string

Returns: this

---

setAlignVertical

▸ setAlignVertical(align: string): this

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

Parameters:

Name	Type
align	string

Returns: this

---

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

---

setClickThrough

▸ setClickThrough(clickThrough: any): void

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

Parameters:

Name	Type
clickThrough	any

Returns: void

---

setConversionMethod

▸ setConversionMethod(worldToCanvas: function): void

Inherited from FilterableHint.setConversionMethod

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

Parameters:

▪ worldToCanvas: function

▸ (worldPosition: Vector3): Vector3

Parameters:

Name	Type
worldPosition	Vector3

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

---

setHtml

▸ setHtml(html: string): void

Defined in src/renderContext/hints/HtmlHint.ts:10

Parameters:

Name	Type
html	string

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

---

setPosition

▸ setPosition(position: Vector3): this

Defined in src/renderContext/hints/HtmlHint.ts:26

Parameters:

Name	Type
position	Vector3

Returns: this

---

setScale

▸ setScale(scale: number): void

Inherited from FilterableHint.setScale

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

Parameters:

Name	Type
scale	number

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/HtmlHint.ts:52

Returns: void