editor › Globals › PlatePositionProvider

Class: PlatePositionProvider

Position provider that provides a position and a direction on a plate

Hierarchy

↳ DirectionalHintPositionProvider

↳ PlatePositionProvider

Index

Constructors

• constructor

Properties

• direction
• plate
• startPosition
• worldToCanvas

Methods

• _worldToCanvas2D
• calculate
• destroy
• getCanvasPoints
• getEnd
• getEndCanvas
• getPosition
• getStart
• getStartCanvas
• getWorldPosition
• isValid
• setCanvasSizeGetter
• setConversionMethod
• getAllPlatePositionsForPlate

Constructors

constructor

+ new PlatePositionProvider(plate: Plate, offset: Vector3, direction: Vector3): PlatePositionProvider

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

Parameters:

Name	Type
plate	Plate
offset	Vector3
direction	Vector3

Returns: PlatePositionProvider

Properties

Private Readonly direction

• direction: Vector3

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

---

Private plate

• plate: Plate

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

---

Private Readonly startPosition

• startPosition: Vector3

Defined in src/renderContext/hints/HintPositionProviders/PlatePositionProvider.ts:54

---

Private worldToCanvas

• worldToCanvas: function

Defined in src/renderContext/hints/HintPositionProviders/PlatePositionProvider.ts:53

Type declaration:

▸ (Vector3: any): Vector3

Parameters:

Name	Type
Vector3	any

Methods

Private _worldToCanvas2D

▸ _worldToCanvas2D(worldVector: Vector3): Vector3‹›

Defined in src/renderContext/hints/HintPositionProviders/PlatePositionProvider.ts:105

Parameters:

Name	Type
worldVector	Vector3

Returns: Vector3‹›

---

calculate

▸ calculate(): void

Overrides HintDataProvider.calculate

Defined in src/renderContext/hints/HintPositionProviders/PlatePositionProvider.ts:73

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

Overrides HintPositionProvider.getCanvasPoints

Defined in src/renderContext/hints/HintPositionProviders/PlatePositionProvider.ts:101

Returns: Vector3[]

---

getEnd

▸ getEnd(): Vector3

Overrides DirectionalHintPositionProvider.getEnd

Defined in src/renderContext/hints/HintPositionProviders/PlatePositionProvider.ts:77

Returns: Vector3

---

getEndCanvas

▸ getEndCanvas(): Vector3

Overrides DirectionalHintPositionProvider.getEndCanvas

Defined in src/renderContext/hints/HintPositionProviders/PlatePositionProvider.ts:81

Returns: Vector3

---

getPosition

▸ getPosition(): Vector3

Overrides HintPositionProvider.getPosition

Defined in src/renderContext/hints/HintPositionProviders/PlatePositionProvider.ts:85

Returns: Vector3

---

getStart

▸ getStart(): Vector3

Overrides DirectionalHintPositionProvider.getStart

Defined in src/renderContext/hints/HintPositionProviders/PlatePositionProvider.ts:93

Returns: Vector3

---

getStartCanvas

▸ getStartCanvas(): Vector3

Overrides DirectionalHintPositionProvider.getStartCanvas

Defined in src/renderContext/hints/HintPositionProviders/PlatePositionProvider.ts:97

Returns: Vector3

---

getWorldPosition

▸ getWorldPosition(): Vector3

Overrides HintPositionProvider.getWorldPosition

Defined in src/renderContext/hints/HintPositionProviders/PlatePositionProvider.ts:89

Returns: Vector3

---

isValid

▸ isValid(): boolean

Overrides HintDataProvider.isValid

Defined in src/renderContext/hints/HintPositionProviders/PlatePositionProvider.ts:65

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/PlatePositionProvider.ts:69

Parameters:

▪ worldToCanvas: function

▸ (Vector3: any): Vector3

Parameters:

Name	Type
Vector3	any

Returns: void

---

Static getAllPlatePositionsForPlate

▸ getAllPlatePositionsForPlate(plate: Plate): PlatePositionProvider[]

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

Generates possible PlatePositionProviders for a Plate. These positions and directions are: - Normal and negated normal at a position inside the plate provided by polylabel - Normal, negated normal and orthogonal direction pointing outwards for each outline midpoint (outline is offset) - Normal and negated normal at every outline point (outline is offset)

Parameters:

Name	Type	Description
plate	Plate	the plates for which the plate position providers will be generated

Returns: PlatePositionProvider[]