echomap::SensorGeometryPanel Class Reference

Provides a panel for defining and reviewing (in a 3D plot) positions of loaded Sensor objects in the active Project. More...

#include <SensorGeometryPanel.hpp>

Inheritance diagram for echomap::SensorGeometryPanel:

Public Member Functions
	SensorGeometryPanel (EchoMap *app, const Project *initial_project=nullptr)
	Create a new SensorGeometryPanel to plot and control Sensor information.
const char *	get_imgui_name () const noexcept override
	Retrieves the name of the IPanel for Dear ImGui API functions.
void	draw () noexcept override
	Draw the panel to the active rendering context.
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 Member Functions
void	recache_sensor_colours () noexcept
void	draw_geometry_summary () noexcept
void	draw_geometry_plot () const noexcept

Private Attributes
std::string	panel_name
std::vector< ImU32 >	sensor_colours
ImPlot3DSpec	plotting_spec_3d
const Project *	active_project = nullptr
EchoMap *	app
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

Provides a panel for defining and reviewing (in a 3D plot) positions of loaded Sensor objects in the active Project.

Definition at line 28 of file SensorGeometryPanel.hpp.

Constructor & Destructor Documentation

SensorGeometryPanel()

echomap::SensorGeometryPanel::SensorGeometryPanel ( EchoMap * app, const Project * initial_project = nullptr )

explicit

Create a new SensorGeometryPanel to plot and control Sensor information.

Parameters

app	The parent application instance.
initial_project	An optional initial Project for the IPanel to display.

Definition at line 19 of file SensorGeometryPanel.cpp.

  :
    panel_name(std::string("Sensor Geometry") + get_imgui_stable_name()),
    active_project(initial_project),
    app(app)
{
}

Member Function Documentation

change_active_project()

void echomap::SensorGeometryPanel::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 51 of file SensorGeometryPanel.cpp.

{
    active_project = new_project;
    sensor_colours.clear();
}

draw()

void echomap::SensorGeometryPanel::draw ( )

overridevirtualnoexcept

Draw the panel to the active rendering context.

Implements echomap::IPanel.

Definition at line 34 of file SensorGeometryPanel.cpp.

{
    if (ImGui::Begin(panel_name.c_str())) {
        if (active_project == nullptr)
            ImGui::Text("No project is loaded.");
        else if (active_project->get_sensors_count() == 0u)
            ImGui::Text("No sensors are loaded.");
        else {
            recache_sensor_colours();
            draw_geometry_summary();
            draw_geometry_plot();
        }
    }
 
    ImGui::End();
}

draw_geometry_plot()

void echomap::SensorGeometryPanel::draw_geometry_plot ( ) const

privatenoexcept

Definition at line 163 of file SensorGeometryPanel.cpp.

{
    ImGui::SeparatorText("Geometry Plot");
    ImPlot3D::PushStyleColor(ImPlot3DCol_FrameBg, ImVec4(0.0f, 0.0f, 0.0f, 0.0f));
 
    const auto avail_size = ImGui::GetContentRegionAvail();
    const float aspect_ratio = avail_size.x / avail_size.y;
 
    if (ImPlot3D::BeginPlot("##SensorGeometryPlot", ImVec2(-std::numeric_limits<float>::min(), avail_size.y))) {
        ImPlot3D::SetupBoxScale(aspect_ratio, 1.0f, 1.0f);
        ImPlot3D::SetupAxes("X", "Y", "Z");
        ImPlot3D::PlotScatterG(
                "",
                Project::get_sensor_point,
                active_project,
                static_cast<int>(active_project->get_sensors_count()),
                plotting_spec_3d
        );
 
        ImPlot3D::EndPlot();
    }
 
    ImPlot3D::PopStyleColor();
}

draw_geometry_summary()

void echomap::SensorGeometryPanel::draw_geometry_summary ( )

privatenoexcept

Definition at line 92 of file SensorGeometryPanel.cpp.

{
    ImGui::SeparatorText("Geometry Summary");
    if (ImGui::BeginTable("##GeometrySummary", 5, table_flags)) {
        ImGui::TableSetupColumn("##SensorColourColumn", ImGuiTableColumnFlags_WidthFixed);
        ImGui::TableSetupColumn("Sensor", ImGuiTableColumnFlags_WidthFixed);
        ImGui::TableSetupColumn("X Position", ImGuiTableColumnFlags_WidthStretch);
        ImGui::TableSetupColumn("Y Position", ImGuiTableColumnFlags_WidthStretch);
        ImGui::TableSetupColumn("Z Position", ImGuiTableColumnFlags_WidthStretch);
        ImGui::TableHeadersRow();
 
        std::size_t row_idx = 0;
 
        for (const auto& sensor : active_project->observe_sensors()) {
            ImGui::PushID(static_cast<int>(sensor.get_id()));
 
            ImGui::TableNextRow();
            ImGui::TableNextColumn();
 
            const ImVec4 colour = ImGui::ColorConvertU32ToFloat4(sensor_colours[row_idx]);
            std::array<float, 4> new_colour = {colour.x, colour.y, colour.z, colour.w};
            if (ImGui::ColorEdit4("##colour", new_colour.data(), ImGuiColorEditFlags_NoInputs)) {
                app->notify(ModifySensorColourNotification(
                        active_project->get_id(),
                        sensor.get_id(),
                        {
                                .r = new_colour[0],
                                .g = new_colour[1],
                                .b = new_colour[2],
                                .a = new_colour[3],
                        }
                ));
 
                sensor_colours[row_idx] = IM_COL32(
                        static_cast<int>(new_colour[0] * 255.0f),
                        static_cast<int>(new_colour[1] * 255.0f),
                        static_cast<int>(new_colour[2] * 255.0f),
                        static_cast<int>(new_colour[3] * 255.0f)
                );
            }
 
            ImGui::TableNextColumn();
            ImGui::SetNextItemWidth(-std::numeric_limits<float>::min());
            ImGui::TextUnformatted(sensor.get_imgui_name());
 
            Position new_position = sensor.position;
            bool position_changed = false;
 
            ImGui::TableNextColumn();
            ImGui::SetNextItemWidth(-std::numeric_limits<float>::min());
            position_changed = ImGui::InputFloat("##x", &new_position.x, 0.01f, 1.0f);
 
            ImGui::TableNextColumn();
            ImGui::SetNextItemWidth(-std::numeric_limits<float>::min());
            position_changed = ImGui::InputFloat("##y", &new_position.y, 0.01f, 1.0f) || position_changed;
 
            ImGui::TableNextColumn();
            ImGui::SetNextItemWidth(-std::numeric_limits<float>::min());
            position_changed = ImGui::InputFloat("##z", &new_position.z, 0.01f, 1.0f) || position_changed;
 
            ImGui::PopID();
            ++row_idx;
 
            if (position_changed)
                app->notify(ModifySensorPositionNotification(active_project->get_id(), sensor.get_id(), new_position));
        }
 
        ImGui::EndTable();
    }
}

get_imgui_name()

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

{
    return panel_name.c_str();
}

get_imgui_stable_name()

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

staticnoexcept

Definition at line 59 of file SensorGeometryPanel.cpp.

{
    return "###SensorGeometryPanel";
}

recache_sensor_colours()

void echomap::SensorGeometryPanel::recache_sensor_colours ( )

privatenoexcept

Definition at line 64 of file SensorGeometryPanel.cpp.

{
    if (active_project->get_sensors_count() != sensor_colours.size()) {
        // Ensure that we maintain the correct number of colours for the current number of sensors.
        try {
            sensor_colours.resize(active_project->get_sensors_count());
            for (auto [src, dst] : std::views::zip(active_project->observe_sensors(), sensor_colours))
                dst = IM_COL32(
                        static_cast<int>(src.colour.r * 255.0f),
                        static_cast<int>(src.colour.g * 255.0f),
                        static_cast<int>(src.colour.b * 255.0f),
                        static_cast<int>(src.colour.a * 255.0f)
                );
        } catch (const std::exception& exception) {
            LOG_F_ERROR("Could not store the sensor colouring: {}", exception.what());
            plotting_spec_3d.MarkerFillColors = nullptr;
            plotting_spec_3d.MarkerLineColors = nullptr;
            plotting_spec_3d.MarkerFillColor = ImVec4(255.0f, 255.0f, 255.0f, 255.0f);
            plotting_spec_3d.MarkerLineColor = IMPLOT_AUTO_COL;
            return;
        }
 
        // ... and update the plotting specification in case the resize invalidated pointers.
        plotting_spec_3d.MarkerFillColors = &*sensor_colours.begin();
        plotting_spec_3d.MarkerLineColors = plotting_spec_3d.MarkerFillColors;
    }
}

Member Data Documentation

active_project

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

private

Definition at line 59 of file SensorGeometryPanel.hpp.

app

EchoMap* echomap::SensorGeometryPanel::app

private

Definition at line 60 of file SensorGeometryPanel.hpp.

connections

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

private

Definition at line 61 of file SensorGeometryPanel.hpp.

panel_name

std::string echomap::SensorGeometryPanel::panel_name

private

Definition at line 55 of file SensorGeometryPanel.hpp.

plotting_spec_3d

ImPlot3DSpec echomap::SensorGeometryPanel::plotting_spec_3d

private

Definition at line 58 of file SensorGeometryPanel.hpp.

sensor_colours

std::vector<ImU32> echomap::SensorGeometryPanel::sensor_colours

private

Definition at line 57 of file SensorGeometryPanel.hpp.

---

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

• src/panels/SensorGeometryPanel.hpp
• src/panels/SensorGeometryPanel.cpp