Skip to content

editor › Globals › HintManager

Class: HintManager

Hierarchy

  • HintManager

Index

Constructors

Properties

Methods

Constructors

constructor

+ new HintManager(hintNode: Object3D, camera: PerspectiveCamera, canvas: HTMLCanvasElement, modelSubnode: Object3D, domContainer: HTMLElement): HintManager

Defined in src/renderContext/hints/HintManager.ts:28

Parameters:

Name Type
hintNode Object3D
camera PerspectiveCamera
canvas HTMLCanvasElement
modelSubnode Object3D
domContainer HTMLElement

Returns: HintManager

Properties

Private cachedCanvasDimensions

• cachedCanvasDimensions: object

Defined in src/renderContext/hints/HintManager.ts:28

Type declaration:

  • height: number

  • width: number

Private Readonly camera

• camera: PerspectiveCamera

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

Private cameraDirection

• cameraDirection: Vector3‹› = new Vector3()

Defined in src/renderContext/hints/HintManager.ts:27

Private Readonly canvas

• canvas: HTMLCanvasElement

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

Private debugNode

• debugNode: Object3D‹› = new Object3D()

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

Private Readonly domContainer

• domContainer: HTMLElement

Defined in src/renderContext/hints/HintManager.ts:20

Private hintFilterStrategies

• hintFilterStrategies: PriorityHintFilterStrategy[] = []

Defined in src/renderContext/hints/HintManager.ts:21

Private hintHighlightMaterial

• hintHighlightMaterial: MeshBasicMaterial‹› = new MeshBasicMaterial({ color: Config.get("hints.highlightColor", 0xff0000) })

Defined in src/renderContext/hints/HintManager.ts:25

Private hintMaterial

• hintMaterial: MeshBasicMaterial‹› = new MeshBasicMaterial({ color: Config.get("hints.defaultColor", 0x000000) })

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

Private Readonly hintNode

• hintNode: Object3D

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

Private hints

• hints: Set‹Hint‹›› = new Set()

Defined in src/renderContext/hints/HintManager.ts:23

Private Readonly modelSubnode

• modelSubnode: Object3D

Defined in src/renderContext/hints/HintManager.ts:19

Methods

Private _getCanvasSize

▸ _getCanvasSize(): object

Defined in src/renderContext/hints/HintManager.ts:345

Returns: object

  • height: number

  • width: number

Private _hideDebugInfo

▸ _hideDebugInfo(): void

Defined in src/renderContext/hints/HintManager.ts:260

Returns: void

Private _renderCanvasPoint

▸ _renderCanvasPoint(position: Vector3, color: number, width: number, height: number): void

Defined in src/renderContext/hints/HintManager.ts:288

Parameters:

Name Type Default
position Vector3 -
color number 16711680
width number 5
height number 5

Returns: void

Private _setHintNodeTransformation

▸ _setHintNodeTransformation(): void

Defined in src/renderContext/hints/HintManager.ts:328

Returns: void

Private _showAssemblyPoints

▸ _showAssemblyPoints(assemblies: readonly Assembly[]): void

Defined in src/renderContext/hints/HintManager.ts:276

Parameters:

Name Type
assemblies readonly Assembly[]

Returns: void

Private _showCanvasAABB

▸ _showCanvasAABB(hint: FilterableHint): void

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

Parameters:

Name Type
hint FilterableHint

Returns: void

Private _showCanvasPoints

▸ _showCanvasPoints(hint: FilterableHint): void

Defined in src/renderContext/hints/HintManager.ts:264

Parameters:

Name Type
hint FilterableHint

Returns: void

Private _showCanvasPosition

▸ _showCanvasPosition(hint: FilterableHint): void

Defined in src/renderContext/hints/HintManager.ts:271

Parameters:

Name Type
hint FilterableHint

Returns: void

Private _showDebugInfo

▸ _showDebugInfo(): void

Defined in src/renderContext/hints/HintManager.ts:243

Returns: void

Private _updateHintsFilter

▸ _updateHintsFilter(): void

Defined in src/renderContext/hints/HintManager.ts:316

Returns: void

add

▸ add(...hints: readonly Hint[]): void

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

Parameters:

Name Type
...hints readonly Hint[]

Returns: void

addHintFilterStrategy

▸ addHintFilterStrategy(hintFilterStrategy: PriorityHintFilterStrategy): void

Defined in src/renderContext/hints/HintManager.ts:87

Parameters:

Name Type
hintFilterStrategy PriorityHintFilterStrategy

Returns: void

clearHints

▸ clearHints(): boolean

Defined in src/renderContext/hints/HintManager.ts:198

Returns: boolean

clearToolHints

▸ clearToolHints(customFilter: function): boolean

Defined in src/renderContext/hints/HintManager.ts:186

Parameters:

▪Default value customFilter: function= () => true

▸ (hint: Hint): boolean

Parameters:

Name Type
hint Hint

Returns: boolean

getHintFilterStrategy

▸ getHintFilterStrategy(hint: FilterableHint): PriorityHintFilterStrategy | null

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

Parameters:

Name Type
hint FilterableHint

Returns: PriorityHintFilterStrategy | null

getHintHighlightMaterial

▸ getHintHighlightMaterial(): MeshBasicMaterial

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

Returns: MeshBasicMaterial

getHintMaterial

▸ getHintMaterial(): MeshBasicMaterial

Defined in src/renderContext/hints/HintManager.ts:79

Returns: MeshBasicMaterial

getHintNode

▸ getHintNode(): Object3D

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

Returns: Object3D

getHints

▸ getHints(): Hint[]

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

Returns: Hint[]

initHints

▸ initHints(hints: readonly Hint[]): void

Defined in src/renderContext/hints/HintManager.ts:117

This method initializes hints, so that they can be scored by a HintFilterStrategy.

Parameters:

Name Type
hints readonly Hint[]

Returns: void

projectCanvasToWindow

▸ projectCanvasToWindow(canvasPosition: Vector3): Vector3

Defined in src/renderContext/hints/HintManager.ts:239

Projects a position from canvas space (origin is in center of window) into window space used by css (origin is in top left).

Parameters:

Name Type Description
canvasPosition Vector3 position in canvas space

Returns: Vector3

projectWorldToCanvas

▸ projectWorldToCanvas(worldPosition: Vector3): Vector3

Defined in src/renderContext/hints/HintManager.ts:230

Parameters:

Name Type
worldPosition Vector3

Returns: Vector3

remove

▸ remove(...hints: readonly Hint[]): void

Defined in src/renderContext/hints/HintManager.ts:130

Parameters:

Name Type
...hints readonly Hint[]

Returns: void

removeHintFilterStrategy

▸ removeHintFilterStrategy(hintFilterStrategy: PriorityHintFilterStrategy): void

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

Parameters:

Name Type
hintFilterStrategy PriorityHintFilterStrategy

Returns: void

removeHintFromFilterStrategy

▸ removeHintFromFilterStrategy(...hintsToRemove: readonly FilterableHint[]): void

Defined in src/renderContext/hints/HintManager.ts:157

Parameters:

Name Type
...hintsToRemove readonly FilterableHint[]

Returns: void

removeInvalidHints

▸ removeInvalidHints(): void

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

Returns: void

set

▸ set(...hints: readonly Hint[]): void

Defined in src/renderContext/hints/HintManager.ts:125

Parameters:

Name Type
...hints readonly Hint[]

Returns: void

startCachingCanvasDimensions

▸ startCachingCanvasDimensions(): void

Defined in src/renderContext/hints/HintManager.ts:222

Returns: void

stopCachingCanvasDimensions

▸ stopCachingCanvasDimensions(): void

Defined in src/renderContext/hints/HintManager.ts:226

Returns: void

update

▸ update(): void

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

Returns: void