echomap::ProjectPanel Class Reference

Inheritance diagram for echomap::ProjectPanel:

Public Member Functions
	ProjectPanel (const Project *initial_project=nullptr)
	Create a new ProjectPanel to display Project metadata.
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::string	panel_name
const Project *	active_project = nullptr
std::vector< sigc::scoped_connection >	connections

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

Definition at line 19 of file ProjectPanel.hpp.

Constructor & Destructor Documentation

ProjectPanel()

echomap::ProjectPanel::ProjectPanel ( const Project * initial_project = nullptr )

explicit

Create a new ProjectPanel to display Project metadata.

Parameters

initial_project

An optional initial Project for the IPanel to describe.

Definition at line 16 of file ProjectPanel.cpp.

  :
    panel_name(std::string("Project Explorer") + get_imgui_stable_name()),
    active_project(initial_project)
{
}

Member Function Documentation

change_active_project()

void echomap::ProjectPanel::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 55 of file ProjectPanel.cpp.

{
    active_project = new_project;
}

draw()

void echomap::ProjectPanel::draw ( )

overridevirtualnoexcept

Draw the panel to the active rendering context.

Implements echomap::IPanel.

Definition at line 24 of file ProjectPanel.cpp.

{
    constexpr ImGuiTreeNodeFlags default_flags = ImGuiTreeNodeFlags_DefaultOpen;
 
    if (ImGui::Begin(panel_name.c_str())) {
        if (active_project == nullptr)
            ImGui::SeparatorText("No active project.");
        else {
            ImGui::SeparatorText(active_project->get_imgui_name());
            if (ImGui::CollapsingHeader("Signals", default_flags))
                for (const auto& signal : active_project->observe_signals())
                    ImGui::TextUnformatted(signal.get_imgui_name());
 
            if (ImGui::CollapsingHeader("Sensors", default_flags))
                for (const auto& sensor : active_project->observe_sensors())
                    ImGui::TextUnformatted(sensor.get_imgui_name());
 
            if (ImGui::CollapsingHeader("Results", default_flags)) {
                // TODO...
            }
        }
    }
 
    ImGui::End();
}

get_imgui_name()

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

{
    return panel_name.c_str();
}

get_imgui_stable_name()

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

staticnoexcept

Definition at line 62 of file ProjectPanel.cpp.

{
    return "###ProjectPanel";
}

Member Data Documentation

active_project

const Project* echomap::ProjectPanel::active_project = nullptr

private

Definition at line 40 of file ProjectPanel.hpp.

connections

std::vector<sigc::scoped_connection> echomap::ProjectPanel::connections

private

Definition at line 41 of file ProjectPanel.hpp.

panel_name

std::string echomap::ProjectPanel::panel_name

private

Definition at line 38 of file ProjectPanel.hpp.

---

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

• src/panels/ProjectPanel.hpp
• src/panels/ProjectPanel.cpp