pu::ui::elm::Image Class Reference

Element for image rendering. More...

#include <elm_Image.hpp>

Inheritance diagram for pu::ui::elm::Image:

Public Member Functions
	Image (const i32 x, const i32 y, sdl2::TextureHandle::Ref image)
	Creates a new instance of an Image element.
i32	GetX () override
	Gets the X position of the Element.
void	SetX (const i32 x)
	Sets the X position of the Image.
i32	GetY () override
	Gets the Y position of the Element.
void	SetY (const i32 y)
	Sets the Y position of the Image.
i32	GetWidth () override
	Gets the width of the Element.
void	SetWidth (const i32 width)
	Sets the width of the Image.
i32	GetHeight () override
	Gets the height of the Element.
void	SetHeight (const i32 height)
	Sets the height of the Image.
void	SetImage (sdl2::TextureHandle::Ref image)
	Sets the image to render.
bool	IsImageValid ()
	Gets the image being rendered.
void	OnRender (render::Renderer::Ref &drawer, const i32 x, const i32 y) override
	Renders the Element on the screen.
void	OnInput (const u64 keys_down, const u64 keys_up, const u64 keys_held, const TouchPoint touch_pos) override
	Called before rendering the Element in order to handle input.
Public Member Functions inherited from pu::ui::elm::Element
	Element ()
	Creates a new instance of an Element.
virtual	~Element ()
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).

Additional Inherited Members
Protected Attributes inherited from pu::ui::elm::Element
bool	visible
HorizontalAlign	h_align
VerticalAlign	v_align
Container *	parent_container

Detailed Description

Element for image rendering.

Constructor & Destructor Documentation

Image()

pu::ui::elm::Image::Image	(	const i32	x,
		const i32	y,
		sdl2::TextureHandle::Ref	image )

Creates a new instance of an Image element.

Parameters

x	X position of the Image.
y	Y position of the Image.
image	Path to the image to render.

Member Function Documentation

GetHeight()

i32 pu::ui::elm::Image::GetHeight ( )

inlineoverridevirtual

Gets the height of the Element.

Returns

Height of the Element.

Implements pu::ui::elm::Element.

GetWidth()

i32 pu::ui::elm::Image::GetWidth ( )

inlineoverridevirtual

Gets the width of the Element.

Returns

Width of the Element.

Implements pu::ui::elm::Element.

GetX()

i32 pu::ui::elm::Image::GetX ( )

inlineoverridevirtual

Gets the X position of the Element.

Returns

X position of the Element.

Implements pu::ui::elm::Element.

GetY()

i32 pu::ui::elm::Image::GetY ( )

inlineoverridevirtual

Gets the Y position of the Element.

Returns

Y position of the Element.

Implements pu::ui::elm::Element.

IsImageValid()

bool pu::ui::elm::Image::IsImageValid ( )

inline

Gets the image being rendered.

Returns

Path to the image being rendered.

OnInput()

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

inlineoverridevirtual

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.

Implements pu::ui::elm::Element.

OnRender()

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

overridevirtual

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.

Implements pu::ui::elm::Element.

SetHeight()

void pu::ui::elm::Image::SetHeight ( const i32 height )

inline

Sets the height of the Image.

Parameters

height

New height.

SetImage()

void pu::ui::elm::Image::SetImage

(

sdl2::TextureHandle::Ref

image

)

Sets the image to render.

Parameters

image

Path to the image to render.

SetWidth()

void pu::ui::elm::Image::SetWidth ( const i32 width )

inline

Sets the width of the Image.

Parameters

width

New width.

SetX()

void pu::ui::elm::Image::SetX ( const i32 x )

inline

Sets the X position of the Image.

Parameters

x	New X position.

SetY()

void pu::ui::elm::Image::SetY ( const i32 y )

inline

Sets the Y position of the Image.

Parameters

y	New Y position.

---

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

• Plutonium/include/pu/ui/elm/elm_Image.hpp