editor › Globals › MeshEdgePositionProvider

Class: MeshEdgePositionProvider

Position provider that calculates a position on a given edge, used e.g. in the EdgeHint. You can choose what kind of position you want. Default is the center of the edge.

Hierarchy

↳ DirectionalHintPositionProvider

↳ MeshEdgePositionProvider

Index

Constructors

• constructor

Properties

• alignmentValue
• anchor
• assembly
• endMesh
• fromAnchorToEnd
• positionAlongEdge
• positionCanvas
• positionWorld
• prevMesh
• startMesh
• worldToCanvas

Methods

• _assemblyToCanvas
• _onEdgeChange
• calculate
• destroy
• getCanvasPoints
• getEnd
• getEndCanvas
• getPosition
• getStart
• getStartCanvas
• getWorldPosition
• isValid
• setAlignmentValue
• setCanvasSizeGetter
• setConversionMethod
• updateFromAnchor

Constructors

constructor

+ new MeshEdgePositionProvider(anchor: MeshEdgeAnchor, assembly: Assembly, options: object): MeshEdgePositionProvider

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:69

Parameters:

▪ anchor: MeshEdgeAnchor

▪ assembly: Assembly

▪Default value options: object= {}

Name	Type
fromAnchorToEnd?	boolean
positionAlongEdge?	PositionAlongEdge

Returns: MeshEdgePositionProvider

Properties

Private alignmentValue

• alignmentValue: number

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

---

Private anchor

• anchor: MeshEdgeAnchor

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:58

---

Private assembly

• assembly: Assembly

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:60

---

Private Readonly endMesh

• endMesh: Vector3‹› = new Vector3()

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:62

---

Private Readonly fromAnchorToEnd

• fromAnchorToEnd: boolean

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:69

---

Private Readonly positionAlongEdge

• positionAlongEdge: PositionAlongEdge

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:64

---

Private positionCanvas

• positionCanvas: Vector3‹› = new Vector3()

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:66

---

Private positionWorld

• positionWorld: Vector3‹› = new Vector3()

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:67

---

Private Readonly prevMesh

• prevMesh: Vector3‹› = new Vector3()

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:63

---

Private Readonly startMesh

• startMesh: Vector3‹› = new Vector3()

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:61

---

Private worldToCanvas

• worldToCanvas: function = null

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

Type declaration:

▸ (Vector3: any): Vector3

Parameters:

Name	Type
Vector3	any

Methods

Private _assemblyToCanvas

▸ _assemblyToCanvas(assemblyPosition: Vector3): Vector3

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:256

Parameters:

Name	Type
assemblyPosition	Vector3

Returns: Vector3

---

Private _onEdgeChange

▸ _onEdgeChange(event: IMeshAnchorChangeEvent): void

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:228

Parameters:

Name	Type
event	IMeshAnchorChangeEvent

Returns: void

---

calculate

▸ calculate(): void

Overrides HintDataProvider.calculate

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:128

Returns: void

---

destroy

▸ destroy(): void

Overrides HintDataProvider.destroy

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:113

Returns: void

---

getCanvasPoints

▸ getCanvasPoints(): Vector3[]

Overrides HintPositionProvider.getCanvasPoints

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:206

Returns: Vector3[]

---

getEnd

▸ getEnd(): Vector3

Overrides DirectionalHintPositionProvider.getEnd

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:182

Returns: Vector3

---

getEndCanvas

▸ getEndCanvas(): Vector3

Overrides DirectionalHintPositionProvider.getEndCanvas

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:186

Returns: Vector3

---

getPosition

▸ getPosition(): Vector3

Overrides HintPositionProvider.getPosition

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:190

Returns: Vector3

---

getStart

▸ getStart(): Vector3

Overrides DirectionalHintPositionProvider.getStart

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:198

Returns: Vector3

---

getStartCanvas

▸ getStartCanvas(): Vector3

Overrides DirectionalHintPositionProvider.getStartCanvas

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:202

Returns: Vector3

---

getWorldPosition

▸ getWorldPosition(): Vector3

Overrides HintPositionProvider.getWorldPosition

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:194

Returns: Vector3

---

isValid

▸ isValid(): boolean

Overrides HintDataProvider.isValid

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:109

Returns: boolean

---

setAlignmentValue

▸ setAlignmentValue(alignmentValue: number): this

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:104

Parameters:

Name	Type
alignmentValue	number

Returns: this

---

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/MeshEdgePositionProvider.ts:124

Parameters:

▪ worldToCanvas: function

▸ (Vector3: any): Vector3

Parameters:

Name	Type
Vector3	any

Returns: void

---

updateFromAnchor

▸ updateFromAnchor(): void

Defined in src/renderContext/hints/HintPositionProviders/MeshEdgePositionProvider.ts:210

Returns: void