gaze::gui::Visualizeable< widget_type > Class Template Reference

Implements VisualizeableBase for several widget types. More...

#include "gaze/gui/visualizeable.h"

Inheritance diagram for gaze::gui::Visualizeable< widget_type >:

Public Member Functions
std::shared_ptr< dlib::drawable >	init (dlib::drawable_window &parent, int width, int height, std::string text="No visualization.") final
void	remove_widget () override
Public Member Functions inherited from gaze::gui::VisualizeableBase
virtual	~VisualizeableBase ()=default
virtual void	visualize (util::Data &data)=0

Protected Attributes
std::shared_ptr< widget_type >	widget

Detailed Description

template<typename widget_type = dlib::label>
class gaze::gui::Visualizeable< widget_type >

Implements VisualizeableBase for several widget types.

This is a generic implementation for visualizeables using different widget types.

Template Parameters

widget_type

a dlib widget type.

Definition at line 223 of file visualizeable.h.

Member Function Documentation

template<typename widget_type = dlib::label>

std::shared_ptr<dlib::drawable> gaze::gui::Visualizeable< widget_type >::init ( dlib::drawable_window &  parent, int  width, int  height, std::string  text = "No visualization."  )

inlinefinalvirtual

Initializes the widget by creating a widget and adjusting it.

Note

Some widgets do not support all adjustments (width/height/text). Please refer to the widget documentations for details.

Parameters

parent	The parent window.
width	The widget width
height	The widget height
text	The widget text

Returns

A pointer to the newly initialized widget.

Implements gaze::gui::VisualizeableBase.

Definition at line 233 of file visualizeable.h.

References gaze::gui::Visualizeable< widget_type >::widget.

                                                  {
    widget = create_widget<widget_type>(parent);
    adjust_widget<widget_type>(widget, width, height, text);
    return widget;
  }

template<typename widget_type = dlib::label>

void gaze::gui::Visualizeable< widget_type >::remove_widget ( )

inlineoverridevirtual

Disables and removes the widget.

Reimplemented from gaze::gui::VisualizeableBase.

Definition at line 245 of file visualizeable.h.

                                {
    if (this->widget && this->widget.get()) {
      this->widget->disable();
    }
    this->widget = std::shared_ptr<widget_type>(nullptr);
  }

Member Data Documentation

template<typename widget_type = dlib::label>

std::shared_ptr<widget_type> gaze::gui::Visualizeable< widget_type >::widget

protected

The widget to write to.

Definition at line 228 of file visualizeable.h.

Referenced by gaze::gui::Visualizeable< widget_type >::init(), gaze::pipeline::FallbackStep::visualize(), gaze::pipeline::FaceLandmarks::visualize(), gaze::pipeline::SourceCapture::visualize(), and gaze::pipeline::HeadPoseEstimation::visualize().

---

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

• include/gaze/gui/visualizeable.h