pu::ui::Layout Class Reference

Class that represents a layout, the core UI container in the library. More...

#include <ui_Layout.hpp>

Inheritance diagram for pu::ui::Layout:

Public Types
using	OnInputCallback = std::function<void(const u64 keys_down, const u64 keys_up, const u64 keys_held, const TouchPoint touch_pos)>
	Callback type used for input handling.
using	RenderCallback = std::function<void()>
	Callback type used for rendering.

Public Member Functions
	Layout ()
	Creates a new Layout with the default background (white-ish).
virtual	~Layout ()
bool	HasChildren ()
	Checks whether the Layout has any children.
void	SetOnInput (OnInputCallback on_ipt_cb)
	Sets the input callback for the Layout.
OnInputCallback	GetOnInput ()
	Gets the input callback for the Layout.
void	AddRenderCallback (RenderCallback render_cb)
	Adds a render callback to the Layout.
std::vector< RenderCallback > &	GetRenderCallbacks ()
	Gets all render callbacks from the Layout.
bool	HasBackgroundImage ()
	Checks whether the Layout has a background image.
sdl2::TextureHandle::Ref &	GetBackgroundImageTexture ()
	Gets the background image texture of the Layout.
Color	GetBackgroundColor ()
	Gets the background color of the Layout.
void	SetBackgroundImage (sdl2::TextureHandle::Ref bg_tex)
	Sets the background image of the Layout.
void	ResetBackgroundImage ()
	Resets the background image of the Layout.
void	SetBackgroundColor (const Color clr)
	Sets the background color of the Layout.
void	SimulateTouchPosition (const TouchPoint sim_touch_pos)
	Simulates a (fake) touch for the Layout.
TouchPoint	ConsumeSimulatedTouchPosition ()
	Consumes (gets and then resets) the simulated touch position.
Public Member Functions inherited from pu::ui::Container
	Container (const i32 x, const i32 y, const i32 width, const i32 height)
	Creates a new Container with the specified position and size.
void	Add (elm::Element::Ref elem)
	Adds an Element to the Container.
std::vector< elm::Element::Ref > &	GetElements ()
	Gets the list of Elements in the Container.
bool	Has (elm::Element::Ref &elem)
	Gets whether the Container has the specified Element.
void	Clear ()
	Removes all elements from the Container.
void	PreRender ()
	Function to be invoked before rendering the Container.

Static Public Attributes
static constexpr Color	DefaultBackgroundColor = { 0xE1, 0xE1, 0xE1, 0xFF }
	Default background color for Layouts (white-ish).

Additional Inherited Members
Protected Attributes inherited from pu::ui::Container
i32	x
i32	y
i32	w
i32	h
std::vector< elm::Element::Ref >	elems

Detailed Description

Class that represents a layout, the core UI container in the library.

Note

The layout covers the entire screen, has a background and it renders all its children elements over it.

Member Typedef Documentation

OnInputCallback

using pu::ui::Layout::OnInputCallback = std::function<void(const u64 keys_down, const u64 keys_up, const u64 keys_held, const TouchPoint touch_pos)>

Callback type used for input handling.

Note

This callback is called every loop.

Parameters

keys_down	Keys that were pressed in this frame.
keys_up	Keys that were released in this frame.
keys_held	Keys that are being held in this frame.
touch_pos	Touch position in this frame.

RenderCallback

using pu::ui::Layout::RenderCallback = std::function<void()>

Callback type used for rendering.

Note

This callback is called every loop, so it may be used in a similar fashion to main loop handling.

Constructor & Destructor Documentation

Layout()

pu::ui::Layout::Layout ( )

inline

Creates a new Layout with the default background (white-ish).

~Layout()

virtual pu::ui::Layout::~Layout ( )

virtual

Member Function Documentation

AddRenderCallback()

void pu::ui::Layout::AddRenderCallback ( RenderCallback render_cb )

inline

Adds a render callback to the Layout.

Parameters

render_cb

Render callback to add.

ConsumeSimulatedTouchPosition()

TouchPoint pu::ui::Layout::ConsumeSimulatedTouchPosition

(

)

Consumes (gets and then resets) the simulated touch position.

Returns

The simulated touch position.

GetBackgroundColor()

Color pu::ui::Layout::GetBackgroundColor ( )

inline

Gets the background color of the Layout.

Returns

The background color of the Layout.

GetBackgroundImageTexture()

sdl2::TextureHandle::Ref & pu::ui::Layout::GetBackgroundImageTexture ( )

inline

Gets the background image texture of the Layout.

Returns

The background image texture of the Layout.

GetOnInput()

OnInputCallback pu::ui::Layout::GetOnInput ( )

inline

Gets the input callback for the Layout.

Returns

The input callback for the Layout.

GetRenderCallbacks()

std::vector< RenderCallback > & pu::ui::Layout::GetRenderCallbacks ( )

inline

Gets all render callbacks from the Layout.

Returns

All render callbacks from the Layout.

HasBackgroundImage()

bool pu::ui::Layout::HasBackgroundImage ( )

inline

Checks whether the Layout has a background image.

Returns

Whether the Layout has a background image.

HasChildren()

bool pu::ui::Layout::HasChildren ( )

inline

Checks whether the Layout has any children.

Returns

Whether the Layout has children.

ResetBackgroundImage()

void pu::ui::Layout::ResetBackgroundImage

(

)

Resets the background image of the Layout.

Note

If the Layout has no background image, its background color will be visible instead.

SetBackgroundColor()

void pu::ui::Layout::SetBackgroundColor

(

const Color

clr

)

Sets the background color of the Layout.

Parameters

clr	Background color to set.

SetBackgroundImage()

void pu::ui::Layout::SetBackgroundImage

(

sdl2::TextureHandle::Ref

bg_tex

)

Sets the background image of the Layout.

Note

This will override the background color.

Parameters

bg_tex

Background image texture to set.

SetOnInput()

void pu::ui::Layout::SetOnInput ( OnInputCallback on_ipt_cb )

inline

Sets the input callback for the Layout.

Parameters

on_ipt_cb

Input callback to set.

SimulateTouchPosition()

void pu::ui::Layout::SimulateTouchPosition ( const TouchPoint sim_touch_pos )

inline

Simulates a (fake) touch for the Layout.

Parameters

sim_touch_pos

Touch position to simulate.

Member Data Documentation

DefaultBackgroundColor

Color pu::ui::Layout::DefaultBackgroundColor = { 0xE1, 0xE1, 0xE1, 0xFF }

staticconstexpr

Default background color for Layouts (white-ish).

---

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

• Plutonium/include/pu/ui/ui_Layout.hpp