Slic3r::GUI::ProjectDirtyStateManager Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/ProjectDirtyStateManager.hpp>

Collaboration diagram for Slic3r::GUI::ProjectDirtyStateManager:

Classes
class	NotificationSuppressor

Public Member Functions
void	update_from_undo_redo_stack (bool dirty)
void	update_from_presets ()
void	reset_after_save ()
void	reset_initial_presets ()
void	set_plater_dirty (bool is_dirty)
bool	is_dirty () const
bool	is_presets_dirty () const

Private Member Functions
void	notify_dirty_change (bool was_dirty, const char *source)
void	begin_suppress_notifications ()
void	end_suppress_notifications ()

Private Attributes
bool	m_plater_dirty { false }
bool	m_presets_dirty { false }
bool	m_project_config_dirty { false }
int	m_suppress_depth { 0 }
bool	m_suppress_entry_dirty { false }
std::array< std::string, Preset::TYPE_COUNT >	m_initial_presets
DynamicPrintConfig	m_initial_project_config
std::vector< std::string >	m_initial_filament_presets_names
std::vector< std::string >	m_initial_filament_presets_colors

Detailed Description

Member Function Documentation

begin_suppress_notifications()

void Slic3r::GUI::ProjectDirtyStateManager::begin_suppress_notifications ( )

private

{
    if (m_suppress_depth == 0)
        m_suppress_entry_dirty = is_dirty();
    ++m_suppress_depth;
}

References is_dirty(), m_suppress_depth, and m_suppress_entry_dirty.

Here is the call graph for this function:

end_suppress_notifications()

void Slic3r::GUI::ProjectDirtyStateManager::end_suppress_notifications ( )

private

{
    assert(m_suppress_depth > 0);
    if (m_suppress_depth > 0)
        --m_suppress_depth;
    if (m_suppress_depth == 0)
        notify_dirty_change(m_suppress_entry_dirty, "batch");
}

References m_suppress_depth, m_suppress_entry_dirty, and notify_dirty_change().

Here is the call graph for this function:

is_dirty()

bool Slic3r::GUI::ProjectDirtyStateManager::is_dirty ( ) const

inline

{ return m_plater_dirty || m_project_config_dirty || m_presets_dirty; }

References m_plater_dirty, m_presets_dirty, and m_project_config_dirty.

Referenced by begin_suppress_notifications(), notify_dirty_change(), reset_after_save(), set_plater_dirty(), update_from_presets(), and update_from_undo_redo_stack().

Here is the caller graph for this function:

is_presets_dirty()

bool Slic3r::GUI::ProjectDirtyStateManager::is_presets_dirty ( ) const

inline

{ return m_presets_dirty; }

References m_presets_dirty.

notify_dirty_change()

void Slic3r::GUI::ProjectDirtyStateManager::notify_dirty_change ( bool was_dirty, const char * source )

private

{
    if (m_suppress_depth > 0)
        return;
 
    const bool dirty = is_dirty();
    if (was_dirty == dirty)
        return;
 
    LifecycleEventContext ctx;
    ctx.code = LifecycleEvtCode::Ok;
    ctx.dirty = dirty;
    ctx.source = source;
    fire_lifecycle_event(LifecycleEvent::ProjectDirtyChanged, ctx);
}

References Slic3r::LifecycleEventContext::code, Slic3r::LifecycleEventContext::dirty, Slic3r::fire_lifecycle_event(), is_dirty(), m_suppress_depth, Slic3r::Ok, Slic3r::ProjectDirtyChanged, and Slic3r::LifecycleEventContext::source.

Referenced by end_suppress_notifications(), reset_after_save(), set_plater_dirty(), update_from_presets(), and update_from_undo_redo_stack().

Here is the call graph for this function:

Here is the caller graph for this function:

reset_after_save()

void Slic3r::GUI::ProjectDirtyStateManager::reset_after_save

(

)

{
    const bool was_dirty = is_dirty();
    this->reset_initial_presets();
    m_plater_dirty  = false;
    m_presets_dirty = false;
    m_project_config_dirty = false;
    notify_dirty_change(was_dirty, "save");
    wxGetApp().mainframe->update_title();
}

References is_dirty(), m_plater_dirty, m_presets_dirty, m_project_config_dirty, notify_dirty_change(), and reset_initial_presets().

Here is the call graph for this function:

reset_initial_presets()

void Slic3r::GUI::ProjectDirtyStateManager::reset_initial_presets

(

)

{
    m_initial_presets.fill(std::string{});
    GUI_App &app = wxGetApp();
    for (const auto &[type, name] : app.get_selected_presets()) { 
        if (type == Preset::Type::TYPE_FILAMENT) {
            m_initial_filament_presets_names = wxGetApp().preset_bundle->filament_presets;
            if (ConfigOption *color_option = wxGetApp().preset_bundle->project_config.option("filament_colour")) {
                auto colors = static_cast<ConfigOptionStrings *>(color_option->clone());
                m_initial_filament_presets_colors = colors->values;
                delete colors;
            }
        } else {
            m_initial_presets[type] = name;
        }
    }
    m_initial_project_config = app.preset_bundle->project_config;
}

References Slic3r::GUI::GUI_App::get_selected_presets(), m_initial_filament_presets_colors, m_initial_filament_presets_names, m_initial_presets, m_initial_project_config, Slic3r::GUI::GUI_App::preset_bundle, Slic3r::PresetBundle::project_config, and Slic3r::Preset::TYPE_FILAMENT.

Referenced by reset_after_save().

Here is the call graph for this function:

Here is the caller graph for this function:

set_plater_dirty()

void Slic3r::GUI::ProjectDirtyStateManager::set_plater_dirty

(

bool

is_dirty

)

{
    const bool was_dirty = this->is_dirty();
    m_plater_dirty = is_dirty;
    notify_dirty_change(was_dirty, "plater");
}

References is_dirty(), m_plater_dirty, and notify_dirty_change().

Here is the call graph for this function:

update_from_presets()

void Slic3r::GUI::ProjectDirtyStateManager::update_from_presets

(

)

{
    const bool was_dirty = is_dirty();
    m_presets_dirty = false;
    // check switching of the presets only for exist/loaded project, but not for new
    GUI_App &app = wxGetApp();
    if (!app.plater()->get_project_filename().IsEmpty()) {
        for (const auto &[type, name] : app.get_selected_presets()) { 
            if (type == Preset::Type::TYPE_FILAMENT) { 
                m_presets_dirty |= m_initial_filament_presets_names != wxGetApp().preset_bundle->filament_presets;
                if (ConfigOption *color_option = wxGetApp().preset_bundle->project_config.option("filament_colour")) {
                    auto colors = static_cast<ConfigOptionStrings *>(color_option->clone());
                    m_presets_dirty |= m_initial_filament_presets_colors != colors->values;
                    delete colors;
                }
            } else {
                m_presets_dirty |= !m_initial_presets[type].empty() && m_initial_presets[type] != name;
            }
        }
    } else {
        BOOST_LOG_TRIVIAL(info) << __FUNCTION__ << "project file name is empty";
    }
    m_presets_dirty |= app.has_unsaved_preset_changes();
    m_project_config_dirty = m_initial_project_config != app.preset_bundle->project_config;
    notify_dirty_change(was_dirty, "presets");
    app.mainframe->update_title();
}

References Slic3r::GUI::Plater::get_project_filename(), Slic3r::GUI::GUI_App::get_selected_presets(), Slic3r::GUI::GUI_App::has_unsaved_preset_changes(), is_dirty(), m_initial_filament_presets_colors, m_initial_filament_presets_names, m_initial_presets, m_initial_project_config, m_presets_dirty, m_project_config_dirty, Slic3r::GUI::GUI_App::mainframe, notify_dirty_change(), Slic3r::GUI::GUI_App::plater(), Slic3r::GUI::GUI_App::preset_bundle, Slic3r::PresetBundle::project_config, Slic3r::Preset::TYPE_FILAMENT, and Slic3r::GUI::MainFrame::update_title().

Here is the call graph for this function:

update_from_undo_redo_stack()

void Slic3r::GUI::ProjectDirtyStateManager::update_from_undo_redo_stack

(

bool

dirty

)

{
    const bool was_dirty = is_dirty();
    m_plater_dirty = dirty;
    notify_dirty_change(was_dirty, "undo_redo");
    if (const Plater *plater = wxGetApp().plater(); plater && wxGetApp().initialized())
        wxGetApp().mainframe->update_title();
}

References is_dirty(), m_plater_dirty, notify_dirty_change(), and Slic3r::GUI::plater().

Here is the call graph for this function:

Member Data Documentation

m_initial_filament_presets_colors

std::vector<std::string> Slic3r::GUI::ProjectDirtyStateManager::m_initial_filament_presets_colors

private

Referenced by reset_initial_presets(), and update_from_presets().

m_initial_filament_presets_names

std::vector<std::string> Slic3r::GUI::ProjectDirtyStateManager::m_initial_filament_presets_names

private

Referenced by reset_initial_presets(), and update_from_presets().

m_initial_presets

std::array<std::string, Preset::TYPE_COUNT> Slic3r::GUI::ProjectDirtyStateManager::m_initial_presets

private

Referenced by reset_initial_presets(), and update_from_presets().

m_initial_project_config

DynamicPrintConfig Slic3r::GUI::ProjectDirtyStateManager::m_initial_project_config

private

Referenced by reset_initial_presets(), and update_from_presets().

m_plater_dirty

bool Slic3r::GUI::ProjectDirtyStateManager::m_plater_dirty { false }

private

{ false };

Referenced by is_dirty(), reset_after_save(), set_plater_dirty(), and update_from_undo_redo_stack().

m_presets_dirty

bool Slic3r::GUI::ProjectDirtyStateManager::m_presets_dirty { false }

private

{ false };

Referenced by is_dirty(), is_presets_dirty(), reset_after_save(), and update_from_presets().

m_project_config_dirty

bool Slic3r::GUI::ProjectDirtyStateManager::m_project_config_dirty { false }

private

{ false };

Referenced by is_dirty(), reset_after_save(), and update_from_presets().

m_suppress_depth

int Slic3r::GUI::ProjectDirtyStateManager::m_suppress_depth { 0 }

private

{ 0 };

Referenced by begin_suppress_notifications(), end_suppress_notifications(), and notify_dirty_change().

m_suppress_entry_dirty

bool Slic3r::GUI::ProjectDirtyStateManager::m_suppress_entry_dirty { false }

private

{ false };

Referenced by begin_suppress_notifications(), and end_suppress_notifications().

---

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

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/ProjectDirtyStateManager.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/ProjectDirtyStateManager.cpp