Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetTransaction Struct Reference

Collaboration diagram for Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetTransaction:

Public Member Functions
void	set (const std::string &key, const std::string &value)
PresetUpdateResult	commit ()

Public Attributes
Preset::Type	type = Preset::TYPE_INVALID
std::string	target_name
bool	filament = false
int	slot_number = 0
std::string	slot_assignment_snapshot
bool	selection_changed = false
bool	slot_assignment_changed = false
std::vector< std::pair< std::string, std::string > >	staged
std::set< std::string >	staged_keys
bool	committed = false

Detailed Description

Member Function Documentation

commit()

PresetUpdateResult Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetTransaction::commit

(

)

{
    if (committed)
        throw std::runtime_error("This preset transaction has already been committed; start a new begin_update()");
    if (type == Preset::TYPE_INVALID)
        throw std::runtime_error("This preset transaction has no target");
 
    PresetUpdateResult result;
    PluginHostUi::run_on_ui_thread([&] {
        GUI::GUI_App&     app        = require_gui_app();
        GUI::Tab*         tab        = require_tab(app, type);
        PresetBundle&     bundle     = *app.preset_bundle;
        PresetCollection& collection = collection_for(bundle, type);
 
        // The target must still be the edited preset: the user may have switched away while the
        // transaction was staged, and editing a different preset would break "explicit target".
        const std::string edited = collection.get_edited_preset().name;
        if (edited != target_name)
            throw std::runtime_error("The edited " + std::string(preset_tab_name(type)) + " preset is \"" + edited
                                     + "\", not this transaction's target \"" + target_name
                                     + "\"; nothing was applied");
 
        if (filament) {
            // Reject a stale slot mapping instead of editing whatever the slot now points at.
            const std::string now_assigned = resolved_slot_preset(bundle, slot_number);
            if (now_assigned != slot_assignment_snapshot)
                throw std::runtime_error("Filament slot " + std::to_string(slot_number) + " now holds \"" + now_assigned
                                         + "\", not \"" + slot_assignment_snapshot
                                         + "\" as when this transaction was created; the slot mapping changed, so nothing was applied");
        }
 
        // Apply the whole batch through the tab's batch path: it validates every key and value before
        // touching the preset, rejects duplicate keys, runs the same per-setting commit path a hand
        // edit uses (validation, on_change, dirty state) and refreshes once for the batch. A failure
        // restores the edited preset, so no staged setting survives a failed commit.
        tab->apply_preset_config_values(staged);
 
        result.type                    = type;
        result.target_name             = target_name;
        result.selection_changed       = selection_changed;
        result.slot_number             = filament ? slot_number : -1;
        result.slot_assignment_changed = slot_assignment_changed;
        result.keys.reserve(staged.size());
        for (const auto& entry : staged)
            result.keys.push_back(entry.first);
        result.dirty = collection.get_edited_preset().is_dirty;
 
        if (filament) {
            // Every slot whose assigned preset resolves to the edited one is affected: the preset
            // is shared, not a per-slot override.
            for (std::size_t index = 0; index < bundle.filament_presets.size(); ++index) {
                Preset* preset = bundle.filaments.find_preset(bundle.filament_presets[index]);
                if (preset != nullptr && preset->name == target_name)
                    result.shared_slots.push_back(static_cast<int>(index) + 1);
            }
        }
    });
 
    committed = true;
    return result;
}

References Slic3r::GUI::Tab::apply_preset_config_values(), Slic3r::anonymous_namespace{PluginHostPresets.cpp}::collection_for(), commit(), committed, Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetUpdateResult::dirty, filament, Slic3r::PresetBundle::filament_presets, Slic3r::PresetBundle::filaments, Slic3r::PresetCollection::find_preset(), Slic3r::PresetCollection::get_edited_preset(), Slic3r::Preset::is_dirty, Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetUpdateResult::keys, Slic3r::Preset::name, Slic3r::GUI::GUI_App::preset_bundle, Slic3r::anonymous_namespace{PluginHostPresets.cpp}::preset_tab_name(), Slic3r::anonymous_namespace{PluginHostPresets.cpp}::require_gui_app(), Slic3r::anonymous_namespace{PluginHostPresets.cpp}::require_tab(), Slic3r::anonymous_namespace{PluginHostPresets.cpp}::resolved_slot_preset(), Slic3r::PluginHostUi::run_on_ui_thread(), selection_changed, Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetUpdateResult::selection_changed, Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetUpdateResult::shared_slots, slot_assignment_changed, Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetUpdateResult::slot_assignment_changed, slot_assignment_snapshot, slot_number, Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetUpdateResult::slot_number, staged, target_name, Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetUpdateResult::target_name, type, Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetUpdateResult::type, and Slic3r::Preset::TYPE_INVALID.

Referenced by commit(), Slic3r::anonymous_namespace{PluginHostPresets.cpp}::update_edited_preset(), and Slic3r::anonymous_namespace{PluginHostPresets.cpp}::update_filament_slot().

Here is the call graph for this function:

Here is the caller graph for this function:

set()

void Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetTransaction::set	(	const std::string &	key,
		const std::string &	value )

{
    if (committed)
        throw std::runtime_error("This preset transaction has already been committed; start a new begin_update()");
    if (key.empty())
        throw std::invalid_argument("A setting key is required");
    // Conflicting duplicate writes to one setting are rejected rather than resolved by order.
    if (!staged_keys.insert(key).second)
        throw std::invalid_argument("Setting \"" + key + "\" is already staged in this transaction; "
                                    "conflicting duplicate writes to one setting are rejected");
    staged.emplace_back(key, value);
}

References committed, set(), staged, and staged_keys.

Referenced by set(), Slic3r::anonymous_namespace{PluginHostPresets.cpp}::update_edited_preset(), and Slic3r::anonymous_namespace{PluginHostPresets.cpp}::update_filament_slot().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

committed

bool Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetTransaction::committed = false

Referenced by commit(), and set().

filament

bool Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetTransaction::filament = false

Referenced by Slic3r::anonymous_namespace{PluginHostPresets.cpp}::bind_filament_target(), and commit().

selection_changed

bool Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetTransaction::selection_changed = false

Referenced by Slic3r::anonymous_namespace{PluginHostPresets.cpp}::bind_filament_target(), Slic3r::anonymous_namespace{PluginHostPresets.cpp}::bind_preset_target(), and commit().

slot_assignment_changed

bool Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetTransaction::slot_assignment_changed = false

Referenced by Slic3r::anonymous_namespace{PluginHostPresets.cpp}::bind_filament_target(), and commit().

slot_assignment_snapshot

std::string Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetTransaction::slot_assignment_snapshot

Referenced by Slic3r::anonymous_namespace{PluginHostPresets.cpp}::bind_filament_target(), and commit().

slot_number

int Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetTransaction::slot_number = 0

Referenced by Slic3r::anonymous_namespace{PluginHostPresets.cpp}::bind_filament_target(), and commit().

staged

std::vector<std::pair<std::string, std::string> > Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetTransaction::staged

Referenced by commit(), and set().

staged_keys

std::set<std::string> Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetTransaction::staged_keys

Referenced by set().

target_name

std::string Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetTransaction::target_name

Referenced by Slic3r::anonymous_namespace{PluginHostPresets.cpp}::bind_filament_target(), Slic3r::anonymous_namespace{PluginHostPresets.cpp}::bind_preset_target(), and commit().

type

Preset::Type Slic3r::anonymous_namespace{PluginHostPresets.cpp}::PresetTransaction::type = Preset::TYPE_INVALID

Referenced by Slic3r::anonymous_namespace{PluginHostPresets.cpp}::bind_filament_target(), Slic3r::anonymous_namespace{PluginHostPresets.cpp}::bind_preset_target(), and commit().

---

The documentation for this struct was generated from the following file:

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/plugin/host/PluginHostPresets.cpp