gaze::gui::VisualizeableBase Class Reference

Abstract base class for Visualizeable to allow generic pointers. More...

#include "gaze/gui/visualizeable.h"

Inheritance diagram for gaze::gui::VisualizeableBase:

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

Detailed Description

Abstract base class for Visualizeable to allow generic pointers.

This class defines an interface which is readily implemented by Visualizeable. Since Visualizeable is a template class, generic pointers and collections containing different Visualizeables must instead use VisualizeableBase.

Definition at line 170 of file visualizeable.h.

Constructor & Destructor Documentation

virtual gaze::gui::VisualizeableBase::~VisualizeableBase ( )

virtualdefault

Override this method if you need more destruction control.

Member Function Documentation

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

pure virtual

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.

Implemented in gaze::gui::Visualizeable< widget_type >.

virtual void gaze::gui::VisualizeableBase::remove_widget ( )

inlinevirtual

Removes the widget or disables it.

Reimplemented in gaze::gui::Visualizeable< widget_type >.

Definition at line 198 of file visualizeable.h.

{}

virtual void gaze::gui::VisualizeableBase::visualize ( util::Data &  data )

pure virtual

Visualizes the data object by updating the widget.

The data object is not const to allow for certain non-const actions, but it should be highly discouraged to modify it.

Warning

Always check if this->widget is not null before writing to it!

Parameters

data	The data object to be visualized.

Implemented in gaze::pipeline::GazePointCalculation, gaze::pipeline::PupilLocalization, gaze::pipeline::HeadPoseEstimation, gaze::pipeline::SourceCapture, gaze::pipeline::GazeCapture, gaze::pipeline::FaceLandmarks, gaze::pipeline::FallbackStep, and gaze::pipeline::EyeLike.

---

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

• include/gaze/gui/visualizeable.h