295 lines
12 KiB
C++
295 lines
12 KiB
C++
#ifndef slic3r_OptionsGroup_hpp_
|
|
#define slic3r_OptionsGroup_hpp_
|
|
|
|
#include <wx/stattext.h>
|
|
#include <wx/settings.h>
|
|
|
|
#include <map>
|
|
#include <functional>
|
|
|
|
#include "libslic3r/Config.hpp"
|
|
#include "libslic3r/PrintConfig.hpp"
|
|
|
|
#include "Field.hpp"
|
|
#include "I18N.hpp"
|
|
|
|
// Translate the ifdef
|
|
#ifdef __WXOSX__
|
|
#define wxOSX true
|
|
#else
|
|
#define wxOSX false
|
|
#endif
|
|
|
|
#define BORDER(a, b) ((wxOSX ? a : b))
|
|
|
|
namespace Slic3r { namespace GUI {
|
|
|
|
// Thrown if the building of a parameter page is canceled.
|
|
class UIBuildCanceled : public std::exception {};
|
|
class OG_CustomCtrl;
|
|
|
|
/// Widget type describes a function object that returns a wxWindow (our widget) and accepts a wxWidget (parent window).
|
|
using widget_t = std::function<wxSizer*(wxWindow*)>;//!std::function<wxWindow*(wxWindow*)>;
|
|
|
|
/// Wraps a ConfigOptionDef and adds function object for creating a side_widget.
|
|
struct Option {
|
|
ConfigOptionDef opt { ConfigOptionDef() };
|
|
t_config_option_key opt_id;//! {""};
|
|
widget_t side_widget {nullptr};
|
|
bool readonly {false};
|
|
|
|
bool operator==(const Option& rhs) const {
|
|
return (rhs.opt_id == this->opt_id);
|
|
}
|
|
|
|
Option(const ConfigOptionDef& _opt, t_config_option_key id) :
|
|
opt(_opt), opt_id(id) {}
|
|
};
|
|
using t_option = std::unique_ptr<Option>; //!
|
|
|
|
/// Represents option lines
|
|
class Line {
|
|
public:
|
|
wxString label;
|
|
wxString label_tooltip;
|
|
wxString label_path;
|
|
|
|
size_t full_width {0};
|
|
wxColour* full_Label_color {nullptr};
|
|
bool blink {false};
|
|
widget_t widget {nullptr};
|
|
std::function<wxWindow*(wxWindow*)> near_label_widget{ nullptr };
|
|
wxWindow* near_label_widget_win {nullptr};
|
|
wxSizer* widget_sizer {nullptr};
|
|
wxSizer* extra_widget_sizer {nullptr};
|
|
|
|
void append_option(const Option& option) {
|
|
m_options.push_back(option);
|
|
}
|
|
void append_widget(const widget_t widget) {
|
|
m_extra_widgets.push_back(widget);
|
|
}
|
|
Line(wxString label, wxString tooltip) :
|
|
label(_(label)), label_tooltip(_(tooltip)) {}
|
|
|
|
const std::vector<widget_t>& get_extra_widgets() const {return m_extra_widgets;}
|
|
const std::vector<Option>& get_options() const { return m_options; }
|
|
bool* get_blink_ptr() { return &blink; }
|
|
|
|
private:
|
|
std::vector<Option> m_options;//! {std::vector<Option>()};
|
|
std::vector<widget_t> m_extra_widgets;//! {std::vector<widget_t>()};
|
|
};
|
|
|
|
using column_t = std::function<wxWindow*(wxWindow* parent, const Line&)>;
|
|
|
|
using t_optionfield_map = std::map<t_config_option_key, t_field>;
|
|
using t_opt_map = std::map< std::string, std::pair<std::string, int> >;
|
|
|
|
class OptionsGroup {
|
|
wxStaticBox* stb;
|
|
public:
|
|
const bool staticbox {true};
|
|
const wxString title;
|
|
size_t label_width = 20 ;// {200};
|
|
wxSizer* sizer {nullptr};
|
|
OG_CustomCtrl* custom_ctrl{ nullptr };
|
|
column_t extra_column {nullptr};
|
|
t_change m_on_change { nullptr };
|
|
// To be called when the field loses focus, to assign a new initial value to the field.
|
|
// Used by the relative position / rotation / scale manipulation fields of the Object Manipulation UI.
|
|
t_kill_focus m_fill_empty_value { nullptr };
|
|
t_kill_focus m_set_focus { nullptr };
|
|
std::function<DynamicPrintConfig()> m_get_initial_config{ nullptr };
|
|
std::function<DynamicPrintConfig()> m_get_sys_config{ nullptr };
|
|
std::function<bool()> have_sys_config{ nullptr };
|
|
|
|
std::function<void(wxWindow* win)> rescale_extra_column_item { nullptr };
|
|
std::function<void(wxWindow* win)> rescale_near_label_widget { nullptr };
|
|
|
|
wxFont sidetext_font {wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT) };
|
|
wxFont label_font {wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT) };
|
|
int sidetext_width{ -1 };
|
|
int sublabel_width{ -1 };
|
|
|
|
/// Returns a copy of the pointer of the parent wxWindow.
|
|
/// Accessor function is because users are not allowed to change the parent
|
|
/// but defining it as const means a lot of const_casts to deal with wx functions.
|
|
inline wxWindow* parent() const { return m_parent; }
|
|
|
|
wxWindow* ctrl_parent() const;
|
|
|
|
void append_line(const Line& line);
|
|
// create controls for the option group
|
|
void activate_line(Line& line);
|
|
|
|
// create all controls for the option group from the m_lines
|
|
bool activate(std::function<void()> throw_if_canceled = [](){});
|
|
// delete all controls from the option group
|
|
void clear(bool destroy_custom_ctrl = false);
|
|
|
|
Line create_single_option_line(const Option& option, const wxString& path = wxEmptyString) const;
|
|
void append_single_option_line(const Option& option, const wxString& path = wxEmptyString) { append_line(create_single_option_line(option, path)); }
|
|
|
|
// return a non-owning pointer reference
|
|
inline Field* get_field(const t_config_option_key& id) const{
|
|
if (m_fields.find(id) == m_fields.end()) return nullptr;
|
|
return m_fields.at(id).get();
|
|
}
|
|
bool set_value(const t_config_option_key& id, const boost::any& value, bool change_event = false) {
|
|
if (m_fields.find(id) == m_fields.end()) return false;
|
|
m_fields.at(id)->set_value(value, change_event);
|
|
return true;
|
|
}
|
|
boost::any get_value(const t_config_option_key& id) {
|
|
boost::any out;
|
|
if (m_fields.find(id) == m_fields.end()) ;
|
|
else
|
|
out = m_fields.at(id)->get_value();
|
|
return out;
|
|
}
|
|
|
|
void show_field(const t_config_option_key& opt_key, bool show = true);
|
|
void hide_field(const t_config_option_key& opt_key) { show_field(opt_key, false); }
|
|
|
|
void set_name(const wxString& new_name) {
|
|
stb->SetLabel(new_name);
|
|
}
|
|
|
|
inline void enable() { for (auto& field : m_fields) field.second->enable(); }
|
|
inline void disable() { for (auto& field : m_fields) field.second->disable(); }
|
|
void set_grid_vgap(int gap) { m_grid_sizer->SetVGap(gap); }
|
|
|
|
void clear_fields_except_of(const std::vector<std::string> left_fields);
|
|
|
|
void hide_labels() { label_width = 0; }
|
|
|
|
OptionsGroup( wxWindow* _parent, const wxString& title, bool is_tab_opt = false,
|
|
column_t extra_clmn = nullptr);
|
|
~OptionsGroup() { clear(true); }
|
|
|
|
wxGridSizer* get_grid_sizer() { return m_grid_sizer; }
|
|
const std::vector<Line>& get_lines() { return m_lines; }
|
|
bool is_legend_line();
|
|
|
|
protected:
|
|
std::map<t_config_option_key, Option> m_options;
|
|
wxWindow* m_parent {nullptr};
|
|
std::vector<ConfigOptionMode> m_options_mode;
|
|
std::vector<wxWindow*> m_extra_column_item_ptrs;
|
|
|
|
std::vector<Line> m_lines;
|
|
|
|
/// Field list, contains unique_ptrs of the derived type.
|
|
/// using types that need to know what it is beyond the public interface
|
|
/// need to cast based on the related ConfigOptionDef.
|
|
t_optionfield_map m_fields;
|
|
bool m_disabled {false};
|
|
wxGridSizer* m_grid_sizer {nullptr};
|
|
// "true" if option is created in preset tabs
|
|
bool m_use_custom_ctrl{ false };
|
|
|
|
// "true" if control should be created on custom_ctrl
|
|
bool m_use_custom_ctrl_as_parent { false };
|
|
|
|
// This panel is needed for correct showing of the ToolTips for Button, StaticText and CheckBox
|
|
// Tooltips on GTK doesn't work inside wxStaticBoxSizer unless you insert a panel
|
|
// inside it before you insert the other controls.
|
|
#if 0//#ifdef__WXGTK__
|
|
wxPanel* m_panel {nullptr};
|
|
#endif /* __WXGTK__ */
|
|
|
|
/// Generate a wxSizer or wxWindow from a configuration option
|
|
/// Precondition: opt resolves to a known ConfigOption
|
|
/// Postcondition: fields contains a wx gui object.
|
|
const t_field& build_field(const t_config_option_key& id, const ConfigOptionDef& opt);
|
|
const t_field& build_field(const t_config_option_key& id);
|
|
const t_field& build_field(const Option& opt);
|
|
|
|
virtual void on_kill_focus(const std::string& opt_key) {};
|
|
virtual void on_set_focus(const std::string& opt_key);
|
|
virtual void on_change_OG(const t_config_option_key& opt_id, const boost::any& value);
|
|
virtual void back_to_initial_value(const std::string& opt_key) {}
|
|
virtual void back_to_sys_value(const std::string& opt_key) {}
|
|
};
|
|
|
|
class ConfigOptionsGroup: public OptionsGroup {
|
|
public:
|
|
ConfigOptionsGroup( wxWindow* parent, const wxString& title, DynamicPrintConfig* config = nullptr,
|
|
bool is_tab_opt = false, column_t extra_clmn = nullptr) :
|
|
OptionsGroup(parent, title, is_tab_opt, extra_clmn), m_config(config) {}
|
|
ConfigOptionsGroup( wxWindow* parent, const wxString& title, ModelConfig* config,
|
|
bool is_tab_opt = false, column_t extra_clmn = nullptr) :
|
|
OptionsGroup(parent, title, is_tab_opt, extra_clmn), m_config(&config->get()), m_modelconfig(config) {}
|
|
ConfigOptionsGroup( wxWindow* parent) :
|
|
OptionsGroup(parent, wxEmptyString, true, nullptr) {}
|
|
|
|
const std::string& config_category() const throw() { return m_config_category; }
|
|
const t_opt_map& opt_map() const throw() { return m_opt_map; }
|
|
|
|
void set_config_category(const std::string &category) { this->m_config_category = category; }
|
|
void set_config(DynamicPrintConfig* config) { m_config = config; m_modelconfig = nullptr; }
|
|
Option get_option(const std::string& opt_key, int opt_index = -1);
|
|
Line create_single_option_line(const std::string& title, const wxString& path = wxEmptyString, int idx = -1) /*const*/{
|
|
Option option = get_option(title, idx);
|
|
return OptionsGroup::create_single_option_line(option, path);
|
|
}
|
|
Line create_single_option_line(const Option& option, const wxString& path = wxEmptyString) const {
|
|
return OptionsGroup::create_single_option_line(option, path);
|
|
}
|
|
void append_single_option_line(const Option& option, const wxString& path = wxEmptyString) {
|
|
OptionsGroup::append_single_option_line(option, path);
|
|
}
|
|
void append_single_option_line(const std::string title, const wxString& path = wxEmptyString, int idx = -1)
|
|
{
|
|
Option option = get_option(title, idx);
|
|
append_single_option_line(option, path);
|
|
}
|
|
|
|
void on_change_OG(const t_config_option_key& opt_id, const boost::any& value) override;
|
|
void back_to_initial_value(const std::string& opt_key) override;
|
|
void back_to_sys_value(const std::string& opt_key) override;
|
|
void back_to_config_value(const DynamicPrintConfig& config, const std::string& opt_key);
|
|
void on_kill_focus(const std::string& opt_key) override;
|
|
void reload_config();
|
|
// return value shows visibility : false => all options are hidden
|
|
void Hide();
|
|
void Show(const bool show);
|
|
bool is_visible(ConfigOptionMode mode);
|
|
bool update_visibility(ConfigOptionMode mode);
|
|
void msw_rescale();
|
|
void sys_color_changed();
|
|
void refresh();
|
|
boost::any config_value(const std::string& opt_key, int opt_index, bool deserialize);
|
|
// return option value from config
|
|
boost::any get_config_value(const DynamicPrintConfig& config, const std::string& opt_key, int opt_index = -1);
|
|
Field* get_fieldc(const t_config_option_key& opt_key, int opt_index);
|
|
std::pair<OG_CustomCtrl*, bool*> get_custom_ctrl_with_blinking_ptr(const t_config_option_key& opt_key, int opt_index/* = -1*/);
|
|
|
|
private:
|
|
// Reference to libslic3r config or ModelConfig::get(), non-owning pointer.
|
|
// The reference is const, so that the spots which modify m_config are clearly
|
|
// demarcated by const_cast and m_config_changed_callback is called afterwards.
|
|
const DynamicPrintConfig* m_config {nullptr};
|
|
// If the config is modelconfig, then ModelConfig::touch() has to be called after value change.
|
|
ModelConfig* m_modelconfig { nullptr };
|
|
t_opt_map m_opt_map;
|
|
std::string m_config_category;
|
|
|
|
// Change an option on m_config, possibly call ModelConfig::touch().
|
|
void change_opt_value(const t_config_option_key& opt_key, const boost::any& value, int opt_index = 0);
|
|
};
|
|
|
|
// Static text shown among the options.
|
|
class ogStaticText :public wxStaticText{
|
|
public:
|
|
ogStaticText() {}
|
|
ogStaticText(wxWindow* parent, const wxString& text);
|
|
~ogStaticText() {}
|
|
|
|
void SetText(const wxString& value, bool wrap = true);
|
|
};
|
|
|
|
}}
|
|
|
|
#endif /* slic3r_OptionsGroup_hpp_ */
|