Slic3r::Search::SettingsIndex Class Reference

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

Collaboration diagram for Slic3r::Search::SettingsIndex:

Public Member Functions
void	init (std::vector< InputInfo > input_values)
bool	apply (DynamicPrintConfig *config, Preset::Type type, ConfigOptionMode mode)
void	add_key (const std::string &opt_key, Preset::Type type, const wxString &group, const wxString &category, const wxString &icon=wxEmptyString)
void	set_path (const std::string &opt_key, Preset::Type type, const std::string &path)
void	set_line_label (const std::string &opt_key, Preset::Type type, const wxString &label, const wxString &label_en)
const std::vector< Option > &	options () const
const std::vector< Option > &	all_options () const
const Option &	option_at (size_t pos) const
const Option &	get_option (const std::string &opt_key, Preset::Type type, int &variant_index) const
Option	get_option (const std::string &opt_key, const wxString &label, Preset::Type type) const
const GroupAndCategory &	get_group_and_category (const std::string &opt_key)
void	sort_options_by_key ()
void	sort_options_by_label ()

Private Member Functions
void	append_options (DynamicPrintConfig *config, Preset::Type type, ConfigOptionMode mode)
void	sort_options ()

Private Attributes
std::map< std::string, GroupAndCategory >	m_groups_and_categories
std::vector< Option >	m_options
std::vector< Option >	m_all_modes

Detailed Description

Member Function Documentation

add_key()

void Slic3r::Search::SettingsIndex::add_key	(	const std::string &	opt_key,
		Preset::Type	type,
		const wxString &	group,
		const wxString &	category,
		const wxString &	icon = wxEmptyString )

{
    // Update fields in place so a page rebuild (get_option after set_path) doesn't drop the
    // previously recorded wiki path.
    GroupAndCategory &gc = m_groups_and_categories[get_key(opt_key, type)];
    gc.group    = group;
    gc.category = category;
    gc.icon     = icon;
}

References Slic3r::Search::GroupAndCategory::category, Slic3r::Search::get_key(), Slic3r::Search::GroupAndCategory::group, Slic3r::Search::GroupAndCategory::icon, and m_groups_and_categories.

Referenced by Slic3r::GUI::TabPrinter::create_bed_shape_widget().

Here is the call graph for this function:

Here is the caller graph for this function:

all_options()

const std::vector< Option > & Slic3r::Search::SettingsIndex::all_options ( ) const

inline

{ return m_all_modes; }

References m_all_modes.

append_options()

void Slic3r::Search::SettingsIndex::append_options ( DynamicPrintConfig * config, Preset::Type type, ConfigOptionMode mode )

private

{
    for (std::string opt_key : config->keys()) {
        const ConfigOptionDef &opt = config->def()->options.at(opt_key);
        const bool in_filtered = opt.mode <= mode;
 
        int cnt = 0;
 
        if ((type == Preset::TYPE_SLA_MATERIAL || type == Preset::TYPE_PRINTER || type == Preset::TYPE_PRINT) && opt_key != "printable_area")
            switch (config->option(opt_key)->type()) {
            case coInts: change_opt_key<ConfigOptionInts>(opt_key, config, cnt); break;
            case coBools: change_opt_key<ConfigOptionBools>(opt_key, config, cnt); break;
            case coFloats: change_opt_key<ConfigOptionFloats>(opt_key, config, cnt); break;
            case coStrings: change_opt_key<ConfigOptionStrings>(opt_key, config, cnt); break;
            case coPercents: change_opt_key<ConfigOptionPercents>(opt_key, config, cnt); break;
            case coFloatsOrPercents: change_opt_key<ConfigOptionVector<FloatOrPercent>>(opt_key, config, cnt); break;
            case coPoints: change_opt_key<ConfigOptionPoints>(opt_key, config, cnt); break;
            // BBS
            case coEnums: change_opt_key<ConfigOptionInts>(opt_key, config, cnt); break;
            default: break;
            }
 
        if (type == Preset::TYPE_FILAMENT && filament_options_with_variant.find(opt_key) != filament_options_with_variant.end())
            opt_key += "#0";
 
        wxString label = opt.full_label.empty() ? opt.label : opt.full_label;
 
        std::string key = get_key(opt_key, type);
        auto add = [&](const std::string &k) {
            const GroupAndCategory &gc = m_groups_and_categories[k];
            if (gc.group.IsEmpty() || gc.category.IsEmpty() || label.IsEmpty()) return;
 
            const std::string tooltip = into_u8(_(opt.tooltip));
            if (in_filtered)
                m_options.emplace_back(make_option(k, type, label, gc, opt.mode, tooltip, false));
            m_all_modes.emplace_back(make_option(k, type, label, gc, opt.mode, tooltip, false));
        };
        if (cnt == 0)
            add(key);
        else
            for (int i = 0; i < cnt; ++i)
                // ! It's very important to use "#". opt_key#n is a real option key used in GroupAndCategory
                add(key + "#" + std::to_string(i));
    }
}

References _, Slic3r::Search::GroupAndCategory::category, Slic3r::Search::change_opt_key(), Slic3r::coBools, Slic3r::coEnums, Slic3r::coFloats, Slic3r::coFloatsOrPercents, Slic3r::coInts, Slic3r::coPercents, Slic3r::coPoints, Slic3r::coStrings, Slic3r::DynamicPrintConfig::def(), Slic3r::filament_options_with_variant, Slic3r::Search::get_key(), Slic3r::Search::GroupAndCategory::group, Slic3r::into_u8(), Slic3r::DynamicConfig::keys(), m_all_modes, m_groups_and_categories, m_options, Slic3r::Search::make_option(), Slic3r::ConfigBase::option(), Slic3r::ConfigDef::options, Slic3r::ConfigOption::type(), Slic3r::Preset::TYPE_FILAMENT, Slic3r::Preset::TYPE_PRINT, Slic3r::Preset::TYPE_PRINTER, and Slic3r::Preset::TYPE_SLA_MATERIAL.

Referenced by apply(), and init().

Here is the call graph for this function:

Here is the caller graph for this function:

apply()

bool Slic3r::Search::SettingsIndex::apply	(	DynamicPrintConfig *	config,
		Preset::Type	type,
		ConfigOptionMode	mode )

{
    // m_all_modes is a separate consumer (the Speed Dial), so "nothing initialised yet" means both
    // views are empty - the mode-filtered m_options can be empty while m_all_modes is not.
    if (m_options.empty() && m_all_modes.empty()) return false;
 
    m_options.erase(std::remove_if(m_options.begin(), m_options.end(), [type](Option opt) { return opt.type == type; }), m_options.end());
    m_all_modes.erase(std::remove_if(m_all_modes.begin(), m_all_modes.end(), [type](Option opt) { return opt.type == type; }), m_all_modes.end());
 
    append_options(config, type, mode);
 
    sort_options();
 
    return true;
}

References append_options(), m_all_modes, m_options, and sort_options().

Here is the call graph for this function:

get_group_and_category()

const GroupAndCategory & Slic3r::Search::SettingsIndex::get_group_and_category ( const std::string & opt_key )

inline

{ return m_groups_and_categories[opt_key]; }

References m_groups_and_categories.

Referenced by Slic3r::GUI::TabPrinter::create_bed_shape_widget().

Here is the caller graph for this function:

get_option() [1/2]

Option Slic3r::Search::SettingsIndex::get_option	(	const std::string &	opt_key,
		const wxString &	label,
		Preset::Type	type ) const

{
    std::string key = get_key(opt_key, type);
    auto        it  = std::lower_bound(m_options.begin(), m_options.end(), Option({boost::nowide::widen(key)}));
    // BBS: return the 0th option when not found in searcher caused by mode difference
    if (it == m_options.end()) return m_options[0];
    if (it->key == boost::nowide::widen(key)) return m_options[it - m_options.begin()];
    if (m_groups_and_categories.find(key) == m_groups_and_categories.end()) {
        size_t pos = key.find('#');
        if (pos == std::string::npos) return m_options[it - m_options.begin()];
 
        std::string zero_opt_key = key.substr(0, pos + 1) + "0";
 
        if (m_groups_and_categories.find(zero_opt_key) == m_groups_and_categories.end()) return m_options[it - m_options.begin()];
 
        return create_option(opt_key, label, type, m_groups_and_categories.at(zero_opt_key));
    }
 
    const GroupAndCategory &gc = m_groups_and_categories.at(key);
    if (gc.group.IsEmpty() || gc.category.IsEmpty()) return m_options[it - m_options.begin()];
 
    return create_option(opt_key, label, type, gc);
}

References Slic3r::Search::GroupAndCategory::category, Slic3r::Search::create_option(), Slic3r::Search::get_key(), Slic3r::Search::GroupAndCategory::group, m_groups_and_categories, and m_options.

Here is the call graph for this function:

get_option() [2/2]

const Option & Slic3r::Search::SettingsIndex::get_option	(	const std::string &	opt_key,
		Preset::Type	type,
		int &	variant_index ) const

{
    auto not_found = [&variant_index]() -> const Option & {
        static const Option empty_option;
        variant_index = -2;
        return empty_option;
    };
 
    variant_index = -1;
    std::string opt_key2 = opt_key;
    if (auto n = opt_key.find('#'); n != std::string::npos) {
        variant_index = std::atoi(opt_key.c_str() + n + 1);
        opt_key2 = opt_key.substr(0, n);
    }
    const std::wstring key = boost::nowide::widen(get_key(opt_key2, type));
    auto               it  = std::lower_bound(m_options.begin(), m_options.end(), Option({key}));
    if (it == m_options.end()) return not_found();
    if (it->key == key) {
        variant_index = -1;
    } else {
        const std::wstring prefix = key + L"#";
        it = std::lower_bound(it, m_options.end(), Option({prefix}));
        if (it == m_options.end() || it->key.compare(0, prefix.length(), prefix) != 0)
            return not_found();
        // Orca: Copy-parameters dialogs request the base key, without a vector index.
        if (variant_index < 0) return *it;
 
        const bool has_mode = type == Preset::TYPE_PRINTER && printer_options_with_variant_2.count(opt_key2) > 0;
        const bool has_variant =
            (type == Preset::TYPE_PRINT && print_options_with_variant.count(opt_key2) > 0) ||
            (type == Preset::TYPE_FILAMENT && filament_options_with_variant.count(opt_key2) > 0) ||
            (type == Preset::TYPE_PRINTER && printer_options_with_variant_1.count(opt_key2) > 0) || has_mode;
        if (!has_variant || has_mode) {
            // Orca: Machine limits store (Normal, Silent) pairs per variant; the UI registers only #0/#1.
            const std::wstring indexed_key = has_mode ? prefix + std::to_wstring(variant_index % 2) :
                                                       boost::nowide::widen(get_key(opt_key, type));
            it = std::lower_bound(it, m_options.end(), Option({indexed_key}));
            if (it == m_options.end() || it->key != indexed_key)
                return not_found();
            if (!has_variant)
                variant_index = -1;
        }
    }
 
    return m_options[it - m_options.begin()];
}

References Slic3r::filament_options_with_variant, Slic3r::Search::get_key(), L, m_options, Slic3r::print_options_with_variant, Slic3r::printer_options_with_variant_1, Slic3r::printer_options_with_variant_2, Slic3r::Preset::TYPE_FILAMENT, Slic3r::Preset::TYPE_PRINT, and Slic3r::Preset::TYPE_PRINTER.

Referenced by Slic3r::GUI::DiffPresetDialog::update_tree(), Slic3r::GUI::UnsavedChangesDialog::update_tree(), and Slic3r::GUI::UnsavedChangesDialog::update_tree().

Here is the call graph for this function:

Here is the caller graph for this function:

init()

void Slic3r::Search::SettingsIndex::init

(

std::vector< InputInfo >

input_values

)

{
    m_options.clear();
    m_all_modes.clear();
    for (auto i : input_values) append_options(i.config, i.type, i.mode);
    sort_options();
}

References append_options(), m_all_modes, m_options, and sort_options().

Here is the call graph for this function:

option_at()

const Option & Slic3r::Search::SettingsIndex::option_at ( size_t pos ) const

inline

{ return m_options[pos]; }

References m_options.

options()

const std::vector< Option > & Slic3r::Search::SettingsIndex::options ( ) const

inline

{ return m_options; }

References m_options.

set_line_label()

void Slic3r::Search::SettingsIndex::set_line_label	(	const std::string &	opt_key,
		Preset::Type	type,
		const wxString &	label,
		const wxString &	label_en )

{
    if (label.IsEmpty())
        return;
    GroupAndCategory &gc = m_groups_and_categories[get_key(opt_key, type)];
    gc.line_label        = label;
    gc.line_label_en     = label_en;
}

References Slic3r::Search::get_key(), Slic3r::Search::GroupAndCategory::line_label, Slic3r::Search::GroupAndCategory::line_label_en, and m_groups_and_categories.

Referenced by Slic3r::GUI::OptionsGroup::append_line().

Here is the call graph for this function:

Here is the caller graph for this function:

set_path()

void Slic3r::Search::SettingsIndex::set_path	(	const std::string &	opt_key,
		Preset::Type	type,
		const std::string &	path )

{
    if (path.empty())
        return;
    m_groups_and_categories[get_key(opt_key, type)].path = path;
}

References Slic3r::Search::get_key(), and m_groups_and_categories.

Referenced by Slic3r::GUI::OptionsGroup::append_line().

Here is the call graph for this function:

Here is the caller graph for this function:

sort_options()

void Slic3r::Search::SettingsIndex::sort_options ( )

private

{
    // Both views are label-sorted and multi_category-marked. They are separate consumers (the sidebar
    // search and the Speed Dial); keeping them in sync here prevents the all-modes view from silently
    // diverging in order or flags.
    auto sort_and_mark = [](std::vector<Option> &v) {
        std::sort(v.begin(), v.end(), [](const Option &o1, const Option &o2) { return o1.label < o2.label; });
        Option *last = nullptr;
        for (auto &opt : v) {
            if (last && last->label == opt.label && last->group == opt.group && last->type == opt.type && last->category != opt.category) {
                last->multi_category = true;
                opt.multi_category = true;
            }
            last = &opt;
        }
    };
    sort_and_mark(m_options);
    sort_and_mark(m_all_modes);
}

References Slic3r::Search::Option::category, Slic3r::Search::Option::group, Slic3r::Search::Option::label, m_all_modes, m_options, Slic3r::Search::Option::multi_category, and Slic3r::Search::Option::type.

Referenced by apply(), init(), and sort_options_by_label().

Here is the caller graph for this function:

sort_options_by_key()

void Slic3r::Search::SettingsIndex::sort_options_by_key ( )

inline

    {
        std::sort(m_options.begin(), m_options.end(), [](const Option &o1, const Option &o2) { return o1.key < o2.key; });
    }

References m_options.

Referenced by Slic3r::GUI::DiffPresetDialog::update_tree(), Slic3r::GUI::UnsavedChangesDialog::update_tree(), and Slic3r::GUI::UnsavedChangesDialog::update_tree().

Here is the caller graph for this function:

sort_options_by_label()

void Slic3r::Search::SettingsIndex::sort_options_by_label ( )

inline

{ sort_options(); }

References sort_options().

Referenced by Slic3r::GUI::DiffPresetDialog::update_tree(), and Slic3r::GUI::UnsavedChangesDialog::update_tree().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_all_modes

std::vector<Option> Slic3r::Search::SettingsIndex::m_all_modes

private

Referenced by all_options(), append_options(), apply(), init(), and sort_options().

m_groups_and_categories

std::map<std::string, GroupAndCategory> Slic3r::Search::SettingsIndex::m_groups_and_categories

private

Referenced by add_key(), append_options(), get_group_and_category(), get_option(), set_line_label(), and set_path().

m_options

std::vector<Option> Slic3r::Search::SettingsIndex::m_options

private

Referenced by append_options(), apply(), get_option(), get_option(), init(), option_at(), options(), sort_options(), and sort_options_by_key().

---

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

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