robowflex::darts::WindowWidget Class Reference

IMGUI widget to add interactive GUI elements programmatically. More...

#include <gui.h>

Inheritance diagram for robowflex::darts::WindowWidget:

Public Member Functions
	WindowWidget ()
	Constructor. More...
void	render () override
	Render GUI. More...
Element Addition
void	addText (const std::string &text)
	Add a new text element to the GUI. More...
void	addCheckbox (const std::string &text, bool &boolean)
	Add a new checkbox element to the GUI. More...
void	addButton (const std::string &text, const ButtonCallback &callback)
	Add a new button element to the GUI. More...
void	addCallback (const RenderCallback &callback)
	Add a generic render callback for the GUI. More...
void	addElement (const ImGuiElementPtr &element)
	Add a generic element to the GUI. More...
Public Member Functions inherited from robowflex::darts::Widget
virtual void	initialize (Window *window)
	Initialization with window context. More...
virtual void	prerefresh ()
	Called before window refresh. More...

Private Attributes
std::vector< ImGuiElementPtr >	elements_
	GUI elements. More...

Detailed Description

IMGUI widget to add interactive GUI elements programmatically.

Definition at line 368 of file gui.h.

Constructor & Destructor Documentation

WindowWidget()

WindowWidget::WindowWidget

(

)

Constructor.

Definition at line 362 of file gui.cpp.

{
}

Member Function Documentation

addButton()

void WindowWidget::addButton	(	const std::string &	text,
		const ButtonCallback &	callback
	)

Add a new button element to the GUI.

Parameters

[in]	text	Text to display on the button.
[in]	callback	Callback upon button press.

Definition at line 388 of file gui.cpp.

{
    addElement(std::make_shared<ButtonElement>(text, callback));
}

addCallback()

void WindowWidget::addCallback

(

const RenderCallback &

callback

)

Add a generic render callback for the GUI.

Parameters

[in]

callback

Callback to render.

Definition at line 398 of file gui.cpp.

{
    addElement(std::make_shared<RenderElement>(callback));
}

addCheckbox()

void WindowWidget::addCheckbox	(	const std::string &	text,
		bool &	boolean
	)

Add a new checkbox element to the GUI.

Parameters

[in]	text	Text to display on checkbox.
[in]	boolean	Boolean to modify upon checkbox change.

Definition at line 393 of file gui.cpp.

{
    addElement(std::make_shared<CheckboxElement>(text, boolean));
}

addElement()

void WindowWidget::addElement

(

const ImGuiElementPtr &

element

)

Add a generic element to the GUI.

Parameters

[in]

element

Element to render.

Definition at line 403 of file gui.cpp.

{
    elements_.push_back(element);
}

addText()

void WindowWidget::addText

(

const std::string &

text

)

Add a new text element to the GUI.

Parameters

[in]

text

Text to display.

Definition at line 383 of file gui.cpp.

{
    addElement(std::make_shared<TextElement>(text));
}

render()

void WindowWidget::render ( )

override

Render GUI.

Definition at line 366 of file gui.cpp.

{
    if (elements_.empty())
        return;
 
    ImGui::SetNextWindowBgAlpha(0.5f);
    if (!ImGui::Begin("Robowflex DART", nullptr,
                      ImGuiWindowFlags_MenuBar | ImGuiWindowFlags_HorizontalScrollbar))
    {
        ImGui::End();
        return;
    }
 
    for (const auto &element : elements_)
        element->render();
}

Member Data Documentation

elements_

std::vector<ImGuiElementPtr> robowflex::darts::WindowWidget::elements_

private

GUI elements.

Definition at line 412 of file gui.h.

---

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

• gui.h
• gui.cpp