Class Slic3rMetadataParser

Abstract base class for slicer-specific metadata parsers

Hierarchy (View Summary)

SlicerMetadataParser
- Slic3rMetadataParser

Index

Constructors

Properties

identificationPatterns slicerName

Methods

canParse derivesExtrusionDimensions detectSlicerName parseExtrusionDimensions parseFilamentDiameter parseLayerMetadata

Constructors

constructor

new Slic3rMetadataParser(): Slic3rMetadataParser
Returns Slic3rMetadataParser
Inherited from SlicerMetadataParser.constructor

Properties

`Readonly`identificationPatterns

identificationPatterns: RegExp[] = ...

Patterns that identify this slicer in gcode comments

`Readonly`slicerName

slicerName: "Slic3r" = 'Slic3r'

The name of the slicer this parser handles

Methods

canParse

canParse(commentCommands: GCodeCommand[], maxLines?: number): boolean
Checks if this parser can handle the given gcode based on comments
Parameters
- commentCommands: GCodeCommand[]
  Array of gcode commands with comments
- maxLines: number = 200
  How many of those commands to sample before giving up
Returns boolean
True if this parser can handle the gcode
Inherited from SlicerMetadataParser.canParse
- Defined in src/parser/metadata-parser-base.ts:67

derivesExtrusionDimensions

derivesExtrusionDimensions(commentCommands: GCodeCommand[]): boolean
Whether the moves of this gcode can be trusted to derive per-path extrusion dimensions from
Parameters
- commentCommands: GCodeCommand[]
  Array of gcode commands with comments
Returns boolean
True unless the dialect's E values are not filament lengths

Remarks
Deriving is the default, for every dialect and for gcode no parser recognised: a file that announces its dimensions simply outranks the derived values path by path (the Job resolves that order), so there is nothing to gate on. A dialect only opts out when the arithmetic itself does not hold -- Cura's UltiGCode flavor, whose E is cubic millimetres of material rather than millimetres of filament, would otherwise derive confidently wrong widths. Evaluated on the chunk that identified the slicer (like detectSlicerName), so it can inspect header comments.
Inherited from SlicerMetadataParser.derivesExtrusionDimensions
- Defined in src/parser/metadata-parser-base.ts:122

detectSlicerName

detectSlicerName(commentCommands: GCodeCommand[]): string
Resolves the slicer name to report for the given gcode.
Parameters
- commentCommands: GCodeCommand[]
  Array of gcode commands with comments
Returns string
The slicer name

Remarks
Parsers that handle a family of slicers sharing one comment dialect override this to report the specific generator named in the header.
Inherited from SlicerMetadataParser.detectSlicerName
- Defined in src/parser/metadata-parser-base.ts:81

parseExtrusionDimensions

parseExtrusionDimensions(commands: GCodeCommand[]): ExtrusionDimensionMetadata[]
Parses extrusion dimension changes from gcode comments
Parameters
- commands: GCodeCommand[]
  Array of gcode commands with comments
Returns ExtrusionDimensionMetadata[]
Dimension change events extracted from comments, in line order

Remarks
Only dialects that announce per-path dimensions override this; the default reports none.
Inherited from SlicerMetadataParser.parseExtrusionDimensions
- Defined in src/parser/metadata-parser-base.ts:101

parseFilamentDiameter

parseFilamentDiameter(commentCommands: GCodeCommand[]): number
Reads the filament diameter announced in header comments, when any
Parameters
- commentCommands: GCodeCommand[]
  Array of gcode commands with comments
Returns number
The filament diameter in millimeters, or undefined when unknown

Remarks
Feeds the volumetric dimension derivation (see derivesExtrusionDimensions), which converts extruded filament lengths into deposited volume. Only header-borne values may be reported here: a diameter that appears after moves (like Cura's end-of-file ;SETTING_3 blob) would reach a one-shot parse before any move executes but a streamed parse only after every move already ran, making the two disagree.
Inherited from SlicerMetadataParser.parseFilamentDiameter
- Defined in src/parser/metadata-parser-base.ts:139

parseLayerMetadata

parseLayerMetadata(commands: GCodeCommand[]): LayerMetadata[]
Parses layer metadata from gcode comments
Parameters
- commands: GCodeCommand[]
  Array of gcode commands with comments
Returns LayerMetadata[]
Layer metadata extracted from comments
Overrides SlicerMetadataParser.parseLayerMetadata
- Defined in src/parser/slic3r-parser.ts:15