GuiImage Class Reference

Display, manage, and manipulate images in the GUI. More...

#include <GuiImage.h>

Inheritance diagram for GuiImage:

Public Member Functions
	GuiImage ()
	Constructor.
	GuiImage (GuiImageData *img)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
	GuiImage (uint8_t *tex, int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets up a new image from the texture data specified.
	GuiImage (int w, int h, PixelColor c)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Creates an image with the specified color.
	~GuiImage ()
	Destructor.
void	setAngle (float a)
	Sets the image rotation angle for drawing.
void	setTile (int t)
	Sets the number of times to draw the image horizontally.
void	draw () override
	Constantly called to draw the image.
void	setImage (GuiImageData *img)
	Sets up a new image using the GuiImageData object specified.
void	setImage (uint8_t *img, int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void	setTexture (uint8_t *tex, int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void	setStripe (int s)
	Sets a stripe effect on the image, overlaying alpha blended rectangles Does not alter the image data.
Public Member Functions inherited from GuiElement
	GuiElement ()
	Constructor.
virtual	~GuiElement ()
	Destructor.
void	setParent (GuiElement *e)
	Set the element's parent.
GuiElement *	getParent ()
	Gets the element's parent.
virtual void	remove (GuiElement *)
	Removes the specified child.
void	setRemoveOnDestroy (bool autoRemove)
	Whether to notify parent on destruction to allow removal.
int	getLeft ()
	Gets the current leftmost coordinate of the element Considers horizontal alignment, x offset, width, and parent element's GetLeft() / GetWidth() values.
int	getTop ()
	Gets the current topmost coordinate of the element Considers vertical alignment, y offset, height, and parent element's GetTop() / GetHeight() values.
void	setMinY (int y)
	Sets the minimum y offset of the element.
int	getMinY ()
	Gets the minimum y offset of the element.
void	setMaxY (int y)
	Sets the maximum y offset of the element.
int	getMaxY ()
	Gets the maximum y offset of the element.
void	setMinX (int x)
	Sets the minimum x offset of the element.
int	getMinX ()
	Gets the minimum x offset of the element.
void	setMaxX (int x)
	Sets the maximum x offset of the element.
int	getMaxX ()
	Gets the maximum x offset of the element.
int	getWidth ()
	Gets the current width of the element.
int	getHeight ()
	Gets the height of the element.
void	setSize (int w, int h)
	Sets the size (width/height) of the element.
bool	isVisible ()
	Checks whether or not the element is visible.
bool	isSelectable ()
	Checks whether or not the element is selectable.
bool	isClickable ()
	Checks whether or not the element is clickable.
bool	isHoldable ()
	Checks whether or not the element is holdable.
void	setSelectable (bool s)
	Sets whether or not the element is selectable.
void	setClickable (bool c)
	Sets whether or not the element is clickable.
void	setHoldable (bool h)
	Sets whether or not the element is holdable.
STATE	getState ()
	Gets the element's current state.
int	getStateChan ()
	Gets the controller channel that last changed the element's state.
void	setAlpha (int a)
	Sets the element's alpha value.
int	getAlpha ()
	Gets the element's alpha value Considers alpha, alphaDyn, and the parent element's GetAlpha() value.
void	setScale (float s)
	Sets the element's x and y scale.
void	setScaleX (float s)
	Sets the element's x scale.
void	setScaleY (float s)
	Sets the element's y scale.
void	setScale (int w, int h)
	Sets the element's x and y scale, using the provided max width/height.
float	getScale ()
	Gets the element's current scale Considers scale, scaleDyn, and the parent element's GetScale() value.
float	getScaleX ()
	Gets the element's current x scale Considers scale, scaleDyn, and the parent element's GetScale() value.
float	getScaleY ()
	Gets the element's current y scale Considers scale, scaleDyn, and the parent element's GetScale() value.
void	setTrigger (GuiTrigger *t)
	Set a new GuiTrigger for the element.
void	setTrigger (uint8_t i, GuiTrigger *t)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	isRumble ()
	Checks whether rumble was requested by the element.
void	setRumble (bool r)
	Sets whether or not the element is requesting a rumble event.
void	setEffect (int e, int a, int t=0)
	Set an effect for the element.
void	setEffectOnOver (int e, int a, int t=0)
	Sets an effect to be enabled on wiimote cursor over.
void	setEffectGrow ()
	Shortcut to SetEffectOnOver(EFFECT::SCALE, 4, 110)
int	getEffect ()
	Gets the current element effects.
bool	isInside (int x, int y)
	Checks whether the specified coordinates are within the element's boundaries.
void	setPosition (int x, int y)
	Sets the element's position.
void	updateEffects ()
	Updates the element's effects (dynamic values) Called by Draw(), used for animation purposes.
void	setUpdateCallback (UpdateCallback u)
	Sets a function to called after after Update() Callback function can be used to response to changes in the state of the element, and/or update the element's attributes.
int	isFocused ()
	Checks whether the element is in focus.
virtual void	setVisible (bool v)
	Sets the element's visibility.
virtual void	setFocus (int f)
	Sets the element's focus.
virtual void	setState (STATE s, int c=-1)
	Sets the element's state.
virtual void	resetState ()
	Resets the element's state to STATE::DEFAULT.
virtual int	getSelected ()
	Gets whether or not the element is in STATE::SELECTED.
virtual void	setAlignment (ALIGN_H hor, ALIGN_V vert)
	Sets the element's alignment respective to its parent element.
virtual void	getNaturalSize (int &w, int &h)
	Layout protocol: how a layout container (GuiRow, GuiColumn, GuiGrid, GuiOverlay) asks about and arranges its children.
virtual void	setLayoutPosition (int x, int y)
	Places the element so its top-left corner is at (x, y) relative to its parent's top-left (default: LEFT/TOP alignment plus an offset)
virtual void	setLayoutSize (int w, int h)
	Gives the element a size chosen by a container (default: sets width and height)
virtual void	layout ()
	Brings the element's own layout up to date.
virtual void	collectNavigable (std::vector< GuiElement * > &out)
	Appends the elements that selection can move between (default: this element; layout containers add their children instead, so the D-pad moves through them)
virtual void	resetText ()
	Called when the language has changed, to obtain new text values for all text elements.
virtual void	update (InputController *c)
	Called constantly to allow the element to respond to the current input data.

Protected Attributes
IMAGE	imgType
	Type of image data (TEXTURE, COLOR)
void *	texture
	Attached platform-native texture.
bool	ownsTexture
	Whether this object created texture itself (TEXTURE/COLOR) or borrowed it from a GuiImageData.
float	imageangle
	Angle to draw the image.
int	tile
	Number of times to draw (tile) the image horizontally.
int	stripe
	Alpha value (0-255) to apply a stripe effect to the texture.
PixelColor	baseColor
	Stored color for IMAGE::COLOR types.
Protected Attributes inherited from GuiElement
GuiTrigger *	trigger [MAX_TRIGGERS]
	GuiTriggers (input actions) that this element responds to.
UpdateCallback	updateCB
	Callback function to call when this element is updated.
GuiElement *	parentElement
	Parent element.
bool	removeOnDestroy
	Whether to instruct parent to remove this element when it is destroyed.
int	focus
	Element focus (-1 = focus disabled, 0 = not focused, 1 = focused)
int	width
	Element width.
int	height
	Element height.
int	xoffset
	Element X offset.
int	yoffset
	Element Y offset.
int	ymin
	Element's min Y offset allowed.
int	ymax
	Element's max Y offset allowed.
int	xmin
	Element's min X offset allowed.
int	xmax
	Element's max X offset allowed.
int	xoffsetDyn
	Element X offset, dynamic (added to xoffset value for animation effects)
int	yoffsetDyn
	Element Y offset, dynamic (added to yoffset value for animation effects)
int	alpha
	Element alpha value (0-255)
int	alphaDyn
	Element alpha, dynamic (multiplied by alpha value for blending/fading effects)
float	xscale
	Element X scale (1 = 100%)
float	yscale
	Element Y scale (1 = 100%)
float	scaleDyn
	Element scale, dynamic (multiplied by alpha value for blending/fading effects)
int	effects
	Currently enabled effect(s).
int	effectAmount
	Effect amount.
int	effectTarget
	Effect target amount.
int	effectsOver
	Effects to enable when wiimote cursor is over this element.
int	effectAmountOver
	EffectAmount to set when wiimote cursor is over this element.
int	effectTargetOver
	EffectTarget to set when wiimote cursor is over this element.
ALIGN_H	alignmentHor
	Horizontal element alignment, respective to parent element (LEFT, RIGHT, CENTRE)
ALIGN_V	alignmentVert
	Horizontal element alignment, respective to parent element (TOP, BOTTOM, MIDDLE)
STATE	state
	Element state (DEFAULT, SELECTED, CLICKED, DISABLED)
int	stateChan
	Which controller channel is responsible for the last change in state.
bool	selectable
	Whether or not this element selectable (can change to SELECTED state)
bool	clickable
	Whether or not this element is clickable (can change to CLICKED state)
bool	holdable
	Whether or not this element is holdable (can change to HELD state)
bool	visible
	Visibility of the element.
bool	rumble
	Wiimote rumble (on/off) - set to on when this element requests a rumble event.

Detailed Description

Display, manage, and manipulate images in the GUI.

Definition at line 17 of file GuiImage.h.

Constructor & Destructor Documentation

GuiImage() [1/4]

GuiImage::GuiImage

(

)

Constructor.

Definition at line 10 of file GuiImage.cpp.

GuiImage() [2/4]

GuiImage::GuiImage

(

GuiImageData *

img

)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

img	Pointer to GuiImageData element

Definition at line 22 of file GuiImage.cpp.

GuiImage() [3/4]

GuiImage::GuiImage	(	uint8_t *	tex,
		int	w,
		int	h )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets up a new image from the texture data specified.

Parameters

tex	Texture data
w	Image width
h	Image height

Definition at line 42 of file GuiImage.cpp.

GuiImage() [4/4]

GuiImage::GuiImage	(	int	w,
		int	h,
		PixelColor	c )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Creates an image with the specified color.

Parameters

w	Image width
h	Image height
c	Image color

Definition at line 54 of file GuiImage.cpp.

~GuiImage()

GuiImage::~GuiImage

(

)

Destructor.

Definition at line 67 of file GuiImage.cpp.

Member Function Documentation

draw()

void GuiImage::draw ( )

overridevirtual

Constantly called to draw the image.

Implements GuiElement.

Definition at line 152 of file GuiImage.cpp.

setAngle()

void GuiImage::setAngle

(

float

a

)

Sets the image rotation angle for drawing.

Parameters

a	Angle (in degrees)

Definition at line 137 of file GuiImage.cpp.

setImage() [1/2]

void GuiImage::setImage

(

GuiImageData *

img

)

Sets up a new image using the GuiImageData object specified.

Parameters

img	Pointer to GuiImageData object

Definition at line 76 of file GuiImage.cpp.

setImage() [2/2]

void GuiImage::setImage	(	uint8_t *	img,
		int	w,
		int	h )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

img	Pointer to (generic row-major RGBA8) image data
w	Width
h	Height

Definition at line 97 of file GuiImage.cpp.

setStripe()

void GuiImage::setStripe

(

int

s

)

Sets a stripe effect on the image, overlaying alpha blended rectangles Does not alter the image data.

Parameters

s	Alpha amount to draw over the image

Definition at line 147 of file GuiImage.cpp.

setTexture()

void GuiImage::setTexture	(	uint8_t *	tex,
		int	w,
		int	h )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

tex	Pointer to platform-native texture
w	Width
h	Height

Definition at line 122 of file GuiImage.cpp.

setTile()

void GuiImage::setTile

(

int

t

)

Sets the number of times to draw the image horizontally.

Parameters

t	Number of times to draw the image

Definition at line 142 of file GuiImage.cpp.

Member Data Documentation

baseColor

PixelColor GuiImage::baseColor

protected

Stored color for IMAGE::COLOR types.

Definition at line 71 of file GuiImage.h.

imageangle

float GuiImage::imageangle

protected

Angle to draw the image.

Definition at line 68 of file GuiImage.h.

imgType

IMAGE GuiImage::imgType

protected

Type of image data (TEXTURE, COLOR)

Definition at line 65 of file GuiImage.h.

ownsTexture

bool GuiImage::ownsTexture

protected

Whether this object created texture itself (TEXTURE/COLOR) or borrowed it from a GuiImageData.

Definition at line 67 of file GuiImage.h.

stripe

int GuiImage::stripe

protected

Alpha value (0-255) to apply a stripe effect to the texture.

Definition at line 70 of file GuiImage.h.

texture

void* GuiImage::texture

protected

Attached platform-native texture.

Definition at line 66 of file GuiImage.h.

tile

int GuiImage::tile

protected

Number of times to draw (tile) the image horizontally.

Definition at line 69 of file GuiImage.h.

---

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

• source/libgui/GuiImage.h
• source/libgui/GuiImage.cpp