Class Extruder

Configures the extruder tool behavior and state.

Tracks filament volume, extrusion units (mm vs mm3), and toggles extrusion on/off. Insert an instance with { on: true } to begin extruding along future Points.

Hierarchy

BaseModelPlus
- Extruder

Constructors

constructor

new Extruder(init?: Partial<Extruder>): Extruder
Parameters
- Optionalinit: Partial<Extruder>
Returns Extruder
Overrides BaseModelPlus.constructor
- Defined in models/extrusion.ts:126

Properties

`Optional`dia_feed

dia_feed?: number

Feed filament diameter (required if units is mm).

`Optional`on

on?: boolean

Extrusion state: true to extrude along path, false to restrict toolhead.

`Optional`relative_gcode

relative_gcode?: boolean

If true, G-code will use relative extrusion amounts (M83) and reset between moves.

`Optional`retraction_length

retraction_length?: number

`Optional`retraction_speed

retraction_speed?: number

`Optional`total_volume

total_volume?: number

`Optional`total_volume_ref

total_volume_ref?: number

`Optional`travel_format

travel_format?: "G1_E0" | "none"

`Optional`units

units?: "mm" | "mm3"

Volume tracking units: mm (filament length) or mm3 (volumetric).

`Optional`volume_to_e

volume_to_e?: number

`Static` `Readonly`typeName

typeName: "Extruder" = 'Extruder'

Methods

copy

copy<T extends Extruder>(): T
Type Parameters
- T extends Extruder
Returns T
Inherited from BaseModelPlus.copy
- Defined in core/base-model.ts:31

e_gcode

e_gcode(point1: Point, state: any): string
Parameters
- point1: Point
- state: any
Returns string
- Defined in models/extrusion.ts:143

gcode

gcode(
    state: any,
):
    | "M83 ; relative extrusion"
    | "M82 ; absolute extrusion\nG92 E0 ; reset extrusion position to zero"
    | undefined
Parameters
- state: any
Returns
    | "M83 ; relative extrusion"
    | "M82 ; absolute extrusion\nG92 E0 ; reset extrusion position to zero"
    | undefined
- Defined in models/extrusion.ts:166

get_and_update_volume

get_and_update_volume(volume: number): number
Parameters
- volume: number
Returns number
- Defined in models/extrusion.ts:131

toJSON

toJSON(): {
    dia_feed: number
    | undefined;
    on: boolean | undefined;
    relative_gcode: boolean | undefined;
    units: "mm" | "mm3" | undefined;
}
Returns {
    dia_feed: number | undefined;
    on: boolean | undefined;
    relative_gcode: boolean | undefined;
    units: "mm" | "mm3" | undefined;
}
- Defined in models/extrusion.ts:141

update_e_ratio

update_e_ratio(): void
Returns void
- Defined in models/extrusion.ts:127

update_from

update_from(source: any): void
Parameters
- source: any
Returns void
Inherited from BaseModelPlus.update_from
- Defined in core/base-model.ts:29

updateFrom

updateFrom(source: any): void
Parameters
- source: any
Returns void
Inherited from BaseModelPlus.updateFrom
- Defined in core/base-model.ts:19

visualize

visualize(state: any, plotData: any, plotControls: any): void
Visualization method for Extruder Matches Python: fullcontrol.visualize.extrusion_classes.Extruder.visualize()
Parameters
- state: any
- plotData: any
- plotControls: any
Returns void
- Defined in models/extrusion.ts:182

`Static`fromJSON

fromJSON(d: any): Extruder
Parameters
- d: any
Returns Extruder
- Defined in models/extrusion.ts:142

Class Extruder

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Extruder

Properties

Optionaldia_feed

Optionalon

Optionalrelative_gcode

Optionalretraction_length

Optionalretraction_speed

Optionaltotal_volume

Optionaltotal_volume_ref

Optionaltravel_format

Optionalunits

Optionalvolume_to_e

Static ReadonlytypeName

Methods

copy

Type Parameters

Returns T

e_gcode

Parameters

Returns string

gcode

Parameters

Returns | "M83 ; relative extrusion" | "M82 ; absolute extrusion\nG92 E0 ; reset extrusion position to zero" | undefined

get_and_update_volume

Parameters

Returns number

toJSON

Returns { dia_feed: number | undefined; on: boolean | undefined; relative_gcode: boolean | undefined; units: "mm" | "mm3" | undefined;}

update_e_ratio

Returns void

update_from

Parameters

Returns void

updateFrom

Parameters

Returns void

visualize

Parameters

Returns void

StaticfromJSON

Parameters

Returns Extruder

Settings

On This Page

`Optional`dia_feed

`Optional`on

`Optional`relative_gcode

`Optional`retraction_length

`Optional`retraction_speed

`Optional`total_volume

`Optional`total_volume_ref

`Optional`travel_format

`Optional`units

`Optional`volume_to_e

`Static` `Readonly`typeName

Returns
| "M83 ; relative extrusion"
| "M82 ; absolute extrusion\nG92 E0 ; reset extrusion position to zero"
| undefined

Returns {
dia_feed: number | undefined;
on: boolean | undefined;
relative_gcode: boolean | undefined;
units: "mm" | "mm3" | undefined;
}

`Static`fromJSON