Slic3r::PluginResourceTextures Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/plugin/host/PluginResourceTextures.hpp>

Collaboration diagram for Slic3r::PluginResourceTextures:

Public Member Functions
	PluginResourceTextures (const PluginResourceTextures &)=delete
PluginResourceTextures &	operator= (const PluginResourceTextures &)=delete
void	on_plugin_register (const std::string &plugin_key)
void	on_plugin_deregister (const std::string &plugin_key)
void	on_cap_register (const PluginCapabilityId &id)
void	on_cap_deregister (const PluginCapabilityId &id)
void	initial_sweep ()
std::vector< ResourceTextureEntry >	entries () const

Static Public Member Functions
static PluginResourceTextures &	instance ()

Private Member Functions
	PluginResourceTextures ()=default
std::optional< ResourceTextureEntry >	build_entry (const PluginCapabilityId &id) const

Private Attributes
std::mutex	m_mutex
std::map< PluginCapabilityId, ResourceTextureEntry >	m_entries

Detailed Description

Constructor & Destructor Documentation

PluginResourceTextures() [1/2]

Slic3r::PluginResourceTextures::PluginResourceTextures ( const PluginResourceTextures & )

delete

References PluginResourceTextures().

Referenced by PluginResourceTextures(), instance(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

PluginResourceTextures() [2/2]

Slic3r::PluginResourceTextures::PluginResourceTextures ( )

privatedefault

Member Function Documentation

build_entry()

std::optional< ResourceTextureEntry > Slic3r::PluginResourceTextures::build_entry ( const PluginCapabilityId & id ) const

private

{
    // Query by id and re-check state; the manager copies the shared_ptr and releases its lock.
    auto capability = PluginManager::instance().get_plugin_capability(id, /*only_enabled=*/false);
    if (!capability || !capability->is_enabled() || capability->type() != PluginCapabilityType::ResourceTexture)
        return std::nullopt;
 
    auto texture_capability = std::dynamic_pointer_cast<ResourceTexturePluginCapability>(capability);
    if (!texture_capability)
        return std::nullopt;
 
    // An empty directory means resolution failed at load, so the pack contributes nothing.
    const std::string &texture_dir = texture_capability->texture_dir();
    if (texture_dir.empty())
        return std::nullopt;
 
    PluginDescriptor descriptor;
    if (!PluginManager::instance().try_get_plugin_descriptor_for_capability(capability->name(),
                                                                            PluginCapabilityType::ResourceTexture,
                                                                            descriptor))
        return std::nullopt;
 
    ResourceTextureEntry entry;
    entry.id           = capability->identity();
    entry.plugin_key   = entry.id.plugin_key;
    entry.display_name = capability->name();
    entry.texture_dir  = texture_dir;
    entry.plugin_root  = descriptor.plugin_root;
    return entry;
}

References Slic3r::ResourceTextureEntry::display_name, Slic3r::PluginManager::get_plugin_capability(), Slic3r::ResourceTextureEntry::id, Slic3r::PluginManager::instance(), Slic3r::PluginCapabilityId::plugin_key, Slic3r::ResourceTextureEntry::plugin_key, Slic3r::PluginDescriptor::plugin_root, Slic3r::ResourceTextureEntry::plugin_root, Slic3r::ResourceTexture, and Slic3r::ResourceTextureEntry::texture_dir.

Referenced by initial_sweep(), and on_cap_register().

Here is the call graph for this function:

Here is the caller graph for this function:

entries()

std::vector< ResourceTextureEntry > Slic3r::PluginResourceTextures::entries

(

)

const

{
    std::lock_guard<std::mutex> lock(m_mutex);
 
    std::vector<ResourceTextureEntry> result;
    result.reserve(m_entries.size());
    for (const auto &entry : m_entries)
        result.push_back(entry.second);
    return result;
}

References m_entries, and m_mutex.

Referenced by initial_sweep().

Here is the caller graph for this function:

initial_sweep()

void Slic3r::PluginResourceTextures::initial_sweep

(

)

{
    std::map<PluginCapabilityId, ResourceTextureEntry> entries;
    for (const auto &capability : PluginManager::instance().get_plugin_capabilities("", PluginCapabilityType::ResourceTexture)) {
        if (!capability)
            continue;
        std::optional<ResourceTextureEntry> entry = build_entry(capability->identity());
        if (entry)
            entries[entry->id] = std::move(*entry);
    }
 
    std::lock_guard<std::mutex> lock(m_mutex);
    m_entries = std::move(entries);
}

References build_entry(), entries(), Slic3r::PluginManager::instance(), m_entries, m_mutex, and Slic3r::ResourceTexture.

Here is the call graph for this function:

instance()

PluginResourceTextures & Slic3r::PluginResourceTextures::instance ( )

static

{
    static PluginResourceTextures registry;
    return registry;
}

References PluginResourceTextures().

Referenced by Slic3r::GUI::GUI_App::init_plugin_gui_wiring(), and Slic3r::GUI::anonymous_namespace{TextureLibrary.cpp}::scan_plugin_textures().

Here is the call graph for this function:

Here is the caller graph for this function:

on_cap_deregister()

void Slic3r::PluginResourceTextures::on_cap_deregister

(

const PluginCapabilityId &

id

)

{
    std::lock_guard<std::mutex> lock(m_mutex);
    m_entries.erase(id);
}

References m_entries, and m_mutex.

on_cap_register()

void Slic3r::PluginResourceTextures::on_cap_register

(

const PluginCapabilityId &

id

)

{
    std::optional<ResourceTextureEntry> entry = build_entry(id);
 
    std::lock_guard<std::mutex> lock(m_mutex);
    if (entry)
        m_entries[entry->id] = std::move(*entry);
}

References build_entry(), m_entries, and m_mutex.

Referenced by on_plugin_register().

Here is the call graph for this function:

Here is the caller graph for this function:

on_plugin_deregister()

void Slic3r::PluginResourceTextures::on_plugin_deregister

(

const std::string &

plugin_key

)

{
    std::lock_guard<std::mutex> lock(m_mutex);
    for (auto it = m_entries.begin(); it != m_entries.end();) {
        if (it->first.plugin_key == plugin_key)
            it = m_entries.erase(it);
        else
            ++it;
    }
}

References m_entries, and m_mutex.

on_plugin_register()

void Slic3r::PluginResourceTextures::on_plugin_register

(

const std::string &

plugin_key

)

{
    for (const auto &capability : PluginManager::instance().get_plugin_capabilities(plugin_key, PluginCapabilityType::ResourceTexture)) {
        if (capability)
            on_cap_register(capability->identity());
    }
}

References Slic3r::PluginManager::instance(), on_cap_register(), and Slic3r::ResourceTexture.

Here is the call graph for this function:

operator=()

PluginResourceTextures & Slic3r::PluginResourceTextures::operator= ( const PluginResourceTextures & )

delete

References PluginResourceTextures().

Here is the call graph for this function:

Member Data Documentation

m_entries

std::map<PluginCapabilityId, ResourceTextureEntry> Slic3r::PluginResourceTextures::m_entries

private

Referenced by entries(), initial_sweep(), on_cap_deregister(), on_cap_register(), and on_plugin_deregister().

m_mutex

std::mutex Slic3r::PluginResourceTextures::m_mutex

mutableprivate

Referenced by entries(), initial_sweep(), on_cap_deregister(), on_cap_register(), and on_plugin_deregister().

---

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

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/plugin/host/PluginResourceTextures.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/plugin/host/PluginResourceTextures.cpp