Slic3r::PagesPluginCapability Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/plugin/pluginTypes/pages/PagesPluginCapability.hpp>

Inheritance diagram for Slic3r::PagesPluginCapability:

Collaboration diagram for Slic3r::PagesPluginCapability:

Public Member Functions
PluginCapabilityType	get_type () const override
virtual std::string	get_ui ()=0
virtual void	on_message (std::string message)
virtual std::string	get_icon ()
void	post_message (std::string message)
void	set_message_sender (std::function< void(const std::string &)> sender)
void	clear_message_sender ()
virtual std::string	get_name () const =0
virtual bool	has_config_ui () const
virtual std::string	get_config_ui () const
virtual nlohmann::json	get_default_config () const
virtual void	on_load ()
virtual void	on_unload ()
virtual void	on_cancelled ()
virtual void	on_lifecycle_event (LifecycleEvent event, const LifecycleEventContext &ctx)
const std::string &	name () const
PluginCapabilityType	type () const
PluginCapabilityId	identity () const
void	set_resolved_identity (std::string name, PluginCapabilityType type)
bool	is_enabled () const
void	set_enabled (bool enabled)
bool	config_ui_available () const
void	set_config_ui_available (bool available)
void	set_audit_plugin_key (std::string key)
const std::string &	audit_plugin_key () const
void	increment () const
void	decrement () const
int	ref_count () const

Static Public Member Functions
static void	RegisterBindings (pybind11::module_ &module)

Private Attributes
std::mutex	m_message_mutex
std::function< void(const std::string &)>	m_message_sender
std::string	m_name
PluginCapabilityType	m_type = PluginCapabilityType::Unknown
std::atomic< bool >	m_enabled {true}
bool	m_config_ui_available = false
std::string	m_audit_plugin_key
std::atomic< int >	m_refs {0}

Detailed Description

Member Function Documentation

audit_plugin_key()

const std::string & Slic3r::PluginCapabilityInterface::audit_plugin_key ( ) const

inlineinherited

{ return m_audit_plugin_key; }

References m_audit_plugin_key.

Referenced by Slic3r::PyPrinterAgentPluginCapabilityTrampoline::log_failure().

Here is the caller graph for this function:

clear_message_sender()

void Slic3r::PagesPluginCapability::clear_message_sender

(

)

{
    std::lock_guard<std::mutex> lock(m_message_mutex);
    m_message_sender = nullptr;
}

References m_message_mutex, and m_message_sender.

config_ui_available()

bool Slic3r::PluginCapabilityInterface::config_ui_available ( ) const

inlineinherited

{ return m_config_ui_available; }

References m_config_ui_available.

decrement()

void Slic3r::PluginCapabilityInterface::decrement ( ) const

inlineinherited

{ m_refs.fetch_sub(1, std::memory_order_acq_rel); }

References m_refs.

get_config_ui()

virtual std::string Slic3r::PluginCapabilityInterface::get_config_ui ( ) const

inlinevirtualinherited

Reimplemented in Slic3r::PyPluginCommonTrampoline< PagesPluginCapability >, Slic3r::PyPluginCommonTrampoline< PluginCapabilityInterface >, Slic3r::PyPluginCommonTrampoline< PrinterAgentPluginCapability >, Slic3r::PyPluginCommonTrampoline< ResourceTexturePluginCapability >, Slic3r::PyPluginCommonTrampoline< ScriptPluginCapability >, and Slic3r::PyPluginCommonTrampoline< SlicingPipelinePluginCapability >.

{ return ""; }

Referenced by Slic3r::bind_python_api().

Here is the caller graph for this function:

get_default_config()

virtual nlohmann::json Slic3r::PluginCapabilityInterface::get_default_config ( ) const

inlinevirtualinherited

Reimplemented in Slic3r::PyPluginCommonTrampoline< PagesPluginCapability >, Slic3r::PyPluginCommonTrampoline< PluginCapabilityInterface >, Slic3r::PyPluginCommonTrampoline< PrinterAgentPluginCapability >, Slic3r::PyPluginCommonTrampoline< ResourceTexturePluginCapability >, Slic3r::PyPluginCommonTrampoline< ScriptPluginCapability >, and Slic3r::PyPluginCommonTrampoline< SlicingPipelinePluginCapability >.

{ return nlohmann::json::object(); }

Referenced by Slic3r::bind_python_api().

Here is the caller graph for this function:

get_icon()

virtual std::string Slic3r::PagesPluginCapability::get_icon ( )

inlinevirtual

Reimplemented in Slic3r::PyPagesPluginCapabilityTrampoline.

{ return {}; }

Referenced by RegisterBindings().

Here is the caller graph for this function:

get_name()

virtual std::string Slic3r::PluginCapabilityInterface::get_name ( ) const

pure virtualinherited

Implemented in Slic3r::PyPluginCommonTrampoline< PagesPluginCapability >, Slic3r::PyPluginCommonTrampoline< PluginCapabilityInterface >, Slic3r::PyPluginCommonTrampoline< PrinterAgentPluginCapability >, Slic3r::PyPluginCommonTrampoline< ResourceTexturePluginCapability >, Slic3r::PyPluginCommonTrampoline< ScriptPluginCapability >, and Slic3r::PyPluginCommonTrampoline< SlicingPipelinePluginCapability >.

Referenced by Slic3r::bind_python_api().

Here is the caller graph for this function:

get_type()

PluginCapabilityType Slic3r::PagesPluginCapability::get_type ( ) const

inlineoverridevirtual

Reimplemented from Slic3r::PluginCapabilityInterface.

{ return PluginCapabilityType::Pages; }

References Slic3r::Pages.

Referenced by RegisterBindings().

Here is the caller graph for this function:

get_ui()

virtual std::string Slic3r::PagesPluginCapability::get_ui ( )

pure virtual

Implemented in Slic3r::PyPagesPluginCapabilityTrampoline.

Referenced by RegisterBindings().

Here is the caller graph for this function:

has_config_ui()

virtual bool Slic3r::PluginCapabilityInterface::has_config_ui ( ) const

inlinevirtualinherited

Reimplemented in Slic3r::PyPluginCommonTrampoline< PagesPluginCapability >, Slic3r::PyPluginCommonTrampoline< PluginCapabilityInterface >, Slic3r::PyPluginCommonTrampoline< PrinterAgentPluginCapability >, Slic3r::PyPluginCommonTrampoline< ResourceTexturePluginCapability >, Slic3r::PyPluginCommonTrampoline< ScriptPluginCapability >, and Slic3r::PyPluginCommonTrampoline< SlicingPipelinePluginCapability >.

{ return false; }

Referenced by Slic3r::bind_python_api().

Here is the caller graph for this function:

identity()

PluginCapabilityId Slic3r::PluginCapabilityInterface::identity ( ) const

inlineinherited

{ return {m_type, m_name, m_audit_plugin_key}; }

References m_audit_plugin_key, m_name, and m_type.

Referenced by Slic3r::anonymous_namespace{PluginConfig.cpp}::capability_identity().

Here is the caller graph for this function:

increment()

void Slic3r::PluginCapabilityInterface::increment ( ) const

inlineinherited

{ m_refs.fetch_add(1, std::memory_order_acq_rel); }

References m_refs.

is_enabled()

bool Slic3r::PluginCapabilityInterface::is_enabled ( ) const

inlineinherited

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

References m_enabled.

name()

const std::string & Slic3r::PluginCapabilityInterface::name ( ) const

inlineinherited

{ return m_name; }

References m_name.

Referenced by Slic3r::PrinterAgentPluginCapability::RegisterBindings(), and set_resolved_identity().

Here is the caller graph for this function:

on_cancelled()

virtual void Slic3r::PluginCapabilityInterface::on_cancelled ( )

inlinevirtualinherited

Reimplemented in Slic3r::PyPluginCommonTrampoline< PagesPluginCapability >, Slic3r::PyPluginCommonTrampoline< PluginCapabilityInterface >, Slic3r::PyPluginCommonTrampoline< PrinterAgentPluginCapability >, Slic3r::PyPluginCommonTrampoline< ResourceTexturePluginCapability >, Slic3r::PyPluginCommonTrampoline< ScriptPluginCapability >, and Slic3r::PyPluginCommonTrampoline< SlicingPipelinePluginCapability >.

{}

on_lifecycle_event()

virtual void Slic3r::PluginCapabilityInterface::on_lifecycle_event ( LifecycleEvent event, const LifecycleEventContext & ctx )

inlinevirtualinherited

Reimplemented in Slic3r::PyPluginCommonTrampoline< PagesPluginCapability >, Slic3r::PyPluginCommonTrampoline< PluginCapabilityInterface >, Slic3r::PyPluginCommonTrampoline< PrinterAgentPluginCapability >, Slic3r::PyPluginCommonTrampoline< ResourceTexturePluginCapability >, Slic3r::PyPluginCommonTrampoline< ScriptPluginCapability >, and Slic3r::PyPluginCommonTrampoline< SlicingPipelinePluginCapability >.

{ (void) event; (void) ctx; }

Referenced by Slic3r::bind_python_api().

Here is the caller graph for this function:

on_load()

virtual void Slic3r::PluginCapabilityInterface::on_load ( )

inlinevirtualinherited

Reimplemented in Slic3r::PyPluginCommonTrampoline< PagesPluginCapability >, Slic3r::PyPluginCommonTrampoline< PluginCapabilityInterface >, Slic3r::PyPluginCommonTrampoline< PrinterAgentPluginCapability >, Slic3r::PyPluginCommonTrampoline< ResourceTexturePluginCapability >, Slic3r::PyPluginCommonTrampoline< ScriptPluginCapability >, and Slic3r::PyPluginCommonTrampoline< SlicingPipelinePluginCapability >.

{}

Referenced by Slic3r::bind_python_api().

Here is the caller graph for this function:

on_message()

virtual void Slic3r::PagesPluginCapability::on_message ( std::string message )

inlinevirtual

Reimplemented in Slic3r::PyPagesPluginCapabilityTrampoline.

{ (void) message; }

Referenced by RegisterBindings().

Here is the caller graph for this function:

on_unload()

virtual void Slic3r::PluginCapabilityInterface::on_unload ( )

inlinevirtualinherited

Reimplemented in Slic3r::PyPluginCommonTrampoline< PagesPluginCapability >, Slic3r::PyPluginCommonTrampoline< PluginCapabilityInterface >, Slic3r::PyPluginCommonTrampoline< PrinterAgentPluginCapability >, Slic3r::PyPluginCommonTrampoline< ResourceTexturePluginCapability >, Slic3r::PyPluginCommonTrampoline< ScriptPluginCapability >, and Slic3r::PyPluginCommonTrampoline< SlicingPipelinePluginCapability >.

{}

Referenced by Slic3r::bind_python_api().

Here is the caller graph for this function:

post_message()

void Slic3r::PagesPluginCapability::post_message

(

std::string

message

)

{
    std::function<void(const std::string&)> sender;
    {
        std::lock_guard<std::mutex> lock(m_message_mutex);
        sender = m_message_sender;
    }
 
    if (sender)
        sender(message);
}

References m_message_mutex, and m_message_sender.

Referenced by RegisterBindings().

Here is the caller graph for this function:

ref_count()

int Slic3r::PluginCapabilityInterface::ref_count ( ) const

inlineinherited

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

References m_refs.

RegisterBindings()

void Slic3r::PagesPluginCapability::RegisterBindings ( pybind11::module_ & module )

static

{
    BOOST_LOG_TRIVIAL(debug) << "Registering orca.pages bindings";
 
    auto pages = module.def_submodule("pages", "Plugin page API");
 
    py::class_<PagesPluginCapability, PluginCapabilityInterface, PyPagesPluginCapabilityTrampoline,
               std::shared_ptr<PagesPluginCapability>>(pages, "PagesPluginCapabilityBase")
        .def(py::init<>())
        .def("get_type", &PagesPluginCapability::get_type)
        .def("get_ui", &PagesPluginCapability::get_ui)
        .def("get_icon", &PagesPluginCapability::get_icon)
        .def("on_message", &PagesPluginCapability::on_message)
        .def(
            "post_message",
            [](PagesPluginCapability& capability, py::object data) {
                capability.post_message(py_to_json(data).dump());
            },
            py::arg("data"), "Send a JSON-compatible value to the page's window.orca.onMessage handlers.");
}

References get_icon(), get_type(), get_ui(), Slic3r::module(), on_message(), post_message(), and Slic3r::py_to_json().

Referenced by Slic3r::bind_python_api().

Here is the call graph for this function:

Here is the caller graph for this function:

set_audit_plugin_key()

void Slic3r::PluginCapabilityInterface::set_audit_plugin_key ( std::string key )

inlineinherited

{ m_audit_plugin_key = std::move(key); }

References m_audit_plugin_key.

set_config_ui_available()

void Slic3r::PluginCapabilityInterface::set_config_ui_available ( bool available )

inlineinherited

{ m_config_ui_available = available; }

References m_config_ui_available.

set_enabled()

void Slic3r::PluginCapabilityInterface::set_enabled ( bool enabled )

inlineinherited

{ m_enabled.store(enabled, std::memory_order_release); }

References m_enabled.

set_message_sender()

void Slic3r::PagesPluginCapability::set_message_sender

(

std::function< void(const std::string &)>

sender

)

{
    std::lock_guard<std::mutex> lock(m_message_mutex);
    m_message_sender = std::move(sender);
}

References m_message_mutex, and m_message_sender.

set_resolved_identity()

void Slic3r::PluginCapabilityInterface::set_resolved_identity ( std::string name, PluginCapabilityType type )

inlineinherited

    {
        m_name = std::move(name);
        m_type = type;
    }

References m_name, m_type, name(), and type().

Here is the call graph for this function:

type()

PluginCapabilityType Slic3r::PluginCapabilityInterface::type ( ) const

inlineinherited

{ return m_type; }

References m_type.

Referenced by set_resolved_identity().

Here is the caller graph for this function:

Member Data Documentation

m_audit_plugin_key

std::string Slic3r::PluginCapabilityInterface::m_audit_plugin_key

privateinherited

Referenced by audit_plugin_key(), identity(), and set_audit_plugin_key().

m_config_ui_available

bool Slic3r::PluginCapabilityInterface::m_config_ui_available = false

privateinherited

Referenced by config_ui_available(), and set_config_ui_available().

m_enabled

std::atomic<bool> Slic3r::PluginCapabilityInterface::m_enabled {true}

privateinherited

{true};

Referenced by is_enabled(), and set_enabled().

m_message_mutex

std::mutex Slic3r::PagesPluginCapability::m_message_mutex

mutableprivate

Referenced by clear_message_sender(), post_message(), and set_message_sender().

m_message_sender

std::function<void(const std::string&)> Slic3r::PagesPluginCapability::m_message_sender

private

Referenced by clear_message_sender(), post_message(), and set_message_sender().

m_name

std::string Slic3r::PluginCapabilityInterface::m_name

privateinherited

Referenced by identity(), name(), and set_resolved_identity().

m_refs

std::atomic<int> Slic3r::PluginCapabilityInterface::m_refs {0}

mutableprivateinherited

{0};

Referenced by decrement(), increment(), and ref_count().

m_type

PluginCapabilityType Slic3r::PluginCapabilityInterface::m_type = PluginCapabilityType::Unknown

privateinherited

Referenced by identity(), set_resolved_identity(), and type().

---

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

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/plugin/pluginTypes/pages/PagesPluginCapability.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/plugin/pluginTypes/pages/PagesPluginCapability.cpp