Slic3r::GUI::TextureDisplacementPreviewJob Class Reference

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

Inheritance diagram for Slic3r::GUI::TextureDisplacementPreviewJob:

Collaboration diagram for Slic3r::GUI::TextureDisplacementPreviewJob:

Public Types
enum	JobPrepareState { PREPARE_STATE_DEFAULT = 0 , PREPARE_STATE_MENU = 1 }

Public Member Functions
	TextureDisplacementPreviewJob (TextureDisplacementPreviewInput &&input, uint64_t generation, std::shared_ptr< const std::atomic< uint64_t > > current_generation, std::function< void(std::vector< TextureDisplacementPreviewResult >, uint64_t)> on_finished)
void	process (Ctl &ctl) override
void	finalize (bool canceled, std::exception_ptr &eptr) override

Private Attributes
TextureDisplacementPreviewInput	m_input
uint64_t	m_generation
std::shared_ptr< const std::atomic< uint64_t > >	m_current_generation
std::vector< TextureDisplacementPreviewResult >	m_results
std::function< void(std::vector< TextureDisplacementPreviewResult >, uint64_t)>	m_on_finished

Detailed Description

Member Enumeration Documentation

JobPrepareState

enum Slic3r::GUI::Job::JobPrepareState

inherited

Enumerator
PREPARE_STATE_DEFAULT
PREPARE_STATE_MENU

                         {
        PREPARE_STATE_DEFAULT = 0,
        PREPARE_STATE_MENU = 1,
    };

Constructor & Destructor Documentation

TextureDisplacementPreviewJob()

Slic3r::GUI::TextureDisplacementPreviewJob::TextureDisplacementPreviewJob	(	TextureDisplacementPreviewInput &&	input,
		uint64_t	generation,
		std::shared_ptr< const std::atomic< uint64_t > >	current_generation,
		std::function< void(std::vector< TextureDisplacementPreviewResult >, uint64_t)>	on_finished )

    : m_input(std::move(input)), m_generation(generation), m_current_generation(std::move(current_generation)),
      m_on_finished(std::move(on_finished))
{
}

References m_current_generation, m_generation, m_input, and m_on_finished.

Member Function Documentation

finalize()

void Slic3r::GUI::TextureDisplacementPreviewJob::finalize ( bool canceled, std::exception_ptr & eptr )

overridevirtual

Reimplemented from Slic3r::GUI::Job.

{
    if (!m_on_finished)
        return;
    // The handler must run on *every* outcome, cancellation included, because the caller uses it to
    // clear its "a job is in flight" latch. Returning early on `canceled` - which is what a cancel_all()
    // from Plater (project load/close, app exit) delivers - left that latch stuck true and no preview
    // was ever queued again for the rest of the session. An empty result is the caller's signal that
    // nothing usable came back; it already handles that.
    if (canceled || eptr)
        m_on_finished({}, m_generation);
    else
        m_on_finished(std::move(m_results), m_generation);
}

References m_generation, m_on_finished, and m_results.

process()

void Slic3r::GUI::TextureDisplacementPreviewJob::process ( Ctl & ctl )

overridevirtual

Implements Slic3r::GUI::Job.

{
    // No ctl.update_status() anywhere in here on purpose - see the class comment. A preview is
    // invisible bookkeeping; the only thing on screen should be the preview itself.
 
    // Only ever touches m_input (captured by value before this job was queued) and local state -
    // never the live Model - so this is safe to run concurrently with the UI thread.
    //
    // The quantizers are built once for the whole run: the palette is the object's, not the part's,
    // and each one fills a colour lookup cube that costs tens of milliseconds.
    TextureColorRequest  color_request;
    TextureColorRequest *color = nullptr;
    if (!m_input.color.empty()) {
        color_request.quantize = GLGizmoTextureDisplacement::make_palette_quantizer(m_input.color.palette);
        if (!m_input.color.palette_pure.empty())
            color_request.quantize_pure = GLGizmoTextureDisplacement::make_palette_quantizer(m_input.color.palette_pure);
        color_request.despeckle_passes = m_input.color.despeckle_passes;
        if (color_request.quantize)
            color = &color_request;
    }
 
    // Bail the moment this preview stops being the current one: build_texture_displacement() then
    // returns an empty mesh, and finalize() drops the whole run rather than showing half of it.
    const auto still_wanted = [this, &ctl](int) {
        return !ctl.was_canceled() &&
               (!m_current_generation || m_current_generation->load() == m_generation);
    };
 
    m_results.resize(m_input.volumes.size());
    for (size_t i = 0; i < m_input.volumes.size(); ++i) {
        const TextureDisplacementPreviewVolume &volume = m_input.volumes[i];
        if (color != nullptr)
            color_request.out_triangle = &m_results[i].triangle_color;
        m_results[i].mesh = build_texture_displacement(volume.base_mesh, volume.layers, volume.facets_data,
                                                       volume.options, still_wanted, color, volume.volume_to_world,
                                                       nullptr, nullptr,
                                                       volume.model_uv.empty() ? nullptr : &volume.model_uv,
                                                       &volume.texture_anchor, volume.resting_drop);
        if (!still_wanted(0)) {
            m_results.clear();
            return;
        }
    }
}

References Slic3r::GUI::TextureDisplacementPreviewVolume::base_mesh, Slic3r::build_texture_displacement(), Slic3r::TextureColorRequest::despeckle_passes, Slic3r::GUI::TextureDisplacementPreviewVolume::facets_data, Slic3r::GUI::TextureDisplacementPreviewVolume::layers, m_current_generation, m_generation, m_input, m_results, Slic3r::GUI::GLGizmoTextureDisplacement::make_palette_quantizer(), Slic3r::GUI::TextureDisplacementPreviewVolume::model_uv, Slic3r::GUI::TextureDisplacementPreviewVolume::options, Slic3r::TextureColorRequest::out_triangle, Slic3r::TextureColorRequest::quantize, Slic3r::TextureColorRequest::quantize_pure, Slic3r::GUI::TextureDisplacementPreviewVolume::resting_drop, Slic3r::GUI::TextureDisplacementPreviewVolume::texture_anchor, Slic3r::GUI::TextureDisplacementPreviewVolume::volume_to_world, and Slic3r::GUI::Job::Ctl::was_canceled().

Here is the call graph for this function:

Member Data Documentation

m_current_generation

std::shared_ptr<const std::atomic<uint64_t> > Slic3r::GUI::TextureDisplacementPreviewJob::m_current_generation

private

Referenced by TextureDisplacementPreviewJob(), and process().

m_generation

uint64_t Slic3r::GUI::TextureDisplacementPreviewJob::m_generation

private

Referenced by TextureDisplacementPreviewJob(), finalize(), and process().

m_input

TextureDisplacementPreviewInput Slic3r::GUI::TextureDisplacementPreviewJob::m_input

private

Referenced by TextureDisplacementPreviewJob(), and process().

m_on_finished

std::function<void(std::vector<TextureDisplacementPreviewResult>, uint64_t)> Slic3r::GUI::TextureDisplacementPreviewJob::m_on_finished

private

Referenced by TextureDisplacementPreviewJob(), and finalize().

m_results

std::vector<TextureDisplacementPreviewResult> Slic3r::GUI::TextureDisplacementPreviewJob::m_results

private

Referenced by finalize(), and process().

---

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

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Jobs/TextureDisplacementPreviewJob.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Jobs/TextureDisplacementPreviewJob.cpp