editor › Globals › InstructionStep

Class: InstructionStep

Serves as a translation layer from the IAssemblyInstruction tree to these InstructionSteps. The InstructionSteps are saved in an ordered collection where each object represents one step of the instruction booklet. It saves which plates have to be rendered and which have to be highlighted.

Hierarchy

• InstructionStep

Index

Constructors

• constructor

Properties

• instructions
• isUnconnected
• newPlates
• previouslyUsedPlates
• visiblePlates

Methods

• getPlateNames
• getSubassemblies
• getSubassemblyPlateInstructions
• mergeWith
• setPreviouslyUsedPlates
• shouldMerge

Constructors

constructor

+ new InstructionStep(instructions: IAssemblyInstruction[], visiblePlates: Set‹Plate›, newPlates: Set‹Plate›): InstructionStep

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/InstructionStep.ts:23

Parameters:

Name	Type
instructions	IAssemblyInstruction[]
visiblePlates	Set‹Plate›
newPlates	Set‹Plate›

Returns: InstructionStep

Properties

instructions

• instructions: IAssemblyInstruction[]

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

---

isUnconnected

• isUnconnected: boolean

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/InstructionStep.ts:23

---

newPlates

• newPlates: Set‹Plate›

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/InstructionStep.ts:19

---

previouslyUsedPlates

• previouslyUsedPlates: Plate[]

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/InstructionStep.ts:21

---

visiblePlates

• visiblePlates: Set‹Plate›

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

Methods

getPlateNames

▸ getPlateNames(): Map‹Plate, string›

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/InstructionStep.ts:88

Returns: Map‹Plate, string›

---

getSubassemblies

▸ getSubassemblies(): SubassemblyInstruction[]

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/InstructionStep.ts:73

Returns: SubassemblyInstruction[]

---

getSubassemblyPlateInstructions

▸ getSubassemblyPlateInstructions(): Plate[]

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/InstructionStep.ts:77

Returns: Plate[]

---

mergeWith

▸ mergeWith(lastStep: InstructionStep): InstructionStep

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

merges this instruction step with a given instruction step into a new one.

Parameters:

Name	Type	Description
lastStep	InstructionStep	the step to merge this one with

Returns: InstructionStep

---

setPreviouslyUsedPlates

▸ setPreviouslyUsedPlates(usedPlates: Plate[]): void

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/InstructionStep.ts:84

Parameters:

Name	Type
usedPlates	Plate[]

Returns: void

---

shouldMerge

▸ shouldMerge(otherStep: InstructionStep): boolean

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/InstructionStep.ts:40

Returns true if this step should merge with a given step: true if some plates belong to the same plategroup true if one of the steps is not connecting to previous plates false otherwise

Parameters:

Name	Type	Description
otherStep	InstructionStep	the step that we want to compare with our step.

Returns: boolean