Slic3r::Extruder Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/libslic3r/Extruder.hpp>

Collaboration diagram for Slic3r::Extruder:

Public Member Functions
	Extruder (unsigned int id, GCodeConfig *config, bool share_extruder)
virtual	~Extruder ()
void	reset ()
unsigned int	id () const
int	config_index () const
void	set_config_index (int idx)
unsigned int	extruder_id () const
double	extrude (double dE)
double	retract (double length, double restart_extra)
double	unretract ()
double	E () const
double	E_to_emit (bool high_precision, double extra=0.)
void	reset_E ()
double	e_per_mm (double mm3_per_mm) const
double	e_per_mm3 () const
double	extruded_volume () const
double	used_filament () const
double	position () const
double	retracted () const
double	restart_extra () const
bool	is_share_extruder () const
double	get_single_retracted_length () const
double	get_share_retracted_length () const
void	set_position (double e)
void	set_retracted (double retracted, double restart_extra)
double	filament_diameter () const
double	filament_crossection () const
double	filament_density () const
double	filament_cost () const
double	filament_flow_ratio () const
double	retract_before_wipe () const
double	retract_after_wipe () const
double	retraction_length () const
double	retract_lift () const
int	retract_speed () const
int	deretract_speed () const
double	retract_restart_extra () const
double	retract_length_toolchange () const
double	retract_restart_extra_toolchange () const
double	travel_slope () const
bool	use_firmware_retraction () const

Private Member Functions
	Extruder (unsigned int id)

Private Attributes
GCodeConfig *	m_config
unsigned int	m_id
int	m_config_index {0}
double	m_E
double	m_absolute_E
double	m_retracted
double	m_restart_extra
double	m_E_rounding_carry { 0. }
double	m_e_per_mm3
bool	m_share_extruder

Static Private Attributes
static std::vector< double >	m_share_E = std::vector<double>(MAXIMUM_EXTRUDER_NUMBER, 0)
static std::vector< double >	m_share_retracted = std::vector<double>(MAXIMUM_EXTRUDER_NUMBER, 0)

Detailed Description

Constructor & Destructor Documentation

Extruder() [1/2]

Slic3r::Extruder::Extruder	(	unsigned int	id,
		GCodeConfig *	config,
		bool	share_extruder )

                                                                            :
    m_id(id),
    m_config(config),
    m_share_extruder(share_extruder)
{
    reset();
 
    m_config_index = int(m_id);
    // cache values that are going to be called often
    m_e_per_mm3 = this->filament_flow_ratio();
    m_e_per_mm3 /= this->filament_crossection();
}

References filament_crossection(), filament_flow_ratio(), Slic3r::GCodeConfig, id(), m_config, m_config_index, m_e_per_mm3, m_id, m_share_extruder, and reset().

Here is the call graph for this function:

~Extruder()

virtual Slic3r::Extruder::~Extruder ( )

inlinevirtual

{}

Extruder() [2/2]

Slic3r::Extruder::Extruder ( unsigned int id )

inlineprivate

: m_id(id) {}

References id(), and m_id.

Here is the call graph for this function:

Member Function Documentation

config_index()

int Slic3r::Extruder::config_index ( ) const

inline

{ return m_config_index; }

References m_config_index.

deretract_speed()

int Slic3r::Extruder::deretract_speed

(

)

const

{
    int speed = int(floor(m_config->deretraction_speed.get_at(m_config_index)+0.5));
    return (speed > 0) ? speed : this->retract_speed();
}

References m_config, m_config_index, and retract_speed().

Here is the call graph for this function:

E()

double Slic3r::Extruder::E ( ) const

inline

{ return m_share_extruder ? m_share_E[extruder_id()] : m_E; }

References extruder_id(), m_E, m_share_E, and m_share_extruder.

Referenced by E_to_emit().

Here is the call graph for this function:

Here is the caller graph for this function:

e_per_mm()

double Slic3r::Extruder::e_per_mm ( double mm3_per_mm ) const

inline

{ return mm3_per_mm * m_e_per_mm3; }

References m_e_per_mm3.

Referenced by Slic3r::Print::_make_skirt().

Here is the caller graph for this function:

e_per_mm3()

double Slic3r::Extruder::e_per_mm3 ( ) const

inline

{ return m_e_per_mm3; }

References m_e_per_mm3.

E_to_emit()

double Slic3r::Extruder::E_to_emit	(	bool	high_precision,
		double	extra = 0. )

{
    const double e = this->E() + extra;
    if (! m_config->use_relative_e_distances.value || ! high_precision)
        return e;
    // Rounding each relative move on its own biases the flow when short moves of about the same length all round
    // the same way. Carrying the rounding error into the next move keeps the written E within half of the last
    // decimal of the extruded length, as with absolute E distances. Moves written with the standard precision
    // (supports) are rounded on their own, as without high precision G-code, and keep the carry for the next move
    // written with high precision.
    const double carried = e + m_E_rounding_carry;
    const double emitted = GCodeFormatter::quantize_e(carried, true);
    m_E_rounding_carry   = carried - emitted;
    return emitted;
}

References E(), m_config, m_E_rounding_carry, and Slic3r::GCodeFormatter::quantize_e().

Here is the call graph for this function:

extrude()

double Slic3r::Extruder::extrude

(

double

dE

)

{
    // BBS
    if (m_share_extruder) {
        if (m_config->use_relative_e_distances)
            m_share_E[extruder_id()] = 0.;
        m_share_E[extruder_id()] += dE;
        m_absolute_E += dE;
        if (dE < 0.)
            m_share_retracted[extruder_id()] -= dE;
    } else {
        // in case of relative E distances we always reset to 0 before any output
        if (m_config->use_relative_e_distances)
            m_E = 0.;
        m_E          += dE;
        m_absolute_E += dE;
        if (dE < 0.)
            m_retracted -= dE;
    }
    return dE;
}

References extruder_id(), m_absolute_E, m_config, m_E, m_retracted, m_share_E, m_share_extruder, and m_share_retracted.

Referenced by Slic3r::GCodeWriter::extrude_arc_to_xy(), Slic3r::GCodeWriter::extrude_to_xy(), Slic3r::GCodeWriter::extrude_to_xyz(), and unretract().

Here is the call graph for this function:

Here is the caller graph for this function:

extruded_volume()

double Slic3r::Extruder::extruded_volume

(

)

const

{
    // BBS
    if (m_share_extruder) {
        // FIXME: need to count m_retracted for share extruder machine
        return this->used_filament() * this->filament_crossection();
    } else {
        return this->used_filament() * this->filament_crossection();
    }
}

References filament_crossection(), m_share_extruder, and used_filament().

Here is the call graph for this function:

extruder_id()

unsigned int Slic3r::Extruder::extruder_id

(

)

const

{
    assert(m_config);
    if (m_id < m_config->filament_map.size()) {
        return m_config->filament_map.get_at(m_id) - 1;
    }
    return 0;
}

References Slic3r::filament_map(), m_config, and m_id.

Referenced by Slic3r::WipeTowerIntegration::append_tcr(), E(), Slic3r::GCodeWriter::eager_lift(), extrude(), get_share_retracted_length(), Slic3r::GCodeWriter::lazy_lift(), reset_E(), retract(), travel_slope(), and unretract().

Here is the call graph for this function:

Here is the caller graph for this function:

filament_cost()

double Slic3r::Extruder::filament_cost

(

)

const

{
    return m_config->filament_cost.get_at(m_id);
}

References m_config, and m_id.

filament_crossection()

double Slic3r::Extruder::filament_crossection ( ) const

inline

{ return this->filament_diameter() * this->filament_diameter() * 0.25 * PI; }

References filament_diameter(), and PI.

Referenced by Extruder(), extruded_volume(), and set_config_index().

Here is the call graph for this function:

Here is the caller graph for this function:

filament_density()

double Slic3r::Extruder::filament_density

(

)

const

{
    return m_config->filament_density.get_at(m_id);
}

References m_config, and m_id.

filament_diameter()

double Slic3r::Extruder::filament_diameter

(

)

const

{
    return m_config->filament_diameter.get_at(m_id);
}

References m_config, and m_id.

Referenced by filament_crossection().

Here is the caller graph for this function:

filament_flow_ratio()

double Slic3r::Extruder::filament_flow_ratio

(

)

const

{
    return m_config->filament_flow_ratio.get_at(m_config_index);
}

References m_config, and m_config_index.

Referenced by Extruder(), and set_config_index().

Here is the caller graph for this function:

get_share_retracted_length()

double Slic3r::Extruder::get_share_retracted_length ( ) const

inline

{ return m_share_retracted[extruder_id()]; }

References extruder_id(), and m_share_retracted.

Here is the call graph for this function:

get_single_retracted_length()

double Slic3r::Extruder::get_single_retracted_length ( ) const

inline

{ return m_retracted; }

References m_retracted.

id()

unsigned int Slic3r::Extruder::id ( ) const

inline

{ return m_id; }

References m_id.

Referenced by Extruder(), Extruder(), Slic3r::OozePrevention::_get_temp(), Slic3r::WipeTowerIntegration::append_tcr(), Slic3r::WipeTowerIntegration::append_tcr2(), Slic3r::Wipe::calculateWipeRetractionLengths(), Slic3r::GCodeWriter::eager_lift(), Slic3r::GCodeWriter::lazy_lift(), Slic3r::GCodeWriter::need_toolchange(), Slic3r::need_wipe(), Slic3r::operator!=(), Slic3r::operator<(), Slic3r::operator==(), Slic3r::operator>(), Slic3r::OozePrevention::post_toolchange(), Slic3r::OozePrevention::pre_toolchange(), and Slic3r::Wipe::wipe().

Here is the caller graph for this function:

is_share_extruder()

bool Slic3r::Extruder::is_share_extruder ( ) const

inline

{ return m_share_extruder; }

References m_share_extruder.

position()

double Slic3r::Extruder::position ( ) const

inline

{ return m_E; }

References m_E.

reset()

void Slic3r::Extruder::reset ( )

inline

                   {
        // BBS
        if (m_share_extruder) {
            m_share_E = std::vector<double>(MAXIMUM_EXTRUDER_NUMBER, 0);
            m_share_retracted = std::vector<double>(MAXIMUM_EXTRUDER_NUMBER, 0);
        } else {
            m_E             = 0;
            m_retracted     = 0;
        }
        m_restart_extra = 0;
        m_absolute_E    = 0;
        m_E_rounding_carry = 0;
    }

References m_absolute_E, m_E, m_E_rounding_carry, m_restart_extra, m_retracted, m_share_E, m_share_extruder, m_share_retracted, and MAXIMUM_EXTRUDER_NUMBER.

Referenced by Extruder().

Here is the caller graph for this function:

reset_E()

void Slic3r::Extruder::reset_E ( )

inline

{ m_E = 0.; m_share_E[extruder_id()] = 0.; }

References extruder_id(), m_E, and m_share_E.

Here is the call graph for this function:

restart_extra()

double Slic3r::Extruder::restart_extra ( ) const

inline

{ return m_restart_extra; }

References m_restart_extra.

Referenced by retract(), and set_retracted().

Here is the caller graph for this function:

retract()

double Slic3r::Extruder::retract	(	double	length,
		double	restart_extra )

{
    // BBS
    if (m_share_extruder) {
        if (m_config->use_relative_e_distances)
            m_share_E[extruder_id()] = 0.;
        double to_retract = std::max(0., length - m_share_retracted[extruder_id()]);
        m_restart_extra = restart_extra;
        if (to_retract > 0.) {
            m_share_E[extruder_id()]             -= to_retract;
            m_absolute_E          -= to_retract;
            m_share_retracted[extruder_id()]     += to_retract;
        }
        return to_retract;
    } else {
        // in case of relative E distances we always reset to 0 before any output
        if (m_config->use_relative_e_distances)
            m_E = 0.;
        double to_retract = std::max(0., length - m_retracted);
        m_restart_extra = restart_extra;
        if (to_retract > 0.) {
            m_E             -= to_retract;
            m_absolute_E    -= to_retract;
            m_retracted     += to_retract;
        }
        return to_retract;
    }
}

References extruder_id(), Slic3r::length(), m_absolute_E, m_config, m_E, m_restart_extra, m_retracted, m_share_E, m_share_extruder, m_share_retracted, and restart_extra().

Here is the call graph for this function:

retract_after_wipe()

double Slic3r::Extruder::retract_after_wipe

(

)

const

{
    return std::min(std::clamp(m_config->retract_after_wipe.get_at(m_config_index) * 0.01, 0., 1.), 1. - retract_before_wipe());
}

References m_config, m_config_index, and retract_before_wipe().

Here is the call graph for this function:

retract_before_wipe()

double Slic3r::Extruder::retract_before_wipe

(

)

const

{
    return std::clamp(m_config->retract_before_wipe.get_at(m_config_index) * 0.01, 0., 1.);
}

References m_config, and m_config_index.

Referenced by Slic3r::GCodeWriter::retract(), retract_after_wipe(), and Slic3r::GCodeWriter::retract_for_toolchange().

Here is the caller graph for this function:

retract_length_toolchange()

double Slic3r::Extruder::retract_length_toolchange

(

)

const

{
    return m_config->retract_length_toolchange.get_at(m_config_index);
}

References m_config, and m_config_index.

retract_lift()

double Slic3r::Extruder::retract_lift

(

)

const

{
    return m_config->z_hop.get_at(m_config_index);
}

References m_config, and m_config_index.

retract_restart_extra()

double Slic3r::Extruder::retract_restart_extra

(

)

const

{
    return m_config->retract_restart_extra.get_at(m_config_index);
}

References m_config, and m_config_index.

retract_restart_extra_toolchange()

double Slic3r::Extruder::retract_restart_extra_toolchange

(

)

const

{
    return m_config->retract_restart_extra_toolchange.get_at(m_config_index);
}

References m_config, and m_config_index.

retract_speed()

int Slic3r::Extruder::retract_speed

(

)

const

{
    return int(floor(m_config->retraction_speed.get_at(m_config_index)+0.5));
}

References m_config, and m_config_index.

Referenced by deretract_speed().

Here is the caller graph for this function:

retracted()

double Slic3r::Extruder::retracted ( ) const

inline

{ return m_retracted; }

References m_retracted.

Referenced by set_retracted().

Here is the caller graph for this function:

retraction_length()

double Slic3r::Extruder::retraction_length

(

)

const

{
    return m_config->retraction_length.get_at(m_config_index);
}

References m_config, and m_config_index.

set_config_index()

void Slic3r::Extruder::set_config_index

(

int

idx

)

{
    m_config_index = idx < 0 ? int(m_id) : idx;
    // keep the cached flow term reading the same column as the getters
    m_e_per_mm3 = this->filament_flow_ratio();
    m_e_per_mm3 /= this->filament_crossection();
}

References filament_crossection(), filament_flow_ratio(), m_config_index, m_e_per_mm3, and m_id.

Here is the call graph for this function:

set_position()

void Slic3r::Extruder::set_position ( double e )

inline

{ m_E = e; }

References m_E.

set_retracted()

void Slic3r::Extruder::set_retracted	(	double	retracted,
		double	restart_extra )

{
    if (retracted < - EPSILON)
        throw Slic3r::RuntimeError(_u8L("Custom G-code reports negative z_retracted."));
    if (restart_extra < - EPSILON)
        throw Slic3r::RuntimeError(_u8L("Custom G-code reports negative z_restart_extra."));
 
    if (retracted > EPSILON) {
        m_retracted     = retracted;
        m_restart_extra = restart_extra < EPSILON ? 0 : restart_extra;
    } else {
        m_retracted     = 0;
        m_restart_extra = 0;
    }
}

References _u8L, EPSILON, m_restart_extra, m_retracted, restart_extra(), and retracted().

Here is the call graph for this function:

travel_slope()

double Slic3r::Extruder::travel_slope

(

)

const

{
    // Orca: deliberately keyed by the physical extruder, not the filament column — this read
    // predates the per-variant merge and switching it would change existing multi-extruder output.
    return m_config->travel_slope.get_at(extruder_id()) * PI / 180;
}

References extruder_id(), m_config, and PI.

Here is the call graph for this function:

unretract()

double Slic3r::Extruder::unretract

(

)

{
    // BBS
    if (m_share_extruder) {
        double dE = m_share_retracted[extruder_id()] + m_restart_extra;
        this->extrude(dE);
        m_share_retracted[extruder_id()]     = 0.;
        m_restart_extra = 0.;
        return dE;
    } else {
        double dE = m_retracted + m_restart_extra;
        this->extrude(dE);
        m_retracted     = 0.;
        m_restart_extra = 0.;
        return dE;
    }
}

References extrude(), extruder_id(), m_restart_extra, m_retracted, m_share_extruder, and m_share_retracted.

Here is the call graph for this function:

use_firmware_retraction()

bool Slic3r::Extruder::use_firmware_retraction

(

)

const

{
    return m_config->use_firmware_retraction;
}

References m_config.

used_filament()

double Slic3r::Extruder::used_filament

(

)

const

{
    // BBS
    if (m_share_extruder) {
        // FIXME: need to count retracted length for share-extruder machine
        return m_absolute_E;
    } else {
        return m_absolute_E + m_retracted;
    }
}

References m_absolute_E, m_retracted, and m_share_extruder.

Referenced by extruded_volume().

Here is the caller graph for this function:

Member Data Documentation

m_absolute_E

double Slic3r::Extruder::m_absolute_E

private

Referenced by extrude(), reset(), retract(), and used_filament().

m_config

GCodeConfig* Slic3r::Extruder::m_config

private

Referenced by Extruder(), deretract_speed(), E_to_emit(), extrude(), extruder_id(), filament_cost(), filament_density(), filament_diameter(), filament_flow_ratio(), retract(), retract_after_wipe(), retract_before_wipe(), retract_length_toolchange(), retract_lift(), retract_restart_extra(), retract_restart_extra_toolchange(), retract_speed(), retraction_length(), travel_slope(), and use_firmware_retraction().

m_config_index

int Slic3r::Extruder::m_config_index {0}

private

{0};

Referenced by Extruder(), config_index(), deretract_speed(), filament_flow_ratio(), retract_after_wipe(), retract_before_wipe(), retract_length_toolchange(), retract_lift(), retract_restart_extra(), retract_restart_extra_toolchange(), retract_speed(), retraction_length(), and set_config_index().

m_E

double Slic3r::Extruder::m_E

private

Referenced by E(), extrude(), position(), reset(), reset_E(), retract(), and set_position().

m_e_per_mm3

double Slic3r::Extruder::m_e_per_mm3

private

Referenced by Extruder(), e_per_mm(), e_per_mm3(), and set_config_index().

m_E_rounding_carry

double Slic3r::Extruder::m_E_rounding_carry { 0. }

private

{ 0. };

Referenced by E_to_emit(), and reset().

m_id

unsigned int Slic3r::Extruder::m_id

private

Referenced by Extruder(), Extruder(), extruder_id(), filament_cost(), filament_density(), filament_diameter(), id(), and set_config_index().

m_restart_extra

double Slic3r::Extruder::m_restart_extra

private

Referenced by reset(), restart_extra(), retract(), set_retracted(), and unretract().

m_retracted

double Slic3r::Extruder::m_retracted

private

Referenced by extrude(), get_single_retracted_length(), reset(), retract(), retracted(), set_retracted(), unretract(), and used_filament().

m_share_E

std::vector< double > Slic3r::Extruder::m_share_E = std::vector<double>(MAXIMUM_EXTRUDER_NUMBER, 0)

staticprivate

Referenced by E(), extrude(), reset(), reset_E(), and retract().

m_share_extruder

bool Slic3r::Extruder::m_share_extruder

private

Referenced by Extruder(), E(), extrude(), extruded_volume(), is_share_extruder(), reset(), retract(), unretract(), and used_filament().

m_share_retracted

std::vector< double > Slic3r::Extruder::m_share_retracted = std::vector<double>(MAXIMUM_EXTRUDER_NUMBER, 0)

staticprivate

Referenced by extrude(), get_share_retracted_length(), reset(), retract(), and unretract().

---

The documentation for this class was generated from the following files:

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/libslic3r/Extruder.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/libslic3r/Extruder.cpp