editor › Globals › ScreenshotBookletStep

Class: ScreenshotBookletStep

Used by other steps to add annotated screenshots to the booklet.

Hierarchy

• BookletStep

↳ ScreenshotBookletStep

Index

Constructors

• constructor

Properties

• height
• newPlates
• plateNames
• screenshot
• smartCrop
• texts
• visiblePlates
• width

Methods

• _addText
• addPartNumbers
• addToPdf
• getNewPlates
• getVisiblePlates
• isStartPointForFriend
• render
• setScreenshot
• _getVerticalAlignment

Constructors

constructor

+ new ScreenshotBookletStep(visiblePlates: Set‹Plate›, newPlates: Set‹Plate›, width: number, height: number, smartCrop: object, plateNames: Map‹Plate, string›): ScreenshotBookletStep

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

Parameters:

▪ visiblePlates: Set‹Plate›

▪ newPlates: Set‹Plate›

▪ width: number

▪ height: number

▪Default value smartCrop: object= undefined

Name	Type
height	number
width	number

▪Default value plateNames: Map‹Plate, string›= new Map()

Returns: ScreenshotBookletStep

Properties

Readonly height

• height: number

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/ScreenshotBookletStep.ts:35

---

Private Readonly newPlates

• newPlates: Set‹Plate›

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/ScreenshotBookletStep.ts:39

---

Private Readonly plateNames

• plateNames: Map‹Plate, string›

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

---

screenshot

• screenshot: string

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/ScreenshotBookletStep.ts:28

---

Readonly smartCrop

• smartCrop: object

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/ScreenshotBookletStep.ts:36

Type declaration:

• height: number

• width: number

---

texts

• texts: Array‹object› = []

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/ScreenshotBookletStep.ts:29

---

Private Readonly visiblePlates

• visiblePlates: Set‹Plate›

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

---

Readonly width

• width: number

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

Methods

Private _addText

▸ _addText(text: string, position: Vector3, alignment: object): void

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/ScreenshotBookletStep.ts:104

Parameters:

▪ text: string

▪ position: Vector3

▪ alignment: object

Name	Type
horizontal	"left" | "center" | "right"
vertical	"top" | "center" | "bottom"

Returns: void

---

addPartNumbers

▸ addPartNumbers(canvasSize: Vector3, hintManager: HintManager): void

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/ScreenshotBookletStep.ts:91

Parameters:

Name	Type
canvasSize	Vector3
hintManager	HintManager

Returns: void

---

addToPdf

▸ addToPdf(doc: jsPDF, xOffset: number, yOffset: number, pageNumber: number): Promise‹number›

Overrides BookletStep.addToPdf

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/ScreenshotBookletStep.ts:63

Parameters:

Name	Type
doc	jsPDF
xOffset	number
yOffset	number
pageNumber	number

Returns: Promise‹number›

---

getNewPlates

▸ getNewPlates(): Set‹Plate›

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/ScreenshotBookletStep.ts:87

Returns: Set‹Plate›

---

getVisiblePlates

▸ getVisiblePlates(): Set‹Plate›

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

Returns: Set‹Plate›

---

isStartPointForFriend

▸ isStartPointForFriend(): boolean

Inherited from BookletStep.isStartPointForFriend

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/BookletStep.ts:9

Returns: boolean

---

render

▸ render(takeScreenshot: function): Promise‹void›

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/ScreenshotBookletStep.ts:59

Parameters:

▪ takeScreenshot: function

▸ (visiblePlates: any, newPlates: any, width: any, height: any): Promise‹string›

Parameters:

Name	Type
visiblePlates	any
newPlates	any
width	any
height	any

Returns: Promise‹void›

---

setScreenshot

▸ setScreenshot(screenshot: string): void

Defined in src/modules/kyub.core.svgObjExporter/src/export/assemblyInstructions/BookletSteps/ScreenshotBookletStep.ts:80

Parameters:

Name	Type
screenshot	string

Returns: void

---

Static Private _getVerticalAlignment

▸ _getVerticalAlignment(doc: jsPDF, text: object): number

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

Parameters:

▪ doc: jsPDF

▪ text: object

Name	Type
alignment	object
position	Vector3
text	string

Returns: number