editor › Globals › Nester

Class: Nester

Defines the base class for a nesting algorithm

Hierarchy

• PipelineEventsEmitter

↳ Nester

↳ SvgNester

↳ UnfoldingNester

↳ SimpleNester

Index

Constructors

• constructor

Properties

• cancelToken
• groupRepresentationsMap
• height
• hintEventEmitter
• progressEventEmitter
• warningEventEmitter
• width

Methods

• _onHint
• _onProgress
• _onWarning
• getHeight
• getHintEventEmitter
• getProgressEventEmitter
• getWarningEventEmitter
• getWidth
• nest

Constructors

constructor

+ new Nester(groupRepresentationsMap: Map‹PlateGroup, IPlateGroup2DRepresentations›, __namedParameters: [number, number], cancelToken?: CancelToken): Nester

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

Parameters:

Name	Type	Description
groupRepresentationsMap	Map‹PlateGroup, IPlateGroup2DRepresentations›	a Map that maps PlateGroups to different 2D representations of them. The nester may use solely the polygonWithCutouts representation to get the most space efficient layout or they may use the extended information to better inform their decision.
__namedParameters	[number, number]	-
cancelToken?	CancelToken	optional, use to cancel the nesting progress

Returns: Nester

Properties

Protected Readonly cancelToken

• cancelToken: any

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

---

Protected groupRepresentationsMap

• groupRepresentationsMap: Map‹PlateGroup, IPlateGroup2DRepresentations›

Defined in src/modules/kyub.core.svgObjExporter/src/export/Nester.ts:18

---

Protected height

• height: number

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

---

Protected Readonly hintEventEmitter

• hintEventEmitter: EventEmitter‹object› = new EventEmitter<{ message: string; newExportSettings?; }>()

Inherited from PipelineEventsEmitter.hintEventEmitter

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:20

---

Protected Readonly progressEventEmitter

• progressEventEmitter: EventEmitter‹object› = new EventEmitter<{ stage: string; progress: number; }>()

Inherited from PipelineEventsEmitter.progressEventEmitter

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:12

---

Protected Readonly warningEventEmitter

• warningEventEmitter: EventEmitter‹object› = new EventEmitter<{ code: string; message: string; }>()

Inherited from PipelineEventsEmitter.warningEventEmitter

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:16

---

Protected width

• width: number

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

Methods

Protected _onHint

▸ _onHint(hint: any): void

Inherited from PipelineEventsEmitter._onHint

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:45

Parameters:

Name	Type
hint	any

Returns: void

---

Protected _onProgress

▸ _onProgress(args: object): void

Inherited from PipelineEventsEmitter._onProgress

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:37

Parameters:

▪ args: object

Name	Type
progress	number
stage	string

Returns: void

---

Protected _onWarning

▸ _onWarning(warning: object): void

Inherited from PipelineEventsEmitter._onWarning

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:41

Parameters:

▪ warning: object

Name	Type
code	string
message	string

Returns: void

---

getHeight

▸ getHeight(): number

Defined in src/modules/kyub.core.svgObjExporter/src/export/Nester.ts:52

Returns: number

---

getHintEventEmitter

▸ getHintEventEmitter(): IPublicEventEmitterInterface‹object›

Inherited from PipelineEventsEmitter.getHintEventEmitter

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:33

Returns: IPublicEventEmitterInterface‹object›

---

getProgressEventEmitter

▸ getProgressEventEmitter(): IPublicEventEmitterInterface‹object›

Inherited from PipelineEventsEmitter.getProgressEventEmitter

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:25

Returns: IPublicEventEmitterInterface‹object›

---

getWarningEventEmitter

▸ getWarningEventEmitter(): IPublicEventEmitterInterface‹object›

Inherited from PipelineEventsEmitter.getWarningEventEmitter

Defined in src/modules/kyub.core.svgObjExporter/src/PipelineEventsEmitter.ts:29

Returns: IPublicEventEmitterInterface‹object›

---

getWidth

▸ getWidth(): number

Defined in src/modules/kyub.core.svgObjExporter/src/export/Nester.ts:48

Returns: number

---

Abstract nest

▸ nest(spacing: number): Promise‹IPage[]›

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

Should transform the given outlines to place them next to each other

Parameters:

Name	Type	Description
spacing	number	how much space to leave between the polygons

Returns: Promise‹IPage[]›

updated outlines