editor › Globals › SafetyMarginGeometryStep
Class: SafetyMarginGeometryStep
When rendering the fake cutouts, we need to clip cutouts at the safety margin. To do this, we subdivide each plate into two geometries: The outer ring that is implicitly created by the safety margin and the rest of the plate. Both have to be different geometries so they can have different materials. Thus, cutouts will only be rendered on the inner part and not on the safety margin.
Hierarchy
↳ SafetyMarginGeometryStep
Index
Properties
Methods
- _insetPolygonOutline
- _run
- _runAsynchronously
- _runAsynchronouslyForAllPlates
- _runForAllPlates
- cancel
- getWarningEventEmitter
- run
- runAsynchronously
- runAsynchronouslyForAllPlates
- runForAllPlates
Properties
Protected cancelled
• cancelled: boolean = false
Inherited from PlatePipelineStep.cancelled
Defined in src/model/visualization/Plates/PlatePipeline/PlatePipelineStep.ts:76
Protected Readonly warningEventEmitter
• warningEventEmitter: EventEmitter‹object› = new EventEmitter<{ code: string; message: string; }>()
Inherited from PlatePipelineStep.warningEventEmitter
Defined in src/model/visualization/Plates/PlatePipeline/PlatePipelineStep.ts:77
Methods
Private _insetPolygonOutline
▸ _insetPolygonOutline(multiPolygon: MultiPolygon, distance: number): MultiPolygon
Defined in src/model/visualization/Plates/PlatePipeline/SafetyMarginGeometryStep.ts:49
Return a copy of the given polygon where the outline is inset by distance units.
Parameters:
| Name | Type | Description |
|---|---|---|
multiPolygon |
MultiPolygon | - |
distance |
number | - |
Returns: MultiPolygon
Protected _run
▸ _run(config: PlatePipelineConfig, resultObject: IPlatePipelineResult): void
Overrides PlatePipelineStep._run
Defined in src/model/visualization/Plates/PlatePipeline/SafetyMarginGeometryStep.ts:23
Parameters:
| Name | Type |
|---|---|
config |
PlatePipelineConfig |
resultObject |
IPlatePipelineResult |
Returns: void
Protected _runAsynchronously
▸ _runAsynchronously(config: PlatePipelineConfig, resultObject: IPlatePipelineResult): Promise‹void›
Inherited from PlatePipelineStep._runAsynchronously
Defined in src/model/visualization/Plates/PlatePipeline/PlatePipelineStep.ts:115
Parameters:
| Name | Type |
|---|---|
config |
PlatePipelineConfig |
resultObject |
IPlatePipelineResult |
Returns: Promise‹void›
Protected _runAsynchronouslyForAllPlates
▸ _runAsynchronouslyForAllPlates(configs: PlatePipelineConfig[], resultObjects: IPlatePipelineResult[]): Promise‹void›
Inherited from PlatePipelineStep._runAsynchronouslyForAllPlates
Defined in src/model/visualization/Plates/PlatePipeline/PlatePipelineStep.ts:125
Parameters:
| Name | Type |
|---|---|
configs |
PlatePipelineConfig[] |
resultObjects |
IPlatePipelineResult[] |
Returns: Promise‹void›
Protected _runForAllPlates
▸ _runForAllPlates(configs: PlatePipelineConfig[], resultObjects: IPlatePipelineResult[]): void
Inherited from PlatePipelineStep._runForAllPlates
Defined in src/model/visualization/Plates/PlatePipeline/PlatePipelineStep.ts:119
Parameters:
| Name | Type |
|---|---|
configs |
PlatePipelineConfig[] |
resultObjects |
IPlatePipelineResult[] |
Returns: void
cancel
▸ cancel(): void
Inherited from PlatePipelineStep.cancel
Defined in src/model/visualization/Plates/PlatePipeline/PlatePipelineStep.ts:109
Returns: void
getWarningEventEmitter
▸ getWarningEventEmitter(): IPublicEventEmitterInterface‹object›
Inherited from PlatePipelineStep.getWarningEventEmitter
Defined in src/model/visualization/Plates/PlatePipeline/PlatePipelineStep.ts:82
Returns: IPublicEventEmitterInterface‹object›
run
▸ run(config: PlatePipelineConfig, resultObject: IPlatePipelineResult): void
Inherited from PlatePipelineStep.run
Defined in src/model/visualization/Plates/PlatePipeline/PlatePipelineStep.ts:86
Parameters:
| Name | Type |
|---|---|
config |
PlatePipelineConfig |
resultObject |
IPlatePipelineResult |
Returns: void
runAsynchronously
▸ runAsynchronously(config: PlatePipelineConfig, resultObject: IPlatePipelineResult): Promise‹void›
Inherited from PlatePipelineStep.runAsynchronously
Defined in src/model/visualization/Plates/PlatePipeline/PlatePipelineStep.ts:91
Parameters:
| Name | Type |
|---|---|
config |
PlatePipelineConfig |
resultObject |
IPlatePipelineResult |
Returns: Promise‹void›
runAsynchronouslyForAllPlates
▸ runAsynchronouslyForAllPlates(configs: PlatePipelineConfig[], resultObjects: IPlatePipelineResult[]): Promise‹void›
Inherited from PlatePipelineStep.runAsynchronouslyForAllPlates
Defined in src/model/visualization/Plates/PlatePipeline/PlatePipelineStep.ts:101
Parameters:
| Name | Type |
|---|---|
configs |
PlatePipelineConfig[] |
resultObjects |
IPlatePipelineResult[] |
Returns: Promise‹void›
runForAllPlates
▸ runForAllPlates(configs: PlatePipelineConfig[], resultObjects: IPlatePipelineResult[]): void
Inherited from PlatePipelineStep.runForAllPlates
Defined in src/model/visualization/Plates/PlatePipeline/PlatePipelineStep.ts:96
Parameters:
| Name | Type |
|---|---|
configs |
PlatePipelineConfig[] |
resultObjects |
IPlatePipelineResult[] |
Returns: void