gva::WidgetObjectLocalisation Class Reference

Class defining the bounding box object. More...

#include <object_localisation.h>

Inheritance diagram for gva::WidgetObjectLocalisation:

Collaboration diagram for gva::WidgetObjectLocalisation:

Data Structures
struct	BoxType
	The bounding box data. More...

Public Member Functions
	WidgetObjectLocalisation (const RendererGva &renderer, TouchGva *touch)
	Construct a new Widget Keyboard object, this widget is interactive and requires the touch events.
	~WidgetObjectLocalisation () final=default
	Destroy the Widget Keyboard object.
std::string	GetWidgetName () const final
	Get the Widget Name attribute.
void	Draw () final
	The base overloaded Draw fuctions to draw this widget type.
void	AddBoundingBox (int16_t id, const BoxType &box)
	Add a box onto the object localisation overlay.
void	DeleteBoundingBox (int16_t id)
	Delete a box by ID.
void	DeleteAllBoundingBox ()
	Delete all box.
Public Member Functions inherited from gva::WidgetX
	WidgetX (const RendererGva &renderer, widget::WidgetEnum widget_type)
	Construct a new Widget X object.
virtual widget::WidgetEnum	GetWidgetType () const
	Get the Widget Type attribute.
void	SetVisible (bool visible)
	Set the Visible object.
bool	GetVisible () const
	Get the Visible object.
virtual void	SetX (uint32_t x)
	Set the X dimension.
uint32_t	GetX () const
	Get the Y dimension.
virtual void	SetY (uint32_t y)
	Set the Y dimension.
uint32_t	GetY () const
	Get the Y dimension.
void	SetWidth (uint32_t width)
	Set the Width.
uint32_t	GetWidth () const
	Get the Width.
void	SetHeight (uint32_t width)
	Set the Height.
uint32_t	GetHeight () const
	Get the Height.
widget::WidgetEnum	GetType () const
	Get the Type object.
RendererGva *	GetRenderer () const
	Get the Renderer object.
void	SetStateText (LabelStates state)
	Set the State Text of an on screen label.
void	SetStateLabel (const LabelStates state)
	Set the State Label object.
uint32_t	GetStateTextColour (LabelStates state) const
	Get the State Text Colour object.

Additional Inherited Members
Data Fields inherited from gva::WidgetX
uint32_t	x_ = 0
	The widget x location in pixels.
uint32_t	y_ = 0
	The widget y location in pixels.
uint32_t	width_ = 0
	The widget width in pixels.
uint32_t	height_ = 0
	The widget height in pixels.

Detailed Description

Class defining the bounding box object.

---

Data Structure Documentation

gva::WidgetObjectLocalisation::BoxType

struct gva::WidgetObjectLocalisation::BoxType

The bounding box data.

Collaboration diagram for gva::WidgetObjectLocalisation::BoxType:

Data Fields
bool	dotted = false	Dotted if true.
bool	flashing = false	Flashing if true.
uint32_t	height = 0	The object height.
string	label = ""	The object label.
uint32_t	rgb_value = 0x00FF0000	The object RGB colour.
uint32_t	width = 0	The object width.
uint32_t	xpos = 0	The object x position.
uint32_t	ypos = 0	The object y position.

Constructor & Destructor Documentation

WidgetObjectLocalisation()

gva::WidgetObjectLocalisation::WidgetObjectLocalisation ( const RendererGva &  renderer, TouchGva *  touch  )

explicit

Construct a new Widget Keyboard object, this widget is interactive and requires the touch events.

Parameters

renderer	the renderer
touch	the touch object

Member Function Documentation

AddBoundingBox()

void gva::WidgetObjectLocalisation::AddBoundingBox	(	int16_t	id,
		const BoxType &	box
	)

Add a box onto the object localisation overlay.

Parameters

id	Unique ID of the box
box	The box object

DeleteBoundingBox()

void gva::WidgetObjectLocalisation::DeleteBoundingBox

(

int16_t

id

)

Delete a box by ID.

Parameters

id	The ID of the box to be deletes

Draw()

void gva::WidgetObjectLocalisation::Draw ( )

finalvirtual

The base overloaded Draw fuctions to draw this widget type.

, TouchType& touch

Implements gva::WidgetX.

GetWidgetName()

std::string gva::WidgetObjectLocalisation::GetWidgetName ( ) const

inlinefinalvirtual

Get the Widget Name attribute.

Returns

std::string

Implements gva::WidgetX.

---

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

• src/hmicore/widgets/ai/object_localisation.h
• src/hmicore/widgets/ai/object_localisation.cc