robowflex::darts::LinePlotElement Class Reference

Line plot element. Displays an updated line graph of data. More...

#include <gui.h>

Inheritance diagram for robowflex::darts::LinePlotElement:

Public Member Functions
void	addPoint (float x)
	Add a point to the plot data. More...
void	render () const override
	Render method. Renders IMGUI contents. More...

Public Attributes
std::string	id {"##" + generateUUID()}
	Unique ID. More...
std::string	label {""}
	Plot Label. More...
std::string	units {""}
	Plot Units. More...
bool	show_min {false}
	Display minimum value under plot. More...
bool	show_max {false}
	Display maximum value under plot. More...
bool	show_avg {false}
	Display average value under plot. More...
bool	recent {true}
	Display most recent value on plot. More...
std::size_t	max_size {100}
	Maximum size of plot data. More...
Eigen::Vector3d	color {1., 1., 1.}
	Color of plot. More...

Private Member Functions
float	average () const
	Compute the average over the data. More...
float	minimum () const
	Compute the minimum over the data. More...
float	maximum () const
	Compute the maximum over the data. More...

Private Attributes
std::size_t	index {0}
	Index in data. More...
std::size_t	total_elements {0}
	Total elements inserted in data. More...
std::vector< float >	elements
	All data points. More...
float	latest
	Last input data point. More...

Detailed Description

Line plot element. Displays an updated line graph of data.

Definition at line 325 of file gui.h.

Member Function Documentation

addPoint()

void LinePlotElement::addPoint

(

float

x

)

Add a point to the plot data.

Parameters

[in]

x

Point to add.

Definition at line 323 of file gui.cpp.

{
    elements.resize(max_size);
    if (index >= max_size)
        index = 0;
 
    if (total_elements > max_size)
        total_elements = max_size;
 
    latest = elements[index++] = x;
    index = index % max_size;
 
    if (total_elements < max_size)
        total_elements++;
}

average()

float LinePlotElement::average ( ) const

private

Compute the average over the data.

Returns

The average.

Definition at line 298 of file gui.cpp.

{
    float avg = 0.;
    for (std::size_t i = 0; i < total_elements; ++i)
        avg += elements[i];
    avg /= (float)max_size;
    return avg;
}

maximum()

float LinePlotElement::maximum ( ) const

private

Compute the maximum over the data.

Returns

The maximum.

Definition at line 315 of file gui.cpp.

{
    float max = 0.;
    for (std::size_t i = 0; i < total_elements; ++i)
        max = (max < elements[i]) ? elements[i] : max;
    return max;
}

minimum()

float LinePlotElement::minimum ( ) const

private

Compute the minimum over the data.

Returns

The minimum.

Definition at line 307 of file gui.cpp.

{
    float min = (total_elements) ? std::numeric_limits<float>::max() : 0;
    for (std::size_t i = 0; i < total_elements; ++i)
        min = (min > elements[i]) ? elements[i] : min;
    return min;
}

render()

void LinePlotElement::render ( ) const

overridevirtual

Render method. Renders IMGUI contents.

Implements robowflex::darts::ImGuiElement.

Definition at line 339 of file gui.cpp.

{
    ImGui::PushID(id.c_str());
    ImGui::PushStyleColor(ImGuiCol_PlotLines,
                          (ImVec4)ImColor((float)color[0], (float)color[1], (float)color[2]));
 
    char overlay[64] = "N/A";
    if (total_elements)
        sprintf(overlay, "%.3f %s", latest, units.c_str());
 
    ImGui::PlotLines(label.c_str(), elements.data(), total_elements, index, overlay);
 
    ImGui::PopStyleColor(1);
    ImGui::PopID();
 
    if (show_min)
        ImGui::Text("min: %.3f %s", minimum(), units.c_str());
    if (show_avg)
        ImGui::Text("avg: %.3f %s", average(), units.c_str());
    if (show_max)
        ImGui::Text("max: %.3f %s", maximum(), units.c_str());
}

Member Data Documentation

color

Eigen::Vector3d robowflex::darts::LinePlotElement::color {1., 1., 1.}

Color of plot.

Definition at line 336 of file gui.h.

elements

std::vector<float> robowflex::darts::LinePlotElement::elements

private

All data points.

Definition at line 347 of file gui.h.

id

std::string robowflex::darts::LinePlotElement::id {"##" + generateUUID()}

Unique ID.

Definition at line 328 of file gui.h.

index

std::size_t robowflex::darts::LinePlotElement::index {0}

private

Index in data.

Definition at line 345 of file gui.h.

label

std::string robowflex::darts::LinePlotElement::label {""}

Plot Label.

Definition at line 329 of file gui.h.

latest

float robowflex::darts::LinePlotElement::latest

private

Last input data point.

Definition at line 348 of file gui.h.

max_size

std::size_t robowflex::darts::LinePlotElement::max_size {100}

Maximum size of plot data.

Definition at line 335 of file gui.h.

recent

bool robowflex::darts::LinePlotElement::recent {true}

Display most recent value on plot.

Definition at line 334 of file gui.h.

show_avg

bool robowflex::darts::LinePlotElement::show_avg {false}

Display average value under plot.

Definition at line 333 of file gui.h.

show_max

bool robowflex::darts::LinePlotElement::show_max {false}

Display maximum value under plot.

Definition at line 332 of file gui.h.

show_min

bool robowflex::darts::LinePlotElement::show_min {false}

Display minimum value under plot.

Definition at line 331 of file gui.h.

total_elements

std::size_t robowflex::darts::LinePlotElement::total_elements {0}

private

Total elements inserted in data.

Definition at line 346 of file gui.h.

units

std::string robowflex::darts::LinePlotElement::units {""}

Plot Units.

Definition at line 330 of file gui.h.

---

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

• gui.h
• gui.cpp