Skip to content

editor › Globals › PositionablePositionProvider

Class: PositionablePositionProvider

Hierarchy

↳ HintPositionOffsetProvider

↳ PositionablePositionProvider

Index

Constructors

Properties

Methods

Constructors

constructor

+ new PositionablePositionProvider(positionableElement: IPositionable, offsetWithinPositionable: Vector3): PositionablePositionProvider

Defined in src/renderContext/hints/HintPositionProviders/PositionablePositionProvider.ts:13

Parameters:

Name Type Default
positionableElement IPositionable -
offsetWithinPositionable Vector3 new Vector3()

Returns: PositionablePositionProvider

Properties

Private canvasSizeGetter

• canvasSizeGetter: function = null

Defined in src/renderContext/hints/HintPositionProviders/PositionablePositionProvider.ts:10

Type declaration:

▸ (): IDimensions2

Private offset

• offset: Vector3 = new Vector3(1, 0, 0)

Defined in src/renderContext/hints/HintPositionProviders/PositionablePositionProvider.ts:9

Private offsetWithinPositionable

• offsetWithinPositionable: Vector3

Defined in src/renderContext/hints/HintPositionProviders/PositionablePositionProvider.ts:13

Private position

• position: Vector3 = new Vector3()

Defined in src/renderContext/hints/HintPositionProviders/PositionablePositionProvider.ts:8

Private Readonly positionableElement

• positionableElement: IPositionable = null

Defined in src/renderContext/hints/HintPositionProviders/PositionablePositionProvider.ts:7

Private worldPosition

• worldPosition: Vector3‹› = new Vector3()

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

Private worldToCanvas

• worldToCanvas: function = null

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

Type declaration:

▸ (Vector3: any): Vector3

Parameters:

Name Type
Vector3 any

Methods

calculate

▸ calculate(): void

Overrides HintDataProvider.calculate

Defined in src/renderContext/hints/HintPositionProviders/PositionablePositionProvider.ts:21

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[]

getOrthogonalOffset

▸ getOrthogonalOffset(): Vector3

Overrides HintPositionOffsetProvider.getOrthogonalOffset

Defined in src/renderContext/hints/HintPositionProviders/PositionablePositionProvider.ts:47

Returns: Vector3

getPosition

▸ getPosition(): Vector3‹›

Overrides HintPositionProvider.getPosition

Defined in src/renderContext/hints/HintPositionProviders/PositionablePositionProvider.ts:39

Returns: Vector3‹›

getWorldPosition

▸ getWorldPosition(): Vector3

Overrides HintPositionProvider.getWorldPosition

Defined in src/renderContext/hints/HintPositionProviders/PositionablePositionProvider.ts:43

Returns: Vector3

isValid

▸ isValid(): boolean

Overrides HintDataProvider.isValid

Defined in src/renderContext/hints/HintPositionProviders/PositionablePositionProvider.ts:59

Returns: boolean

setCanvasSizeGetter

▸ setCanvasSizeGetter(getCanvasSize: function): void

Overrides HintPositionProvider.setCanvasSizeGetter

Defined in src/renderContext/hints/HintPositionProviders/PositionablePositionProvider.ts:55

Parameters:

▪ getCanvasSize: function

▸ (): IDimensions2

Returns: void

setConversionMethod

▸ setConversionMethod(worldToCanvas: function): void

Overrides HintPositionProvider.setConversionMethod

Defined in src/renderContext/hints/HintPositionProviders/PositionablePositionProvider.ts:51

Parameters:

▪ worldToCanvas: function

▸ (Vector3: any): Vector3

Parameters:

Name Type
Vector3 any

Returns: void