echomap::ErrorModal Class Reference

Provides a persistent ImGui state to raise errors as a modal. More...

#include <ErrorModal.hpp>

Inheritance diagram for echomap::ErrorModal:

Public Member Functions
	ErrorModal (std::string_view message, DismissedCallbackT &&dismissed_callback)
	Raise the modal given a simple unformatted message.
	ErrorModal (std::string_view new_prefix, const std::runtime_error &exception, DismissedCallbackT &&dismissed_callback)
	Raise the modal given a prefix and a detailed exception.
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.
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 Types
using	DismissedCallbackT = sigc::slot<void()>

Private Attributes
std::string	prefix = "An unknown error occurred."
std::optional< std::string >	detail
std::string	panel_name
DismissedCallbackT	dismissed_callback

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 persistent ImGui state to raise errors as a modal.

Error modals provide a message, an optional detail string derived from an exception, and a single button to dismiss the modal.

Definition at line 26 of file ErrorModal.hpp.

Member Typedef Documentation

DismissedCallbackT

using echomap::ErrorModal::DismissedCallbackT = sigc::slot<void()>

private

Definition at line 28 of file ErrorModal.hpp.

Constructor & Destructor Documentation

ErrorModal() [1/2]

echomap::ErrorModal::ErrorModal ( std::string_view message, DismissedCallbackT && dismissed_callback )

explicit

Raise the modal given a simple unformatted message.

Parameters

message	The unformatted string literal to display.
dismissed_callback	Callback to invoke when the ErrorModal is cancelled.

Definition at line 17 of file ErrorModal.cpp.

  :
    panel_name(std::string("Error!") + get_imgui_stable_name()),
    dismissed_callback(std::move(dismissed_callback))
{
    try {
        prefix = message;
    } catch (const std::exception&) {
        LOG_ERROR("Could not allocate memory to display modal on UI.");
        return;
    }
}

ErrorModal() [2/2]

echomap::ErrorModal::ErrorModal	(	std::string_view	new_prefix,
		const std::runtime_error &	exception,
		DismissedCallbackT &&	dismissed_callback )

Raise the modal given a prefix and a detailed exception.

Parameters

new_prefix	An unformatted string literal to display as the major text.
exception	An exception containing a message to display as the minor text.
dismissed_callback	Callback to invoke when the ErrorModal is cancelled.

Since this routine will often be called from exception handlers, it provides a no-exception guarantee (to prevent program termination). If a low-level system call fails, such as memory allocation to copy the error text, the exception is caught and logged with the system logger; the modal is not raised.

Definition at line 32 of file ErrorModal.cpp.

  :
    panel_name(std::string("Error!") + get_imgui_stable_name()),
    dismissed_callback(std::move(dismissed_callback))
{
    try {
        detail = exception.what();
        prefix = new_prefix;
    } catch (const std::exception&) {
        LOG_ERROR("Could not allocate memory to display modal on UI.");
        return;
    }
}

Member Function Documentation

draw()

void echomap::ErrorModal::draw ( )

overridevirtualnoexcept

Draw the panel to the active rendering context.

Implements echomap::IPanel.

Definition at line 49 of file ErrorModal.cpp.

{
    ImGui::OpenPopup(get_imgui_name());
    if (ImGui::BeginPopupModal(get_imgui_name(), nullptr, ImGuiWindowFlags_AlwaysAutoResize)) {
        ImGui::TextUnformatted(prefix.c_str());
        ImGui::Separator();
 
        if (detail.has_value()) {
            ImGui::TextWrapped("%s", detail->c_str());
            ImGui::Separator();
        }
 
        if (ImGui::Button("Dismiss", button_size)) {
            ImGui::CloseCurrentPopup();
            dismissed_callback();
        }
 
        ImGui::EndPopup();
    }
}

get_imgui_name()

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

{
    return panel_name.c_str();
}

get_imgui_stable_name()

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

staticnoexcept

Definition at line 75 of file ErrorModal.cpp.

{
    return "###ErrorModal";
}

Member Data Documentation

detail

std::optional<std::string> echomap::ErrorModal::detail

private

Definition at line 67 of file ErrorModal.hpp.

dismissed_callback

DismissedCallbackT echomap::ErrorModal::dismissed_callback

private

Definition at line 69 of file ErrorModal.hpp.

panel_name

std::string echomap::ErrorModal::panel_name

private

Definition at line 68 of file ErrorModal.hpp.

prefix

std::string echomap::ErrorModal::prefix = "An unknown error occurred."

private

Definition at line 66 of file ErrorModal.hpp.

---

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

• src/panels/ErrorModal.hpp
• src/panels/ErrorModal.cpp