#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/plugin/pluginTypes/slicingPipeline/SlicingPipelinePluginCapability.hpp>

Inheritance diagram for Slic3r::SlicingPipelinePluginCapability:

Collaboration diagram for Slic3r::SlicingPipelinePluginCapability:

Public Member Functions
PluginCapabilityType	get_type () const override
virtual ExecutionResult	execute (SlicingPipelineContext &ctx)=0
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::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

211{ return m_audit_plugin_key; }

Slic3r::PluginCapabilityInterface::m_audit_plugin_key

std::string m_audit_plugin_key

Definition PythonPluginInterface.hpp:222

References m_audit_plugin_key.

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

Here is the caller graph for this function:

◆ config_ui_available()

bool Slic3r::PluginCapabilityInterface::config_ui_available ( ) const

inlineinherited

205{ return m_config_ui_available; }

Slic3r::PluginCapabilityInterface::m_config_ui_available

bool m_config_ui_available

Definition PythonPluginInterface.hpp:221

References m_config_ui_available.

◆ decrement()

void Slic3r::PluginCapabilityInterface::decrement ( ) const

inlineinherited

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

Slic3r::PluginCapabilityInterface::m_refs

std::atomic< int > m_refs

Definition PythonPluginInterface.hpp:224

References m_refs.

◆ execute()

virtual ExecutionResult Slic3r::SlicingPipelinePluginCapability::execute ( SlicingPipelineContext & ctx )

pure virtual

Implemented in Slic3r::PySlicingPipelinePluginCapabilityTrampoline.

References Slic3r::module().

Referenced by RegisterBindings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 >.

164{ 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 >.

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

Referenced by Slic3r::bind_python_api().

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::SlicingPipelinePluginCapability::get_type ( ) const

inlineoverridevirtual

Reimplemented from Slic3r::PluginCapabilityInterface.

37{ return PluginCapabilityType::SlicingPipeline; }

Slic3r::PluginCapabilityType::SlicingPipeline

@ SlicingPipeline

Definition PythonPluginInterface.hpp:17

References Slic3r::SlicingPipeline.

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 >.

161{ return false; }

Referenced by Slic3r::bind_python_api().

Here is the caller graph for this function:

◆ identity()

PluginCapabilityId Slic3r::PluginCapabilityInterface::identity ( ) const

inlineinherited

189{ return {m_type, m_name, m_audit_plugin_key}; }

Slic3r::PluginCapabilityInterface::m_name

std::string m_name

Definition PythonPluginInterface.hpp:218

Slic3r::PluginCapabilityInterface::m_type

PluginCapabilityType m_type

Definition PythonPluginInterface.hpp:219

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

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

References m_refs.

◆ is_enabled()

bool Slic3r::PluginCapabilityInterface::is_enabled ( ) const

inlineinherited

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

Slic3r::PluginCapabilityInterface::m_enabled

std::atomic< bool > m_enabled

Definition PythonPluginInterface.hpp:220

References m_enabled.

◆ name()

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

inlineinherited

187{ 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 >.

174{}

◆ 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 >.

176{ (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 >.

172{}

Referenced by Slic3r::bind_python_api().

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 >.

173{}

Referenced by Slic3r::bind_python_api().

Here is the caller graph for this function:

◆ ref_count()

int Slic3r::PluginCapabilityInterface::ref_count ( ) const

inlineinherited

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

References m_refs.

◆ RegisterBindings()

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

static

                                                                        {
    auto slicing = module.def_submodule("slicing", "Slicing pipeline API (research/experimental).");
 
    py::enum_<SlicingPipelineStepPlugin>(slicing, "Step")
        .value("posSlice", SlicingPipelineStepPlugin::posSlice)
        .value("posPerimeters", SlicingPipelineStepPlugin::posPerimeters)
        .value("posEstimateCurledExtrusions", SlicingPipelineStepPlugin::posEstimateCurledExtrusions)
        .value("posPrepareInfill", SlicingPipelineStepPlugin::posPrepareInfill) // after prepare_infill, before make_fills: editing fill_surfaces here CASCADES
        .value("posInfill", SlicingPipelineStepPlugin::posInfill)          // after make_fills: editing fill_surfaces here does NOT regenerate the fills
        .value("posIroning", SlicingPipelineStepPlugin::posIroning)
        .value("posContouring", SlicingPipelineStepPlugin::posContouring)
        .value("posSupportMaterial", SlicingPipelineStepPlugin::posSupportMaterial)
        .value("posDetectOverhangsForLift", SlicingPipelineStepPlugin::posDetectOverhangsForLift)
        .value("posSimplifyPath", SlicingPipelineStepPlugin::posSimplifyPath) // covers all simplify sub-steps
        .value("psWipeTower", SlicingPipelineStepPlugin::psWipeTower)
        .value("psSkirtBrim", SlicingPipelineStepPlugin::psSkirtBrim)
        // Post-process seam: fires in the GUI export path AFTER the classic post_process scripts, on the
        // exported G-code file. Unlike every step above it is NOT fired by Print::process(): ctx.print and
        // ctx.object are None; instead ctx.gcode_path / ctx.host / ctx.output_name are set and the plugin
        // edits the file at ctx.gcode_path IN PLACE. May fire more than once per slice (file export and/or
        // upload each fire once, on separate working copies) and its output is not reflected in the G-code
        // preview (the viewer maps the pre-post-process file). ctx.config_value() still works.
        .value("psGCodePostProcess", SlicingPipelineStepPlugin::psGCodePostProcess)
        .export_values();
 
    // The read-graph data model (Surface / ExPolygon / the extrusion tree / LayerRegion /
    // Layer / PrintObject / Print) and the 2D-geometry mutators live in orca.host, registered
    // by PluginHostSlicing.cpp. orca.slicing is workflow-only: Step, unscale, the context, and
    // the capability base. See PluginHostSlicing.cpp for the mandatory reference-lifetime rule.
 
    // Scaled integer coordinate -> millimeters. Reads the live SCALING_FACTOR at call
    // time (1e-6 normal, 1e-5 for beds > 2147mm), so it is never cached.
    slicing.def("unscale", [](coord_t v) { return unscale<double>(v); }, py::arg("coord"),
        "Convert a scaled integer coordinate to millimeters (reads the live SCALING_FACTOR).");
 
    py::class_<SlicingPipelineContext>(slicing, "SlicingPipelineContext")
        .def_readonly("orca_version", &SlicingPipelineContext::orca_version)
        .def_readonly("step", &SlicingPipelineContext::step)
        .def_readonly("gcode_path", &SlicingPipelineContext::gcode_path,
            "Path to the working G-code file, set ONLY at Step.psGCodePostProcess. Edit it in "
            "place; empty at every other step.")
        .def_readonly("host", &SlicingPipelineContext::host,
            "Target host at Step.psGCodePostProcess (\"File\", \"OctoPrint\", ...); empty otherwise.")
        .def_readonly("output_name", &SlicingPipelineContext::output_name,
            "Final output G-code name at Step.psGCodePostProcess (mirrors SLIC3R_PP_OUTPUT_NAME); "
            "empty otherwise.")
        .def_property_readonly("print", [](const SlicingPipelineContext& ctx) -> py::object {
            if (ctx.print == nullptr)
                return py::none();
            return py::cast(ctx.print, py::return_value_policy::reference);
        }, "The orca.host.Print being sliced — the raw slicing graph, exactly what the "
           "C++ pipeline walks. Valid only during the execute(ctx) call. For mesh access "
           "use ctx.print.model() (the Print's snapshot), never orca.host.model().")
        .def_property_readonly("object", [](const SlicingPipelineContext& ctx) -> py::object {
            if (ctx.object == nullptr)
                return py::none();
            // The hook signature hands objects out as const; they are genuinely mutable
            // (owned by the Print), so the const_cast is safe — done once here at the
            // graph entry point so Python steps receive a mutable PrintObject.
            return py::cast(const_cast<PrintObject*>(ctx.object), py::return_value_policy::reference);
        }, "orca.host.PrintObject for object-scoped steps, or None for print-wide steps. "
           "Valid only during the execute(ctx) call.")
        .def("config_value", [](const SlicingPipelineContext& ctx, const std::string& key) -> py::object {
            // In-pipeline steps read the live Print's full config; at psGCodePostProcess (print == null)
            // fall back to the config the export path handed in.
            if (ctx.print != nullptr)
                return config_value_or_none(ctx.print->full_print_config(), key);
            if (ctx.full_config != nullptr)
                return config_value_or_none(*ctx.full_config, key);
            return py::none();
        }, py::arg("key"),
           "serialized value of a resolved (full) print config option for this slice, or "
           "None if absent. Shorthand for ctx.print.config_value(key).")
        .def("cancelled", &SlicingPipelineContext::cancelled);
 
    py::class_<SlicingPipelinePluginCapability, PluginCapabilityInterface,
               PySlicingPipelinePluginCapabilityTrampoline,
               std::shared_ptr<SlicingPipelinePluginCapability>>(slicing, "SlicingPipelineCapabilityBase")
        .def(py::init<>())
        .def("get_type", &SlicingPipelinePluginCapability::get_type)
        .def("execute", &SlicingPipelinePluginCapability::execute);
}

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

210{ 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

206{ m_config_ui_available = available; }

References m_config_ui_available.

◆ set_enabled()

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

inlineinherited

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

References m_enabled.

◆ 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

188{ 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

220{true};

Referenced by is_enabled(), and set_enabled().

◆ 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

224{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/slicingPipeline/SlicingPipelinePluginCapability.hpp
/home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/plugin/pluginTypes/slicingPipeline/SlicingPipelinePluginCapability.cpp

	OrcaSlicer latest OrcaSlicer

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ audit_plugin_key()

◆ config_ui_available()

◆ decrement()

◆ execute()

◆ get_config_ui()

◆ get_default_config()

◆ get_name()

◆ get_type()

◆ has_config_ui()

◆ identity()

◆ increment()

◆ is_enabled()

◆ name()

◆ on_cancelled()

◆ on_lifecycle_event()

◆ on_load()

◆ on_unload()

◆ ref_count()

◆ RegisterBindings()

◆ set_audit_plugin_key()

◆ set_config_ui_available()

◆ set_enabled()

◆ set_resolved_identity()

◆ type()

Member Data Documentation

◆ m_audit_plugin_key

◆ m_config_ui_available

◆ m_enabled

◆ m_name

◆ m_refs

◆ m_type