editor › Globals › AssemblyPositionProvider

Class: AssemblyPositionProvider

Position provider that gives you a fixed position in the given assembly.

Hierarchy

↳ HintPositionProvider

↳ AssemblyPositionProvider

Index

Constructors

• constructor

Properties

• assembly
• assemblyPosition
• positionCanvas
• positionWorld
• worldToCanvas

Methods

• calculate
• destroy
• getCanvasPoints
• getPosition
• getWorldPosition
• isValid
• setCanvasSizeGetter
• setConversionMethod

Constructors

constructor

+ new AssemblyPositionProvider(assembly: Assembly, assemblyPosition: Vector3): AssemblyPositionProvider

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

Parameters:

Name	Type
assembly	Assembly
assemblyPosition	Vector3

Returns: AssemblyPositionProvider

Properties

Private Readonly assembly

• assembly: Assembly

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

---

Private Readonly assemblyPosition

• assemblyPosition: Vector3

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

---

Private positionCanvas

• positionCanvas: Vector3

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

---

Private positionWorld

• positionWorld: Vector3

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

---

Private worldToCanvas

• worldToCanvas: function = null

Defined in src/renderContext/hints/HintPositionProviders/AssemblyPositionProvider.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/AssemblyPositionProvider.ts:25

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

---

getPosition

▸ getPosition(): Vector3

Overrides HintPositionProvider.getPosition

Defined in src/renderContext/hints/HintPositionProviders/AssemblyPositionProvider.ts:30

Returns: Vector3

---

getWorldPosition

▸ getWorldPosition(): Vector3

Overrides HintPositionProvider.getWorldPosition

Defined in src/renderContext/hints/HintPositionProviders/AssemblyPositionProvider.ts:34

Returns: Vector3

---

isValid

▸ isValid(): boolean

Overrides HintDataProvider.isValid

Defined in src/renderContext/hints/HintPositionProviders/AssemblyPositionProvider.ts:38

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/AssemblyPositionProvider.ts:21

Parameters:

▪ worldToCanvas: function

▸ (Vector3: any): Vector3

Parameters:

Name	Type
Vector3	any

Returns: void