An invisible container for other UI widgets. More...

#include <Container.h>

Inheritance diagram for HoverRace::Display::Container:

Public Member Functions
	Container (Display &display, uiLayoutFlags_t layoutFlags=0)

	Container (Display &display, const Vec2 &size, bool clip=true, uiLayoutFlags_t layoutFlags=0)

virtual	~Container ()

void	Clear () override
	Remove all child elements. More...

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

template<class T , class... Args>
std::enable_if< std::is_base_of< UiViewModel, T >::value, std::shared_ptr< T > >::type	NewChild (Args &&...args)
	Create and append a new child widget to the end of the list. More...

bool	OnAction () override

bool	OnNavigate (const Control::Nav &nav) override

template<class T >
std::enable_if< std::is_base_of< UiViewModel, T >::value, std::shared_ptr< T > >::type	RemoveChild (const std::shared_ptr< T > &child)
	Remove a child element. More...

template<class T >
std::enable_if< std::is_base_of< UiViewModel, T >::value, std::shared_ptr< T > >::type	ReorderChild (const std::shared_ptr< T > &child, size_t idx)
	Move a widget to a different position in the list. More...

void	Reserve (size_t capacity) override
	Increase the capacity of the of this container. More...

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

Public Member Functions inherited from HoverRace::Display::BaseContainer
	BaseContainer (Display &display, uiLayoutFlags_t layoutFlags=0)
	Constructor for an unsized container without clipping. More...

	BaseContainer (Display &display, const Vec2 &size, bool clip=true, uiLayoutFlags_t layoutFlags=0)
	Constructor for a sized container. More...

virtual	~BaseContainer ()

void	AttachView (Display &disp) override

template<class Fn >
void	ForEachChild (Fn fn) const
	Iterate over each child widget. More...

template<class Fn >
void	ForEachVisibleChild (Fn fn) const
	Iterate over each visible child widget. More...

const Vec2 &	GetChildOffset () const
	Retrieve the offset to the position of the child widgets. More...

double	GetOpacity () const
	Retrieve the opacity. More...

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

bool	IsClip () const
	Check if child elements are clipped to the container bounds. More...

bool	IsEmpty () const
	Check if this container is devoid of child widgets. More...

bool	IsVisible () const
	Check if the children of this container are shown. More...

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

bool	OnMouseMoved (const Vec2 &pos) override

bool	OnMousePressed (const Control::Mouse::Click &click) override

bool	OnMouseReleased (const Control::Mouse::Click &click) override

bool	OnMouseScrolled (const Control::Mouse::Scroll &scroll) override

void	SetClip (bool clip)
	Set whether child elements are clipped to the container bounds. More...

void	SetOpacity (double opacity)
	Set the opacity of the container. More...

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

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

void	SetVisible (bool visible)
	Sets whether the widgets in this container are visible. More...

void	ShrinkWrap ()
	Resize the container to the minimum size that will fit all of the child elements. More...

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

virtual	~UiViewModel ()

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

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...

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

virtual	~ViewModel ()

View *	GetView () const

void	PrepareRender ()

void	Render ()

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

Protected Member Functions
void	OnChildRelinquishedFocus (UiViewModel &child, const Control::Nav &nav) override
	Called when a child widget passes input focus to another widget. More...

void	OnChildRequestedFocus (UiViewModel &child) override
	Called when a child widget requests input focus. More...

Protected Member Functions inherited from HoverRace::Display::BaseContainer
children_t &	GetChildren ()

template<class T , class... Args>
std::enable_if< std::is_base_of< UiViewModel, T >::value, std::shared_ptr< T > >::type	NewChild (Args &&...args)
	Create and append a new child widget to the end of the list. More...

template<typename T >
std::enable_if< std::is_base_of< UiViewModel, T >::value, std::shared_ptr< T > >::type	RemoveChild (const std::shared_ptr< T > &child)
	Remove a child element. More...

template<class T >
std::enable_if< std::is_base_of< UiViewModel, T >::value, std::shared_ptr< T > >::type	ReorderChild (const std::shared_ptr< T > &child, size_t idx)
	Move a widget to a different position in the list. More...

void	SetChildOffset (const Vec2 &offset)
	Sets the position offset of child widgets. More...

bool	TestHit (const Vec2 &pos)
	Check if the coordinates of an event are within the bounds of this component. More...

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...

Private Types
using	SUPER = BaseContainer

Private Member Functions
void	FocusNextFrom (children_t::iterator startingPoint, const Control::Nav &nav)
	Shift focus to the first focusable widget after the child. More...

void	FocusPrevFrom (children_t::iterator startingPoint, const Control::Nav &nav)
	Shift focus to the first focusable widget previous to the child. More...

Private Attributes
UiViewModel *	focusedChild

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 Types inherited from HoverRace::Display::BaseContainer
using	children_t = std::vector< std::unique_ptr< Child >>

Protected Attributes inherited from HoverRace::Display::BaseContainer
Display &	display

Detailed Description

An invisible container for other UI widgets.

Author: Michael Imamura

Member Typedef Documentation

using HoverRace::Display::Container::SUPER = BaseContainer

private

Constructor & Destructor Documentation

HoverRace::Display::Container::Container	(	Display &	display,
		uiLayoutFlags_t	layoutFlags = `0`
	)

inline

HoverRace::Display::Container::Container	(	Display &	display,
		const Vec2 &	size,
		bool	clip = `true`,
		uiLayoutFlags_t	layoutFlags = `0`
	)

inline

virtual HoverRace::Display::Container::~Container ( )

inlinevirtual

Member Function Documentation

void HoverRace::Display::Container::Clear ( )

overridevirtual

Remove all child elements.

Reimplemented from HoverRace::Display::BaseContainer.

void HoverRace::Display::Container::DropFocus ( )

overridevirtual

Force this widget to give up focus, if it is currently focused.

This is called by the parent container if focus is shifting away to another widget.

Reimplemented from HoverRace::Display::UiViewModel.

void HoverRace::Display::Container::FocusNextFrom	(	children_t::iterator	startingPoint,
		const Control::Nav &	nav
	)

private

Shift focus to the first focusable widget after the child.

Parameters

startingPoint
nav	The current navigation direction (either Nav::RIGHT or Nav::DOWN).

void HoverRace::Display::Container::FocusPrevFrom	(	children_t::iterator	startingPoint,
		const Control::Nav &	nav
	)

private

Shift focus to the first focusable widget previous to the child.

Parameters

startingPoint
nav	The current navigation direction (either Nav::UP or Nav::LEFT).

template<class T , class... Args>

std::enable_if<std::is_base_of<UiViewModel, T>::value, std::shared_ptr<T> >::type HoverRace::Display::Container::NewChild ( Args &&... args )

inline

Create and append a new child widget to the end of the list.

Template Parameters

T	The type of the child widget.
Args	The types of the arguments.

Parameters

args	The arguments to pass to the child widget's constructor.

Returns: A shared pointer to the newly-constructed widget.

bool HoverRace::Display::Container::OnAction ( )

inlineoverridevirtual

Reimplemented from HoverRace::Display::UiViewModel.

void HoverRace::Display::Container::OnChildRelinquishedFocus	(	UiViewModel &	child,
		const Control::Nav &	nav
	)

overrideprotectedvirtual

Called when a child widget passes input focus to another widget.

Parameters

child	The child widget.
nav	The navigation direction.

Reimplemented from HoverRace::Display::BaseContainer.

void HoverRace::Display::Container::OnChildRequestedFocus ( UiViewModel & child )

overrideprotectedvirtual

Called when a child widget requests input focus.

Parameters

child The child widget.

Reimplemented from HoverRace::Display::BaseContainer.

bool HoverRace::Display::Container::OnNavigate ( const Control::Nav & nav )

inlineoverridevirtual

Reimplemented from HoverRace::Display::UiViewModel.

template<class T >

std::enable_if<std::is_base_of<UiViewModel, T>::value, std::shared_ptr<T> >::type HoverRace::Display::Container::RemoveChild ( const std::shared_ptr< T > & child )

inline

Remove a child element.

Parameters

child The child element; must be a shared_ptr to a subclass of UiViewModel.

Returns: The same child element that was passed in.

template<class T >

std::enable_if<std::is_base_of<UiViewModel, T>::value, std::shared_ptr<T> >::type HoverRace::Display::Container::ReorderChild	(	const std::shared_ptr< T > &	child,
		size_t	idx
	)

inline

Move a widget to a different position in the list.

Parameters

child	The child.
idx	The destination index. If beyond the end, then the child will be moved to the end of the list.

Returns: The same child element that was passed in.

void HoverRace::Display::Container::Reserve ( size_t capacity )

inlineoverridevirtual

Increase the capacity of the of this container.

The internal capacity will be increased (never decreased). This is useful as a hint to prevent re-allocation due to resizing the internal storage. It's not required; the internal storage will be resized as necessary anyway, at the cost of re-allocation. Containers with a lot of child elements will benefit the most from specifying the capacity early.

Parameters

capacity The new capacity.

Reimplemented from HoverRace::Display::BaseContainer.

bool HoverRace::Display::Container::TryFocus ( const Control::Nav & nav = Control::Nav::NEUTRAL )

overridevirtual

Attempts to give this widget focus.

Subclasses should override this with logic to determine if the widget is focusable.

This is called by the parent container if focus has been requested.

Parameters

nav	The direction in which the focus is heading.

Returns: true if it succeeds (widget is now focused), false if it fails (widget did not take focus).

Reimplemented from HoverRace::Display::UiViewModel.

Member Data Documentation

UiViewModel* HoverRace::Display::Container::focusedChild

private

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation