editor › Globals › ImportedModelPositionProvider

Class: ImportedModelPositionProvider

Imagining an AABB with dimensions given by importerModelDescriptor, this PositionProvider calculates a position alongside a front edge representing dimension. Looking at the AABB from the front, the edges for each dimension (x, y, z) are as shown, ox etc stands for 'opposite x': +oxoxoxoxoxoxox+ /| /| / | / | xxxxxxxxxxxxxx | oz | z | oz | z | oz | z | oz +-----------z--+ oz y z oy ozy zoy --------------

Hierarchy

↳ DirectionalHintPositionProvider

↳ ImportedModelPositionProvider

Index

Constructors

• constructor

Properties

• assembly
• descriptorAnchor
• endPosition
• importedModelDescriptor
• lerpValue
• positionCanvas
• positionWorld
• selectedDimension
• startPosition
• takeOppositeSide
• worldToCanvas

Methods

• _assemblyToCanvas
• _initializePositions
• _onDimensionsChange
• calculate
• destroy
• getCanvasPoints
• getEnd
• getEndCanvas
• getPosition
• getStart
• getStartCanvas
• getWorldPosition
• isValid
• setCanvasSizeGetter
• setConversionMethod

Constructors

constructor

+ new ImportedModelPositionProvider(importedModelDescriptor: ImportedModelDescriptor, dimension: Dimension, assembly: Assembly, lerpValue: number, takeOppositeSide: boolean): ImportedModelPositionProvider

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

example Given dimensions (1, 2, 3) with selected dimension x and a lerp value of 0.3: (0, 2, 0)X----o----------X(1, 2, 0) ^ (0.3, 2, 0)

Parameters:

Name	Type	Default	Description
importedModelDescriptor	ImportedModelDescriptor	-	modelelement describing the size of an assembly regarding three dimensions
dimension	Dimension	-	which dimension of the importedModelDescriptor will serve as the base. Depending on the dimension, the position will be along an edge parallel to that dimension in regards to the lerpValue
assembly	Assembly	-	-
lerpValue	number	0.5	a value [0;1] which determines where the offset is placed. 0 will move it to the lower corner, 0.5 would move it to the center and 1 to the upper corner of that dimension.
takeOppositeSide	boolean	false	whether or not the opposite site of that dimension should be lerped along.

Returns: ImportedModelPositionProvider

Properties

Private assembly

• assembly: Assembly

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

---

Private Readonly descriptorAnchor

• descriptorAnchor: IPositionableElementTransformsDefiner

Defined in src/renderContext/hints/HintPositionProviders/ImportedModelPositionProvider.ts:27

---

Private endPosition

• endPosition: Vector3‹› = new Vector3()

Defined in src/renderContext/hints/HintPositionProviders/ImportedModelPositionProvider.ts:31

---

Private importedModelDescriptor

• importedModelDescriptor: ImportedModelDescriptor

Defined in src/renderContext/hints/HintPositionProviders/ImportedModelPositionProvider.ts:26

---

Private lerpValue

• lerpValue: number = 0.5

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

---

Private positionCanvas

• positionCanvas: Vector3 = new Vector3()

Defined in src/renderContext/hints/HintPositionProviders/ImportedModelPositionProvider.ts:35

---

Private positionWorld

• positionWorld: Vector3‹› = new Vector3()

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

---

Private Readonly selectedDimension

• selectedDimension: Dimension

Defined in src/renderContext/hints/HintPositionProviders/ImportedModelPositionProvider.ts:33

---

Private startPosition

• startPosition: Vector3‹› = new Vector3()

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

---

Private takeOppositeSide

• takeOppositeSide: boolean

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

---

Private worldToCanvas

• worldToCanvas: function = null

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

Type declaration:

▸ (Vector3: any): Vector3

Parameters:

Name	Type
Vector3	any

Methods

Private _assemblyToCanvas

▸ _assemblyToCanvas(assemblyPosition: Vector3): Vector3

Defined in src/renderContext/hints/HintPositionProviders/ImportedModelPositionProvider.ts:173

Parameters:

Name	Type
assemblyPosition	Vector3

Returns: Vector3

---

Private _initializePositions

▸ _initializePositions(): void

Defined in src/renderContext/hints/HintPositionProviders/ImportedModelPositionProvider.ts:122

Returns: void

---

Private _onDimensionsChange

▸ _onDimensionsChange(event: IModelElementEvent): void

Defined in src/renderContext/hints/HintPositionProviders/ImportedModelPositionProvider.ts:169

Parameters:

Name	Type
event	IModelElementEvent

Returns: void

---

calculate

▸ calculate(): void

Overrides HintDataProvider.calculate

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

Returns: void

---

destroy

▸ destroy(): void

Overrides HintDataProvider.destroy

Defined in src/renderContext/hints/HintPositionProviders/ImportedModelPositionProvider.ts:79

Returns: void

---

getCanvasPoints

▸ getCanvasPoints(): Vector3[]

Overrides HintPositionProvider.getCanvasPoints

Defined in src/renderContext/hints/HintPositionProviders/ImportedModelPositionProvider.ts:118

Returns: Vector3[]

---

getEnd

▸ getEnd(): Vector3

Overrides DirectionalHintPositionProvider.getEnd

Defined in src/renderContext/hints/HintPositionProviders/ImportedModelPositionProvider.ts:86

Returns: Vector3

---

getEndCanvas

▸ getEndCanvas(): Vector3

Overrides DirectionalHintPositionProvider.getEndCanvas

Defined in src/renderContext/hints/HintPositionProviders/ImportedModelPositionProvider.ts:90

Returns: Vector3

---

getPosition

▸ getPosition(): Vector3

Overrides HintPositionProvider.getPosition

Defined in src/renderContext/hints/HintPositionProviders/ImportedModelPositionProvider.ts:94

Returns: Vector3

---

getStart

▸ getStart(): Vector3

Overrides DirectionalHintPositionProvider.getStart

Defined in src/renderContext/hints/HintPositionProviders/ImportedModelPositionProvider.ts:98

Returns: Vector3

---

getStartCanvas

▸ getStartCanvas(): Vector3

Overrides DirectionalHintPositionProvider.getStartCanvas

Defined in src/renderContext/hints/HintPositionProviders/ImportedModelPositionProvider.ts:102

Returns: Vector3

---

getWorldPosition

▸ getWorldPosition(): Vector3

Overrides HintPositionProvider.getWorldPosition

Defined in src/renderContext/hints/HintPositionProviders/ImportedModelPositionProvider.ts:106

Returns: Vector3

---

isValid

▸ isValid(): boolean

Overrides HintDataProvider.isValid

Defined in src/renderContext/hints/HintPositionProviders/ImportedModelPositionProvider.ts:110

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/ImportedModelPositionProvider.ts:114

Parameters:

▪ worldToCanvas: function

▸ (Vector3: any): Vector3

Parameters:

Name	Type
Vector3	any

Returns: void