editor › Globals › IAssemblyInstruction

Interface: IAssemblyInstruction

One step when assembling a model. Can be a PlateInstruction, which adds a new plate the the build, or a SubassemblyInstruction, which contains a list of IAssemblyInstructions which are finished first, before adding the result to the previously build object. When performing a depth first search through this AssemblyInstruction tree the order in which PlateInstructions occur are the ids that are engraved on the plates.

Hierarchy

• IAssemblyInstruction

Implemented by

• PlateInstruction
• SubassemblyInstruction

Index

Properties

• valid

Methods

• assignPlateIds
• forEachPlate
• getAllPlates
• getAssembly
• getCurrentConnectingPlates
• getPenalty
• getPlateCount
• getPlateInstruction

Properties

valid

• valid: boolean

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

Methods

assignPlateIds

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

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

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/IAssemblyInstruction.ts:19

Parameters:

▪ handler: function

▸ (plateInstruction: PlateInstruction): void

Parameters:

Name	Type
plateInstruction	PlateInstruction

Returns: Promise‹void›

---

getAllPlates

▸ getAllPlates(): Plate[]

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/IAssemblyInstruction.ts:22

Returns: Plate[]

---

getAssembly

▸ getAssembly(): Assembly

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

Returns: Assembly

---

getCurrentConnectingPlates

▸ getCurrentConnectingPlates(): Plate[]

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

Returns: Plate[]

---

getPenalty

▸ getPenalty(): number

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/IAssemblyInstruction.ts:13

Returns: number

---

getPlateCount

▸ getPlateCount(): number

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/IAssemblyInstruction.ts:20

Returns: number

---

getPlateInstruction

▸ getPlateInstruction(plate: Plate): PlateInstruction

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

Parameters:

Name	Type
plate	Plate

Returns: PlateInstruction