editor › Globals › PlateInstruction

Class: PlateInstruction

A PlateInstruction is a single instruction where a plate is added to an assembly. Each plate has exactly one PlateInstruction step. It saves if the plate has to be tilted and knows to which plates of the current assembly it has to connect to.

Hierarchy

• PlateInstruction

Implements

• IAssemblyInstruction

Index

Constructors

• constructor

Properties

• groupID
• neighbours
• penalty
• plate
• tilted
• valid

Methods

• assignPlateIds
• forEachPlate
• getAllPlates
• getAssembly
• getCurrentConnectingPlates
• getPenalty
• getPlate
• getPlateCount
• getPlateInstruction
• isTilted
• setGroupId

Constructors

constructor

+ new PlateInstruction(plate: Plate, tilted: boolean, penalty: number, neighbours: Plate[]): PlateInstruction

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/PlateInstruction.ts:17

Parameters:

Name	Type
plate	Plate
tilted	boolean
penalty	number
neighbours	Plate[]

Returns: PlateInstruction

Properties

groupID

• groupID: number = -1

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/PlateInstruction.ts:12

---

Private Readonly neighbours

• neighbours: Plate[]

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/PlateInstruction.ts:17

---

Private Readonly penalty

• penalty: number

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/PlateInstruction.ts:14

---

Private Readonly plate

• plate: Plate

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/PlateInstruction.ts:16

---

Private Readonly tilted

• tilted: boolean

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/PlateInstruction.ts:15

---

valid

• valid: boolean = true

Implementation of IAssemblyInstruction.valid

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/PlateInstruction.ts:11

Methods

assignPlateIds

▸ assignPlateIds(startIndex: number): Map‹Plate, number›

Implementation of IAssemblyInstruction

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/PlateInstruction.ts:54

Parameters:

Name	Type
startIndex	number

Returns: Map‹Plate, number›

---

forEachPlate

▸ forEachPlate(handler: function): Promise‹void›

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/PlateInstruction.ts:62

Parameters:

▪ handler: function

▸ (plateInstruction: PlateInstruction): void

Parameters:

Name	Type
plateInstruction	PlateInstruction

Returns: Promise‹void›

---

getAllPlates

▸ getAllPlates(): Plate[]

Implementation of IAssemblyInstruction

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/PlateInstruction.ts:58

Returns: Plate[]

---

getAssembly

▸ getAssembly(): Assembly

Implementation of IAssemblyInstruction

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/PlateInstruction.ts:34

Returns: Assembly

---

getCurrentConnectingPlates

▸ getCurrentConnectingPlates(): Plate[]

Implementation of IAssemblyInstruction

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/PlateInstruction.ts:26

Returns: Plate[]

---

getPenalty

▸ getPenalty(): number

Implementation of IAssemblyInstruction

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/PlateInstruction.ts:30

Returns: number

---

getPlate

▸ getPlate(): Plate

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/PlateInstruction.ts:42

Returns: Plate

---

getPlateCount

▸ getPlateCount(): number

Implementation of IAssemblyInstruction

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/PlateInstruction.ts:66

Returns: number

---

getPlateInstruction

▸ getPlateInstruction(plate: Plate): PlateInstruction

Implementation of IAssemblyInstruction

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/PlateInstruction.ts:38

Parameters:

Name	Type
plate	Plate

Returns: PlateInstruction

---

isTilted

▸ isTilted(): boolean

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/PlateInstruction.ts:46

Returns: boolean

---

setGroupId

▸ setGroupId(id: number): void

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/PlateInstruction.ts:50

Parameters:

Name	Type
id	number

Returns: void