Base class for all UI elements in Plutonium, providing basic functionality for all of them. More...

#include <elm_Element.hpp>

Inheritance diagram for pu::ui::elm::Element:

Public Member Functions
	Element ()
	Creates a new instance of an Element.

virtual	~Element ()

virtual i32	GetX ()=0
	Gets the X position of the Element.

virtual i32	GetY ()=0
	Gets the Y position of the Element.

virtual i32	GetWidth ()=0
	Gets the width of the Element.

virtual i32	GetHeight ()=0
	Gets the height of the Element.

virtual void	OnRender (render::Renderer::Ref &drawer, const i32 x, const i32 y)=0
	Renders the Element on the screen.

virtual void	OnInput (const u64 keys_down, const u64 keys_up, const u64 keys_held, const TouchPoint touch_pos)=0
	Called before rendering the Element in order to handle input.

bool	IsVisible ()
	Gets whether the Element is visible.

void	SetVisible (const bool visible)
	Sets whether the Element is visible.

void	SetHorizontalAlign (const HorizontalAlign align)
	Sets the horizontal alignment of the Element.

HorizontalAlign	GetHorizontalAlign ()
	Gets the horizontal alignment of the Element.

void	SetVerticalAlign (const VerticalAlign align)
	Sets the vertical alignment of the Element.

VerticalAlign	GetVerticalAlign ()
	Gets the vertical alignment of the Element.

void	SetParentContainer (Container *parent_container)
	Sets the parent Container of the Element.

i32	GetProcessedX ()
	Gets the actual X position of the Element, considering the parent Container (depends on alignment).

i32	GetProcessedY ()
	Gets the actual Y position of the Element, considering the parent Container (depends on alignment).

Protected Attributes
bool	visible

HorizontalAlign	h_align

VerticalAlign	v_align

Container *	parent_container

Detailed Description

Base class for all UI elements in Plutonium, providing basic functionality for all of them.

Constructor & Destructor Documentation

◆ Element()

pu::ui::elm::Element::Element ( )

inline

Creates a new instance of an Element.

◆ ~Element()

virtual pu::ui::elm::Element::~Element ( )

inlinevirtual

Member Function Documentation

◆ GetHeight()

virtual i32 pu::ui::elm::Element::GetHeight ( )

pure virtual

Gets the height of the Element.

Returns: Height of the Element.

Implemented in pu::ui::elm::Button, pu::ui::elm::Image, pu::ui::elm::Menu, pu::ui::elm::ProgressBar, pu::ui::elm::Rectangle, pu::ui::elm::TextBlock, and pu::ui::elm::Toggle.

◆ GetHorizontalAlign()

HorizontalAlign pu::ui::elm::Element::GetHorizontalAlign ( )

inline

Gets the horizontal alignment of the Element.

Returns: Horizontal alignment of the Element.

◆ GetProcessedX()

i32 pu::ui::elm::Element::GetProcessedX ( )

Gets the actual X position of the Element, considering the parent Container (depends on alignment).

Returns: Actual X position of the Element.

Note: This is the X value actually used for rendering.

◆ GetProcessedY()

i32 pu::ui::elm::Element::GetProcessedY ( )

Gets the actual Y position of the Element, considering the parent Container (depends on alignment).

Returns: Actual Y position of the Element.

Note: This is the Y value actually used for rendering.

◆ GetVerticalAlign()

VerticalAlign pu::ui::elm::Element::GetVerticalAlign ( )

inline

Gets the vertical alignment of the Element.

Returns: Vertical alignment of the Element.

◆ GetWidth()

virtual i32 pu::ui::elm::Element::GetWidth ( )

pure virtual

Gets the width of the Element.

Returns: Width of the Element.

Implemented in pu::ui::elm::Button, pu::ui::elm::Image, pu::ui::elm::Menu, pu::ui::elm::ProgressBar, pu::ui::elm::Rectangle, pu::ui::elm::TextBlock, and pu::ui::elm::Toggle.

◆ GetX()

virtual i32 pu::ui::elm::Element::GetX ( )

pure virtual

Gets the X position of the Element.

Returns: X position of the Element.

Implemented in pu::ui::elm::Button, pu::ui::elm::Image, pu::ui::elm::Menu, pu::ui::elm::ProgressBar, pu::ui::elm::Rectangle, pu::ui::elm::TextBlock, and pu::ui::elm::Toggle.

◆ GetY()

virtual i32 pu::ui::elm::Element::GetY ( )

pure virtual

Gets the Y position of the Element.

Returns: Y position of the Element.

Implemented in pu::ui::elm::Button, pu::ui::elm::Image, pu::ui::elm::Menu, pu::ui::elm::ProgressBar, pu::ui::elm::Rectangle, pu::ui::elm::TextBlock, and pu::ui::elm::Toggle.

◆ IsVisible()

bool pu::ui::elm::Element::IsVisible ( )

inline

Gets whether the Element is visible.

Returns: Whether the Element is visible.

◆ OnInput()

virtual void pu::ui::elm::Element::OnInput	(	const u64	keys_down,
		const u64	keys_up,
		const u64	keys_held,
		const TouchPoint	touch_pos )

pure virtual

Called before rendering the Element in order to handle input.

Parameters

keys_down	Keys that are currently being pressed.
keys_up	Keys that are currently being released.
keys_held	Keys that are currently held.
touch_pos	Position of the touch on the screen.

Note: This method is called by the Application. It should not be called manually.

Implemented in pu::ui::elm::Button, pu::ui::elm::Image, pu::ui::elm::Menu, pu::ui::elm::ProgressBar, pu::ui::elm::Rectangle, pu::ui::elm::TextBlock, and pu::ui::elm::Toggle.

◆ OnRender()

virtual void pu::ui::elm::Element::OnRender	(	render::Renderer::Ref &	drawer,
		const i32	x,
		const i32	y )

pure virtual

Renders the Element on the screen.

Parameters

drawer	Renderer to use for rendering.
x	X position to render the Element.
y	Y position to render the Element.

Note: This method is called by the Application. It should not be called manually.

Implemented in pu::ui::elm::Button, pu::ui::elm::Image, pu::ui::elm::Menu, pu::ui::elm::ProgressBar, pu::ui::elm::Rectangle, pu::ui::elm::TextBlock, and pu::ui::elm::Toggle.

◆ SetHorizontalAlign()

void pu::ui::elm::Element::SetHorizontalAlign ( const HorizontalAlign align )

inline

Sets the horizontal alignment of the Element.

Parameters

align New horizontal alignment to set.

◆ SetParentContainer()

void pu::ui::elm::Element::SetParentContainer ( Container * parent_container )

inline

Sets the parent Container of the Element.

Parameters

parent_container New parent Container to set.

Note: This method is called by the underlying Application when rendering. It should not be called manually.

◆ SetVerticalAlign()

void pu::ui::elm::Element::SetVerticalAlign ( const VerticalAlign align )

inline

Sets the vertical alignment of the Element.

Parameters

align New vertical alignment to set.

◆ SetVisible()

void pu::ui::elm::Element::SetVisible ( const bool visible )

inline

Sets whether the Element is visible.

Parameters

visible Whether the Element should be visible.

Note: If the Element is not visible, it will not be rendered and input will not be handled.

Member Data Documentation

◆ h_align

HorizontalAlign pu::ui::elm::Element::h_align

protected

◆ parent_container

Container* pu::ui::elm::Element::parent_container

protected

◆ v_align

VerticalAlign pu::ui::elm::Element::v_align

protected

◆ visible

bool pu::ui::elm::Element::visible

protected

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

Plutonium/include/pu/ui/elm/elm_Element.hpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Element()

◆ ~Element()

Member Function Documentation

◆ GetHeight()

◆ GetHorizontalAlign()

◆ GetProcessedX()

◆ GetProcessedY()

◆ GetVerticalAlign()

◆ GetWidth()

◆ GetX()

◆ GetY()

◆ IsVisible()

◆ OnInput()

◆ OnRender()

◆ SetHorizontalAlign()

◆ SetParentContainer()

◆ SetVerticalAlign()

◆ SetVisible()

Member Data Documentation

◆ h_align

◆ parent_container

◆ v_align

◆ visible