echomap::MapSourcesModal Class Reference

Provides a modal IPanel to map externally sourced Signal objects to separately uploaded files. More...

#include <MapSourcesModal.hpp>

Inheritance diagram for echomap::MapSourcesModal:

Public Member Functions
	MapSourcesModal (EchoMap *app, const PartialProject *project)
void	draw () noexcept override
	Draw the panel to the active rendering context.
const char *	get_imgui_name () const noexcept override
	Retrieves the name of the IPanel for Dear ImGui API functions.
void	reshow () noexcept
void	change_active_project (const PartialProject *new_project) override
	Do nothing.
Public Member Functions inherited from echomap::IPanel
virtual void	update_gpu (const wgpu::CommandEncoder &command_encoder)
	Delegate work to the GPU via the WebGPU platform.

Static Public Member Functions
static const char *	get_imgui_stable_name () noexcept

Private Member Functions
void	draw_preamble () const noexcept
bool	draw_table_entry (const std::filesystem::path &external_path, const std::optional< std::filesystem::path > &vfs_path, SignalFactoryRange auto &&factories) const noexcept
void	draw_buttons (bool are_all_mapped)

Private Attributes
std::string	panel_name
EchoMap *	app
const PartialProject *	project
bool	should_open = true

Static Private Attributes
static constexpr ImVec2	upload_button_frame_padding {0.0f, 0.0f}
static constexpr ImVec2	default_modal_size {500.0f, 300.0f}

Additional Inherited Members
Static Protected Attributes inherited from echomap::IPanel
static constexpr ImVec2	button_size {80.0f, 20.0f}
static constexpr auto	table_flags

Detailed Description

Provides a modal IPanel to map externally sourced Signal objects to separately uploaded files.

This is most useful in browser (WebAssembly VFS) contexts where the application cannot interrogate the file system directly.

Definition at line 34 of file MapSourcesModal.hpp.

Constructor & Destructor Documentation

MapSourcesModal()

echomap::MapSourcesModal::MapSourcesModal ( EchoMap * app, const PartialProject * project )

explicit

Definition at line 21 of file MapSourcesModal.cpp.

  :
    panel_name(std::string("Upload External Files") + get_imgui_stable_name()),
    app(app),
    project(project)
{
}

Member Function Documentation

change_active_project()

void echomap::MapSourcesModal::change_active_project ( const PartialProject * new_project )

overridevirtual

Do nothing.

THe active Project may be changed in the background, but that shouldn't interfere with an active modal. This modal will also typically relate to an unloaded (or partially loaded) Project, not the active one.

Parameters

new_project

Ignored.

Implements echomap::IWebPanel.

Definition at line 91 of file MapSourcesModal.cpp.

{
    std::ignore = new_project;
}

draw()

void echomap::MapSourcesModal::draw ( )

overridevirtualnoexcept

Draw the panel to the active rendering context.

Implements echomap::IPanel.

Definition at line 31 of file MapSourcesModal.cpp.

{
    if (project->observe_unloaded_signals().empty())
        return;
 
    if (std::exchange(should_open, false))
        ImGui::OpenPopup(get_imgui_name());
 
    ImGui::SetNextWindowSize(default_modal_size, ImGuiCond_Appearing);
 
    if (ImGui::BeginPopupModal(
                get_imgui_name(), nullptr,
                ImGuiWindowFlags_AlwaysAutoResize
        )) {
        ImGui::PushID("UploadExternalModal");
 
        draw_preamble();
 
        // The remaining number of signals for which there is no given path in VFS, decremented as we enumerate.
        auto unmapped_count = project->observe_unloaded_signals().size();
 
        if (ImGui::BeginTable("##UploadTable", 5, table_flags)) {
            ImGui::TableSetupColumn("##UploadButton", ImGuiTableColumnFlags_WidthFixed, button_size.x);
            ImGui::TableSetupColumn("Indicated Path", ImGuiTableColumnFlags_WidthStretch);
            ImGui::TableSetupColumn("Signal Name", ImGuiTableColumnFlags_WidthStretch);
            ImGui::TableSetupColumn("Channel Number", ImGuiTableColumnFlags_WidthStretch);
            ImGui::TableSetupColumn("Given Path", ImGuiTableColumnFlags_WidthStretch);
            ImGui::TableHeadersRow();
 
            for (const auto& [external_path, mapping_info] : project->observe_unloaded_signals())
                if (draw_table_entry(
                            external_path,
                            mapping_info.first,
                            std::views::transform(mapping_info.second, [](const std::unique_ptr<SignalFactory>& ptr) {
                                return ptr.get();
                            })
                    ))
 
                    --unmapped_count;
 
            ImGui::EndTable();
        }
 
        draw_buttons(unmapped_count == 0);
 
        ImGui::PopID();
        ImGui::EndPopup();
    }
}

draw_buttons()

void echomap::MapSourcesModal::draw_buttons ( bool are_all_mapped )

private

Definition at line 124 of file MapSourcesModal.cpp.

{
    ImGui::Spacing();
    ImGui::Separator();
    ImGui::Spacing();
 
    if (ImGui::Button("Cancel", button_size)) {
        app->notify(CancelProjectLoadNotification(project->get_id()));
        ImGui::CloseCurrentPopup();
        should_open = false;
    }
 
    ImGui::SameLine();
 
    if (are_all_mapped) {
        if (ImGui::Button("Continue", button_size)) {
            app->notify(CompleteProjectLoadNotification(project->get_id()));
            ImGui::CloseCurrentPopup();
        }
    } else {
        ImGui::BeginDisabled();
        ImGui::Button("Continue", button_size);
        ImGui::SetItemTooltip("To continue, provide mappings for all unloaded externally sourced signals.");
        ImGui::EndDisabled();
    }
}

draw_preamble()

void echomap::MapSourcesModal::draw_preamble ( ) const

privatenoexcept

Definition at line 103 of file MapSourcesModal.cpp.

{
    ImGui::TextWrapped(
                "%s contains references to externally sourced signals. Browser security requires that each externally "
                "sourced file is uploaded separately.",
                project->get_imgui_name()
        );
 
    ImGui::Spacing();
    ImGui::Separator();
 
    ImGui::TextWrapped(
            "Upload all missing files to complete the mapping, and press Continue.\n\nCancelling the operation "
            "will abort the load and revert back to the previously loaded project, if applicable."
    );
 
    ImGui::Spacing();
    ImGui::Separator();
    ImGui::Spacing();
}

draw_table_entry()

bool echomap::MapSourcesModal::draw_table_entry ( const std::filesystem::path & external_path, const std::optional< std::filesystem::path > & vfs_path, SignalFactoryRange auto && factories ) const

privatenoexcept

Definition at line 153 of file MapSourcesModal.cpp.

{
    ImGui::PushID(external_path.c_str());
    ImGui::TableNextRow();
    ImGui::TableNextColumn();
 
    const auto& padding = ImGui::GetStyle().CellPadding;
    ImGui::SetCursorPos({ImGui::GetCursorPosX() - padding.x, ImGui::GetCursorPosY() - padding.y});
    ImGui::PushStyleVar(ImGuiStyleVar_FramePadding, upload_button_frame_padding);
 
    if (ImGui::Button("Upload", ImVec2(button_size.x + 2 * padding.x, button_size.y)))
        ActionController::register_vfs_mapping(project->get_id(), external_path);
 
    ImGui::PopStyleVar();
 
    ImGui::TableNextColumn();
    ImGui::TextUnformatted(external_path.c_str());
 
    bool is_first = true;
    bool is_mapped = false;
 
    for (const auto signal_factory : factories | std::views::filter([](auto&& ptr) {
                                         return ptr;
                                     })) {
        if (!is_first)
            ImGui::TableNextRow();
 
        ImGui::TableSetColumnIndex(2);
 
        const auto& signal = signal_factory->observe_signal();
        ImGui::PushID(signal.get_imgui_name());
 
        ImGui::TextUnformatted(signal.get_imgui_name());
        ImGui::TableNextColumn();
        const auto formatted_channel_num = std::to_string(signal.observe_source()->channel);
        ImGui::TextUnformatted(formatted_channel_num.c_str());
        ImGui::TableNextColumn();
 
        if (is_first) {
            const auto& given_path = vfs_path;
            if (given_path.has_value()) {
                ImGui::TextUnformatted(given_path->c_str());
                is_mapped = true;
            } else
                ImGui::TextUnformatted("Not provided");
 
            is_first = false;
        }
 
        ImGui::PopID();
    }
 
    ImGui::PopID();
    return is_mapped;
}

get_imgui_name()

const char * echomap::MapSourcesModal::get_imgui_name ( ) const

nodiscardoverridevirtualnoexcept

Retrieves the name of the IPanel for Dear ImGui API functions.

Returns

The human-readable name of the window as a NULL-terminated C string.

Implements echomap::IPanel.

Definition at line 81 of file MapSourcesModal.cpp.

{
    return panel_name.c_str();
}

get_imgui_stable_name()

const char * echomap::MapSourcesModal::get_imgui_stable_name ( )

staticnoexcept

Definition at line 98 of file MapSourcesModal.cpp.

{
    return "###IndividualUploadModal";
}

reshow()

void echomap::MapSourcesModal::reshow ( )

noexcept

Definition at line 86 of file MapSourcesModal.cpp.

{
    should_open = true;
}

Member Data Documentation

app

EchoMap* echomap::MapSourcesModal::app

private

Definition at line 75 of file MapSourcesModal.hpp.

default_modal_size

ImVec2 echomap::MapSourcesModal::default_modal_size {500.0f, 300.0f}

staticconstexprprivate

Definition at line 62 of file MapSourcesModal.hpp.

{500.0f, 300.0f};

panel_name

std::string echomap::MapSourcesModal::panel_name

private

Definition at line 74 of file MapSourcesModal.hpp.

project

const PartialProject* echomap::MapSourcesModal::project

private

Definition at line 76 of file MapSourcesModal.hpp.

should_open

bool echomap::MapSourcesModal::should_open = true

private

Definition at line 77 of file MapSourcesModal.hpp.

upload_button_frame_padding

ImVec2 echomap::MapSourcesModal::upload_button_frame_padding {0.0f, 0.0f}

staticconstexprprivate

Definition at line 61 of file MapSourcesModal.hpp.

{0.0f, 0.0f};

---

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

• src/panels/web/MapSourcesModal.hpp
• src/panels/web/MapSourcesModal.cpp