Slic3r::GUI::LazyPage< Panel > Class Template Reference

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

Inheritance diagram for Slic3r::GUI::LazyPage< Panel >:

Collaboration diagram for Slic3r::GUI::LazyPage< Panel >:

Public Types
using	Factory = std::function<Panel*(wxWindow* parent)>

Public Member Functions
	LazyPage (wxWindow *parent, std::string name, int order, Factory make=[](wxWindow *parent) { return new Panel(parent);})
bool	in_book () const
bool	pending () const override
bool	Show (bool show=true) override
Panel *	get () const
Panel *	ensure ()
void	when_built (std::function< void(Panel &)> fn)
const std::string &	name () const override
bool	built () const override
int	prebuild_order () const override
bool	build_step () override

Static Protected Member Functions
static void	log_null_factory (const std::string &name)

Private Member Functions
bool	steps_remain () const
void	step ()

Static Private Member Functions
static constexpr bool	registered ()
static constexpr bool	staged ()

Private Attributes
std::string	m_name
int	m_order
Factory	m_make
Panel *	m_object
std::atomic< bool >	m_complete
bool	m_building
bool	m_failed
std::vector< std::function< void(Panel &)> >	m_deferred

Detailed Description

template<class Panel>
class Slic3r::GUI::LazyPage< Panel >

Member Typedef Documentation

Factory

template<class Panel>

using Slic3r::GUI::LazyPage< Panel >::Factory = std::function<Panel*(wxWindow* parent)>

Constructor & Destructor Documentation

LazyPage()

template<class Panel>

Slic3r::GUI::LazyPage< Panel >::LazyPage ( wxWindow * parent, std::string name, int order, Factory make = [](wxWindow* parent) { return new Panel(parent); } )

inline

                                                                                              { return new Panel(parent); })
        : wxPanel(parent), Lazy<Panel>(std::move(name), order, [this, make = std::move(make)] {
            Panel* panel = make(this);
            GetSizer()->Add(panel, 1, wxEXPAND);
            // Hidden while its page is, as an inserted page would be.
            if (!IsShown())
                panel->Hide();
            return panel;
        })
    {
        SetSizer(new wxBoxSizer(wxVERTICAL));
        // Shown by the book when its tab is selected.
        Hide();
        this->when_built([this](Panel& panel) {
            apply_dark_ui_to_lazy_panel(&panel);
            Layout();
        });
    }

References Slic3r::GUI::Lazy< Panel >::name().

Here is the call graph for this function:

Member Function Documentation

build_step()

bool Slic3r::GUI::Lazy< Panel >::build_step ( )

inlineoverridevirtualinherited

Implements Slic3r::GUI::LazyBase.

    {
        if (built() || m_building || m_failed)
            return false;
        m_building = true;
        try {
            if (m_object == nullptr)
                m_object = m_make();
            else
                step();
        } catch (...) {
            m_building = false;
            throw;
        }
        m_building = false;
        if (m_object == nullptr) {
            m_failed = true;
            log_null_factory(m_name);
            return false;
        }
        if (steps_remain())
            return true;
        m_complete.store(true, std::memory_order_release);
        for (auto& fn : m_deferred)
            fn(*m_object);
        m_deferred.clear();
        return false;
    }

built()

bool Slic3r::GUI::Lazy< Panel >::built ( ) const

inlineoverridevirtualinherited

Implements Slic3r::GUI::LazyBase.

{ return m_complete.load(std::memory_order_acquire); }

Referenced by Slic3r::GUI::LazyPage< Panel >::Show().

Here is the caller graph for this function:

ensure()

Panel * Slic3r::GUI::Lazy< Panel >::ensure ( )

inlineinherited

    {
        if (!built() && !m_building) {
            OnDemandBuild build(*this);
            do
                build.unit();
            while (build_step());
        }
        return get();
    }

Referenced by Slic3r::GUI::LazyPage< Panel >::Show().

Here is the caller graph for this function:

get()

Panel * Slic3r::GUI::Lazy< Panel >::get ( ) const

inlineinherited

{ return built() ? m_object : nullptr; }

Referenced by Slic3r::GUI::LazyPage< Panel >::Show().

Here is the caller graph for this function:

in_book()

template<class Panel>

bool Slic3r::GUI::LazyPage< Panel >::in_book ( ) const

inline

    {
        auto* book = dynamic_cast<wxBookCtrlBase*>(GetParent());
        return book != nullptr && book->FindPage(this) != wxNOT_FOUND;
    }

Referenced by pending().

Here is the caller graph for this function:

log_null_factory()

void Slic3r::GUI::LazyBase::log_null_factory ( const std::string & name )

staticprotectedinherited

{
    BOOST_LOG_TRIVIAL(error) << "Lazy::build_step: the factory for " << name << " returned null";
}

name()

const std::string & Slic3r::GUI::Lazy< Panel >::name ( ) const

inlineoverridevirtualinherited

Implements Slic3r::GUI::LazyBase.

{ return m_name; }

Referenced by Slic3r::GUI::LazyPage< Panel >::LazyPage().

Here is the caller graph for this function:

pending()

template<class Panel>

bool Slic3r::GUI::LazyPage< Panel >::pending ( ) const

inlineoverridevirtual

Reimplemented from Slic3r::GUI::Lazy< Panel >.

{ return in_book() && Lazy<Panel>::pending(); }

References in_book(), and Slic3r::GUI::Lazy< T >::pending().

Here is the call graph for this function:

prebuild_order()

int Slic3r::GUI::Lazy< Panel >::prebuild_order ( ) const

inlineoverridevirtualinherited

Implements Slic3r::GUI::LazyBase.

{ return m_order; }

registered()

constexpr bool Slic3r::GUI::Lazy< Panel >::registered ( )

inlinestaticconstexprprivateinherited

{ return std::is_base_of_v<LazyInstance<T>, T>; }

Show()

template<class Panel>

bool Slic3r::GUI::LazyPage< Panel >::Show ( bool show = true )

inlineoverride

    {
        // Built before this page is shown, as an idle prebuild builds it. On MSW every control
        // created or moved inside a shown window re-clips and repaints its shown siblings, so
        // building a large panel into a shown page took seconds.
        if (show && wxGetTopLevelParent(this)->IsShown())
            this->ensure();
        const bool changed = wxPanel::Show(show);
        if (show) {
            // The book shows its first page as it is inserted, before startup has chosen the
            // start page, so a hidden frame builds nothing; MainFrame::Show() completes it.
            if (this->built() || wxGetTopLevelParent(this)->IsShown()) {
                if (Panel* panel = this->ensure())
                    panel->Show(true);
                // The sizer skipped the panel while the book kept it hidden.
                Layout();
            }
        } else if (Panel* panel = this->get()) {
            panel->Show(false);
        }
        return changed;
    }

References Slic3r::GUI::Lazy< Panel >::built(), Slic3r::GUI::Lazy< Panel >::ensure(), and Slic3r::GUI::Lazy< Panel >::get().

Here is the call graph for this function:

staged()

constexpr bool Slic3r::GUI::Lazy< Panel >::staged ( )

inlinestaticconstexprprivateinherited

{ return std::is_base_of_v<StagedBuild, T>; }

step()

void Slic3r::GUI::Lazy< Panel >::step ( )

inlineprivateinherited

    {
        if constexpr (staged())
            m_object->build_step();
    }

steps_remain()

bool Slic3r::GUI::Lazy< Panel >::steps_remain ( ) const

inlineprivateinherited

    {
        if constexpr (staged())
            return !m_object->built();
        else
            return false;
    }

when_built()

void Slic3r::GUI::Lazy< Panel >::when_built ( std::function< void(Panel &)> fn )

inlineinherited

    {
        if (built())
            fn(*m_object);
        else
            m_deferred.push_back(std::move(fn));
    }

Member Data Documentation

m_building

bool Slic3r::GUI::Lazy< Panel >::m_building

privateinherited

{ false };

m_complete

std::atomic<bool> Slic3r::GUI::Lazy< Panel >::m_complete

privateinherited

{ false };

m_deferred

std::vector<std::function<void(Panel&)> > Slic3r::GUI::Lazy< Panel >::m_deferred

privateinherited

m_failed

bool Slic3r::GUI::Lazy< Panel >::m_failed

privateinherited

{ false };

m_make

Factory Slic3r::GUI::Lazy< Panel >::m_make

privateinherited

m_name

std::string Slic3r::GUI::Lazy< Panel >::m_name

privateinherited

m_object

Panel* Slic3r::GUI::Lazy< Panel >::m_object

privateinherited

{ nullptr };

m_order

int Slic3r::GUI::Lazy< Panel >::m_order

privateinherited

---

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

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/LazyPage.hpp