ui::Image Class Reference

Display an arbitrary (non-animated) renderable to the screen with an optional shader. More...

#include <image.hpp>

Inheritance diagram for ui::Image:

Public Member Functions
	Image (const Renderable &renderable, const Position &pos={0, 0}, const Alignment &align={ALIGN_LEFT, ALIGN_TOP})
	Construct an image from some renderable data.
void	draw () const override
	Render the widget to the screen.
Size	size () const override
	Get the size of the widget.
void	update (time_t time_ms) override
	Update any internal state of the widget, and check if it needs to be re-rendered.
void	setShader (const shader_animated_t &shader)
	Set the image shader to a new one that requires re-rendering every frame.
void	setShader (const shader_oneframe_t &shader)
	Set the image shader to one that only requires rendering once.
void	removeShader ()
	Remove the shader from the image, if any exists.
void	setRender (const Renderable &renderable)
	Change the current rendered object.
Public Member Functions inherited from ui::Widget
	Widget (const Position &pos={0, 0}, const Alignment &align={ALIGN_LEFT, ALIGN_TOP}, const Padding &padding={0})
	The default widget constructor.
virtual void	render (bool force) const
	Recursively render this widget and any child widgets that need it.
virtual	~Widget ()
	The default widget destructor.
virtual Bounds	bounds () const
	Get the rendering bounds of this widget.
void	setPosition (const Position &pos)
	Set the position of this widget.
Position	getPosition () const
	Get the position of this widget.
void	setAlign (const Alignment &align)
	Set the alignment of this widget.
void	requestRedraw ()
	Tell this widget that it needs to be re-rendered.
void	requestParentRedraw ()
	Tell the parent widget that it needs to be re-rendered.
bool	needsRedraw () const
	Check if this widget has requested to be redrawn.
virtual void	drawDone ()
	Reset any state variables after rendering has finished.
void	setParent (Widget *parent)
	Set the parent widget.
Bounds	parentBounds () const
	Get the bounds of the parent widget, if any.
void	onpress (std::function< void(Widget &, const Event &)> callback) override
	Register a touchscreen event handler that triggers on press.
void	onblur (std::function< void(Widget &, const Event &)> callback) override
	Register a touchscreen event handler that triggers when the widget stops being pressed.
void	onhold (std::function< void(Widget &, const Event &, time_t)> callback) override
	Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
void	onrelease (std::function< void(Widget &, const Event &)> callback) override
	Register a touchscreen event handler that triggers on release.
void	click ()
	Manually trigger the onrelease event handler.
void	press ()
	Manually trigger the onpress event handler.
void	blur ()
	Manually trigger the onblur event handler.
void	release ()
	Manually trigger the onrelease event handler.
void	hold (time_t time)
	Manually trigger the onhold event handler.
virtual bool	handleEvent (Event &event)
	Handle events from the touchscreen.
virtual void	drawBoundingBox (time_t time) const
	Render the bounding box of this and any child widgets.
virtual Widget *	getWidgetById (id_t id) noexcept
	Get the first widget (this or any children) that has the given ID.
Public Member Functions inherited from ui::EventHandlers< Widget >
void	onpress (std::function< void(Widget &)> callback)
	Register a touchscreen event handler that triggers on press.
void	onpress (std::function< void(const Event &)> callback)
	Register a touchscreen event handler that triggers on press.
void	onpress (std::function< void()> callback)
	Register a touchscreen event handler that triggers on press.
void	onrelease (std::function< void(Widget &)> callback)
	Register a touchscreen event handler that triggers when the widget stops being pressed.
void	onrelease (std::function< void(const Event &)> callback)
	Register a touchscreen event handler that triggers when the widget stops being pressed.
void	onrelease (std::function< void()> callback)
	Register a touchscreen event handler that triggers when the widget stops being pressed.
void	onblur (std::function< void(Widget &)> callback)
	Register a touchscreen event handler that triggers when the widget stops being pressed.
void	onblur (std::function< void(const Event &)> callback)
	Register a touchscreen event handler that triggers when the widget stops being pressed.
void	onblur (std::function< void()> callback)
	Register a touchscreen event handler that triggers when the widget stops being pressed.
void	onhold (std::function< void(Widget &, time_t)> callback)
	Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
void	onhold (std::function< void(const Event &, time_t)> callback)
	Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
void	onhold (std::function< void(time_t)> callback)
	Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
void	onhold (std::function< void(Widget &)> callback)
	Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
void	onhold (std::function< void(const Event &)> callback)
	Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
void	onhold (std::function< void()> callback)
	Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
void	onclick (std::function< void(Widget &)> callback)
	Register a touchscreen event handler that triggers on release.
void	onclick (std::function< void(const Event &)> callback)
	Register a touchscreen event handler that triggers on release.
void	onclick (std::function< void()> callback)
	Register a touchscreen event handler that triggers on release.
Public Member Functions inherited from ui::CoreEventHandlers< T >
virtual void	onpress (std::function< void(T &, const Event &)> callback)=0
	Register a touchscreen event handler that triggers on press.
virtual void	onrelease (std::function< void(T &, const Event &)> callback)=0
	Register a touchscreen event handler that triggers when the widget stops being pressed.
virtual void	onblur (std::function< void(T &, const Event &)> callback)=0
	Register a touchscreen event handler that triggers when the widget stops being pressed.
virtual void	onhold (std::function< void(T &, const Event &, time_t)> callback)=0
	Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
void	onclick (std::function< void(T &, const Event &)> callback)
	Register a touchscreen event handler that triggers on release.

Additional Inherited Members
Public Attributes inherited from ui::Widget
id_t	id
	An optional (usually unique) identifier that can be used to search for this widget.
Protected Attributes inherited from ui::Widget
Padding	padding
	The padding that will be applied to any child widgets.
bool	redrawSelf
	If true, force a redraw of this widget and any child widgets.

Detailed Description

Display an arbitrary (non-animated) renderable to the screen with an optional shader.

Constructor & Destructor Documentation

Image()

ui::Image::Image	(	const Renderable &	renderable,
		const Position &	pos = {0, 0},
		const Alignment &	align = {ALIGN_LEFT, ALIGN_TOP}
	)

Construct an image from some renderable data.

Parameters

renderable	The data that will be rendered to the screen.
pos	The position of this image relative to its parent.
align	The alignment of this image relative to its parent.

Member Function Documentation

draw()

void ui::Image::draw ( ) const

overridevirtual

Render the widget to the screen.

This only gets called when widgets indicate that a redraw is needed of either themselves or their parents. Widgets that implement this method should only render graphics specific to this widget, not any children.

Implements ui::Widget.

setRender()

void ui::Image::setRender

(

const Renderable &

renderable

)

Change the current rendered object.

Parameters

renderable

The render target.

setShader() [1/2]

void ui::Image::setShader

(

const shader_animated_t &

shader

)

Set the image shader to a new one that requires re-rendering every frame.

Parameters

shader

The new shader.

setShader() [2/2]

void ui::Image::setShader

(

const shader_oneframe_t &

shader

)

Set the image shader to one that only requires rendering once.

Parameters

shader

The new shader.

size()

Size ui::Image::size ( ) const

overridevirtual

Get the size of the widget.

Returns

The width and height of the widget in pixels.

Warning

This value may be based on the size of the child widget, and so should never refer to the size of the parent widget!

Implements ui::Widget.

update()

void ui::Image::update ( time_t  time )

overridevirtual

Update any internal state of the widget, and check if it needs to be re-rendered.

Parameters

time	The current time in milliseconds.

Reimplemented from ui::Widget.

---

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

• src/ui/image.hpp