echomap::FileChooser Class Reference

Modal containing controls for interactively selecting a file from the file-system. More...

#include <FileChooser.hpp>

Inheritance diagram for echomap::FileChooser:

Public Member Functions
	FileChooser (EchoMap *app, RaiseFileChooserNotification::SuccessCallbackT &&success_callback, RaiseFileChooserNotification::CancelledCallbackT &&cancelled_callback)
	Create a new FileChooser modal for the given EchoMap instance.
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	change_active_project (const Project *new_project) override
	Updates the active Project being described by the IPanel.
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 Attributes
std::filesystem::path	expected_extension = ".json"
std::filesystem::path	chosen_path
FilesystemCombo	file_combo
std::string	panel_name
bool	is_open = false
EchoMap *	app
RaiseFileChooserNotification::SuccessCallbackT	success_callback
RaiseFileChooserNotification::CancelledCallbackT	cancelled_callback

Static Private Attributes
static constexpr ImVec2	default_modal_size {500.0f, 0.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

Modal containing controls for interactively selecting a file from the file-system.

Definition at line 31 of file FileChooser.hpp.

Constructor & Destructor Documentation

FileChooser()

echomap::FileChooser::FileChooser ( EchoMap * app, RaiseFileChooserNotification::SuccessCallbackT && success_callback, RaiseFileChooserNotification::CancelledCallbackT && cancelled_callback )

explicit

Create a new FileChooser modal for the given EchoMap instance.

Parameters

app	The owning EchoMap instance.
success_callback	The slot to invoke with the path once a file has been selected.
cancelled_callback	The slot to invoke if the operation is cancelled.

Definition at line 19 of file FileChooser.cpp.

  :
    file_combo(app),
    panel_name(std::string("Select File to Open") + get_imgui_stable_name()),
    app(app),
    success_callback(std::move(success_callback)),
    cancelled_callback(std::move(cancelled_callback))
{
}

Member Function Documentation

change_active_project()

void echomap::FileChooser::change_active_project ( const Project * new_project )

overridevirtual

Updates the active Project being described by the IPanel.

Parameters

new_project

An observing pointer to the new active Project.

Implements echomap::IProjectPanel.

Definition at line 76 of file FileChooser.cpp.

{
    std::ignore = new_project;
}

draw()

void echomap::FileChooser::draw ( )

overridevirtualnoexcept

Draw the panel to the active rendering context.

Implements echomap::IPanel.

Definition at line 32 of file FileChooser.cpp.

{
    if (!std::exchange(is_open, true))
        ImGui::OpenPopup(get_imgui_name());
 
    ImGui::SetNextWindowSize(default_modal_size, ImGuiCond_Appearing);
 
    if (ImGui::BeginPopupModal(get_imgui_name(), nullptr, ImGuiWindowFlags_AlwaysAutoResize)) {
        ImGui::PushID(get_imgui_name());
 
        if (file_combo(chosen_path))
            LOG_F_DEBUG("Changed: {}", chosen_path.c_str());
 
        ImGui::Spacing();
        ImGui::Separator();
        ImGui::Spacing();
 
        if (ImGui::Button("Cancel", button_size)) {
            ImGui::CloseCurrentPopup();
            cancelled_callback();
        }
 
        ImGui::SameLine();
 
        if (chosen_path.extension() == expected_extension) {
            if (ImGui::Button("OK", button_size))
                success_callback(chosen_path);
        } else {
            ImGui::BeginDisabled();
            ImGui::Button("OK", button_size);
            ImGui::SetItemTooltip("To continue, select a JSON EchoMap project file.");
            ImGui::EndDisabled();
        }
 
        ImGui::PopID();
        ImGui::EndPopup();
    }
}

get_imgui_name()

const char * echomap::FileChooser::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 71 of file FileChooser.cpp.

{
    return panel_name.c_str();
}

get_imgui_stable_name()

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

staticnoexcept

Definition at line 83 of file FileChooser.cpp.

{
    return "###FileChooser";
}

Member Data Documentation

app

EchoMap* echomap::FileChooser::app

private

Definition at line 64 of file FileChooser.hpp.

cancelled_callback

RaiseFileChooserNotification::CancelledCallbackT echomap::FileChooser::cancelled_callback

private

Definition at line 66 of file FileChooser.hpp.

chosen_path

std::filesystem::path echomap::FileChooser::chosen_path

private

Definition at line 59 of file FileChooser.hpp.

default_modal_size

ImVec2 echomap::FileChooser::default_modal_size {500.0f, 0.0f}

staticconstexprprivate

Definition at line 56 of file FileChooser.hpp.

{500.0f, 0.0f};

expected_extension

std::filesystem::path echomap::FileChooser::expected_extension = ".json"

private

Definition at line 58 of file FileChooser.hpp.

file_combo

FilesystemCombo echomap::FileChooser::file_combo

private

Definition at line 60 of file FileChooser.hpp.

is_open

bool echomap::FileChooser::is_open = false

private

Definition at line 63 of file FileChooser.hpp.

panel_name

std::string echomap::FileChooser::panel_name

private

Definition at line 62 of file FileChooser.hpp.

success_callback

RaiseFileChooserNotification::SuccessCallbackT echomap::FileChooser::success_callback

private

Definition at line 65 of file FileChooser.hpp.

---

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

• src/panels/native/FileChooser.hpp
• src/panels/native/FileChooser.cpp