Base class for low-level bounded widgets. More...

#include <Box.h>

Inheritance diagram for HoverRace::Display::Box:

Classes
struct	Props

Public Member Functions
	Box (const Vec2 &size, uiLayoutFlags_t layoutFlags=0)

virtual	~Box ()

virtual void	AdjustHeight (double h)
	Adjust the height, preserving the preferred aspect ratio. More...

virtual void	AdjustWidth (double w)
	Adjust the width, preserving the preferred aspect ratio. More...

const Vec2 &	GetSize () const
	Retrieve the size of the box. More...

virtual Vec3	Measure ()
	Calculate the size of the component. More...

void	SetSize (const Vec2 &size)
	Set the size of the box. More...

void	SetSize (double w, double h)
	Convenience function for SetSize(const Vec2&). More...

Public Member Functions inherited from HoverRace::Display::UiViewModel
	UiViewModel (uiLayoutFlags_t layoutFlags=0)

virtual	~UiViewModel ()

virtual void	DropFocus ()
	Force this widget to give up focus, if it is currently focused. More...

Vec2	GetAlignedPos (const Vec2 &pos, double w, double h) const
	Retrieve an arbitrary position adjusted by the current alignment. More...

Vec2	GetAlignedPos (double w, double h) const
	Retrieve the position adjusted by the current alignment. More...

Alignment	GetAlignment () const
	Retrieve the alignment of the component. More...

focusRelinquishedSignal_t &	GetFocusRelinquishedSignal ()

focusRequestedSignal_t &	GetFocusRequestedSignal ()

uiLayoutFlags_t	GetLayoutFlags () const
	Retrieve the layout flags. More...

const Vec2 &	GetPos () const
	Get the position of the component. More...

const Vec2 &	GetTranslation () const
	Retrieves the position translation. More...

bool	IsFocused () const
	Check if this widget currently has input focus. More...

uiLayoutFlags_t	IsLayoutFloating () const

uiLayoutFlags_t	IsLayoutUnscaled () const

virtual bool	OnAction ()

virtual bool	OnMouseMoved (const Vec2 &)

virtual bool	OnMousePressed (const Control::Mouse::Click &)

virtual bool	OnMouseReleased (const Control::Mouse::Click &)

virtual bool	OnMouseScrolled (const Control::Mouse::Scroll &)

virtual bool	OnNavigate (const Control::Nav &)

void	RequestFocus ()
	Attempt to hand over the input focus to this widget. More...

void	SetAlignment (Alignment alignment)
	Set the alignment of the component. More...

void	SetPos (const Vec2 &pos)
	Set the position of the component. More...

void	SetPos (double x, double y)
	Convenience function for SetPos(const Vec2&). More...

void	SetTranslation (const Vec2 &translation)
	Sets the position translation. More...

void	SetTranslation (double x, double y)
	Convenience function for SetTranslation(const Vec2&). More...

virtual bool	TryFocus (const Control::Nav &nav=Control::Nav::NEUTRAL)
	Attempts to give this widget focus. More...

Public Member Functions inherited from HoverRace::Display::ViewModel
	ViewModel ()

virtual	~ViewModel ()

virtual void	AttachView (Display &disp)=0

View *	GetView () const

void	PrepareRender ()

void	Render ()

void	SetView (std::unique_ptr< View > &&view)

Private Types
using	SUPER = UiViewModel

Private Attributes
Vec2	size

Additional Inherited Members
Public Types inherited from HoverRace::Display::UiViewModel
enum	Alignment { Alignment::NW, Alignment::N, Alignment::NE, Alignment::E, Alignment::SE, Alignment::S, Alignment::SW, Alignment::W, Alignment::CENTER }
	Imagine the component pinned to the container with a thumbtack. More...

using	focusRelinquishedSignal_t = boost::signals2::signal< void(UiViewModel &, const Control::Nav &)>

using	focusRequestedSignal_t = boost::signals2::signal< void(UiViewModel &)>

Protected Member Functions inherited from HoverRace::Display::UiViewModel
void	RelinquishFocus (const Control::Nav &nav)
	Voluntarily give up input focus, passing it on to the next widget. More...

void	SetFocused (bool focused)
	Set the focused state. More...

Protected Member Functions inherited from HoverRace::Display::ViewModel
template<class T >
void	AttachViewDynamic (Display &disp, T *self)

virtual void	FireModelUpdate (int prop)
	Indicate that a model property has changed. More...

virtual void	Layout ()
	Adjust the size and position of any child elements. More...

void	RequestLayout ()
	Indicate that the current layout is out-of-date and needs to be adjusted. More...

Detailed Description

Base class for low-level bounded widgets.

Author: Michael Imamura

Member Typedef Documentation

using HoverRace::Display::Box::SUPER = UiViewModel

private

Constructor & Destructor Documentation

HoverRace::Display::Box::Box	(	const Vec2 &	size,
		uiLayoutFlags_t	layoutFlags = `0`
	)

inline

virtual HoverRace::Display::Box::~Box ( )

inlinevirtual

Member Function Documentation

void HoverRace::Display::Box::AdjustHeight ( double h )

virtual

Adjust the height, preserving the preferred aspect ratio.

Parameters

h	The new height.

Reimplemented in HoverRace::Display::KeycapIcon.

void HoverRace::Display::Box::AdjustWidth ( double w )

virtual

Adjust the width, preserving the preferred aspect ratio.

Parameters

w	The new width.

Reimplemented in HoverRace::Display::KeycapIcon.

const Vec2& HoverRace::Display::Box::GetSize ( ) const

inline

Retrieve the size of the box.

Returns: The size, where x is the width and y is the height.

virtual Vec3 HoverRace::Display::Box::Measure ( )

inlinevirtual

Calculate the size of the component.

For UI components, the return value is affected by layout flags.

Returns: The size (may be zero if the size cannot be determined yet).

Warning: Depending on the view, this may be an expensive operation since the view may have to call View::PrepareRender to apply model changes. As such, it is recommended to call Measure in the PrepareRender phase itself.

Reimplemented from HoverRace::Display::ViewModel.

Reimplemented in HoverRace::Display::KeycapIcon.

void HoverRace::Display::Box::SetSize ( const Vec2 & size )

Set the size of the box.

Parameters

size	The size of the box, where `x` is the width and `y` is the height.

void HoverRace::Display::Box::SetSize	(	double	w,
		double	h
	)

inline

Convenience function for SetSize(const Vec2&).

Member Data Documentation

Vec2 HoverRace::Display::Box::size

private

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

Classes

Public Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation