Skip to content

editor › Globals › DirectionHintPositionWrapper

Class: DirectionHintPositionWrapper ‹ProviderClass›

This class wraps a non-directional HintPositionProvider and gives it a (canvas-space) direction

Type parameters

▪ ProviderClass: HintPositionProvider

Hierarchy

↳ DirectionalHintPositionProvider

↳ DirectionHintPositionWrapper

Index

Constructors

Properties

Methods

Constructors

constructor

+ new DirectionHintPositionWrapper(positionProvider: ProviderClass, canvasSpaceDirection: Vector3): DirectionHintPositionWrapper

Defined in src/renderContext/hints/HintPositionProviders/DirectionHintPositionWrapper.ts:12

Parameters:

Name Type
positionProvider ProviderClass
canvasSpaceDirection Vector3

Returns: DirectionHintPositionWrapper

Properties

Private Readonly canvasSpaceDirection

• canvasSpaceDirection: Vector3

Defined in src/renderContext/hints/HintPositionProviders/DirectionHintPositionWrapper.ts:12

Private Readonly positionProvider

• positionProvider: ProviderClass

Defined in src/renderContext/hints/HintPositionProviders/DirectionHintPositionWrapper.ts:11

Methods

calculate

▸ calculate(): void

Overrides HintDataProvider.calculate

Defined in src/renderContext/hints/HintPositionProviders/DirectionHintPositionWrapper.ts:20

Returns: void

destroy

▸ destroy(): void

Inherited from HintDataProvider.destroy

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

Called when the hint that uses this provider is destroyed. You want to do cleanup here.

Returns: void

getCanvasPoints

▸ getCanvasPoints(): Vector3[]

Inherited from HintPositionProvider.getCanvasPoints

Defined in src/renderContext/hints/HintPositionProviders/HintPositionProvider.ts:37

Return the edge points of the hint on the screen. Used for filtering hints

Returns: Vector3[]

getEnd

▸ getEnd(): Vector3

Overrides DirectionalHintPositionProvider.getEnd

Defined in src/renderContext/hints/HintPositionProviders/DirectionHintPositionWrapper.ts:24

Returns: Vector3

getEndCanvas

▸ getEndCanvas(): Vector3

Overrides DirectionalHintPositionProvider.getEndCanvas

Defined in src/renderContext/hints/HintPositionProviders/DirectionHintPositionWrapper.ts:28

Returns: Vector3

getPosition

▸ getPosition(): Vector3

Overrides HintPositionProvider.getPosition

Defined in src/renderContext/hints/HintPositionProviders/DirectionHintPositionWrapper.ts:32

Returns: Vector3

getStart

▸ getStart(): Vector3

Overrides DirectionalHintPositionProvider.getStart

Defined in src/renderContext/hints/HintPositionProviders/DirectionHintPositionWrapper.ts:40

Returns: Vector3

getStartCanvas

▸ getStartCanvas(): Vector3

Overrides DirectionalHintPositionProvider.getStartCanvas

Defined in src/renderContext/hints/HintPositionProviders/DirectionHintPositionWrapper.ts:44

Returns: Vector3

getWorldPosition

▸ getWorldPosition(): Vector3

Overrides HintPositionProvider.getWorldPosition

Defined in src/renderContext/hints/HintPositionProviders/DirectionHintPositionWrapper.ts:36

Returns: Vector3

isValid

▸ isValid(): boolean

Overrides HintDataProvider.isValid

Defined in src/renderContext/hints/HintPositionProviders/DirectionHintPositionWrapper.ts:48

Returns: boolean

setCanvasSizeGetter

▸ setCanvasSizeGetter(getCanvasSize: function): void

Inherited from HintPositionProvider.setCanvasSizeGetter

Defined in src/renderContext/hints/HintPositionProviders/HintPositionProvider.ts:29

Called by the hint when it's added to the hintManager. The hintManager will provide a function to get the canvas size to the hint, which will foward it to the provider. Override if needed.

Parameters:

▪ getCanvasSize: function

▸ (): IDimensions2

Returns: void

setConversionMethod

▸ setConversionMethod(worldToCanvas: function): void

Overrides HintPositionProvider.setConversionMethod

Defined in src/renderContext/hints/HintPositionProviders/DirectionHintPositionWrapper.ts:52

Parameters:

▪ worldToCanvas: function

▸ (Vector3: any): Vector3

Parameters:

Name Type
Vector3 any

Returns: void