Primary GUI class. More...

#include <GuiElement.h>

Inheritance diagram for GuiElement:

Public Member Functions
	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.

virtual void	draw ()=0
	Called constantly to redraw the element.

Protected Attributes
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

Primary GUI class.

Most other classes inherit from this class.

Definition at line 60 of file GuiElement.h.

Constructor & Destructor Documentation

◆ GuiElement()

GuiElement::GuiElement ( )

Constructor.

Definition at line 9 of file GuiElement.cpp.

◆ ~GuiElement()

GuiElement::~GuiElement ( )

virtual

Destructor.

Definition at line 51 of file GuiElement.cpp.

Member Function Documentation

◆ collectNavigable()

void GuiElement::collectNavigable ( std::vector< GuiElement * > & out )

virtual

Appends the elements that selection can move between (default: this element; layout containers add their children instead, so the D-pad moves through them)

Reimplemented in GuiLayout.

Definition at line 596 of file GuiElement.cpp.

◆ draw()

virtual void GuiElement::draw ( )

pure virtual

Called constantly to redraw the element.

Implemented in GuiButton, GuiControllerView, GuiFileBrowser, GuiGlyph, GuiImage, GuiLayout, GuiOptionBrowser, GuiShape, GuiText, GuiWindow, and UiScope::Runner.

◆ getAlpha()

int GuiElement::getAlpha ( )

Gets the element's alpha value Considers alpha, alphaDyn, and the parent element's GetAlpha() value.

Returns: alpha

Definition at line 202 of file GuiElement.cpp.

◆ getEffect()

int GuiElement::getEffect ( )

Gets the current element effects.

Returns: element effects

Definition at line 382 of file GuiElement.cpp.

◆ getHeight()

int GuiElement::getHeight ( )

Gets the height of the element.

Does not currently consider the scale

Returns: height

Definition at line 175 of file GuiElement.cpp.

◆ getLeft()

int GuiElement::getLeft ( )

Gets the current leftmost coordinate of the element Considers horizontal alignment, x offset, width, and parent element's GetLeft() / GetWidth() values.

Returns: left coordinate

Definition at line 68 of file GuiElement.cpp.

◆ getMaxX()

int GuiElement::getMaxX ( )

Gets the maximum x offset of the element.

Returns: Maximum X offset

Definition at line 145 of file GuiElement.cpp.

◆ getMaxY()

int GuiElement::getMaxY ( )

Gets the maximum y offset of the element.

Returns: Maximum Y offset

Definition at line 165 of file GuiElement.cpp.

◆ getMinX()

int GuiElement::getMinX ( )

Gets the minimum x offset of the element.

Returns: Minimum X offset

Definition at line 135 of file GuiElement.cpp.

◆ getMinY()

int GuiElement::getMinY ( )

Gets the minimum y offset of the element.

Returns: Minimum Y offset

Definition at line 155 of file GuiElement.cpp.

◆ getNaturalSize()

void GuiElement::getNaturalSize	(	int &	w,
		int &	h )

virtual

Layout protocol: how a layout container (GuiRow, GuiColumn, GuiGrid, GuiOverlay) asks about and arranges its children.

The defaults suit any element with a size. Gets the size the element wants when laid out (default: its width and height)

Reimplemented in GuiLayout, and GuiText.

Definition at line 574 of file GuiElement.cpp.

◆ getParent()

GuiElement * GuiElement::getParent ( )

Gets the element's parent.

Returns: Pointer to parent element

Definition at line 63 of file GuiElement.cpp.

◆ getScale()

float GuiElement::getScale ( )

Gets the element's current scale Considers scale, scaleDyn, and the parent element's GetScale() value.

Definition at line 244 of file GuiElement.cpp.

◆ getScaleX()

float GuiElement::getScaleX ( )

Gets the element's current x scale Considers scale, scaleDyn, and the parent element's GetScale() value.

Definition at line 254 of file GuiElement.cpp.

◆ getScaleY()

float GuiElement::getScaleY ( )

Gets the element's current y scale Considers scale, scaleDyn, and the parent element's GetScale() value.

Definition at line 264 of file GuiElement.cpp.

◆ getSelected()

int GuiElement::getSelected ( )

virtual

Gets whether or not the element is in STATE::SELECTED.

Returns: true if selected, false otherwise

Reimplemented in GuiWindow.

Definition at line 557 of file GuiElement.cpp.

◆ getState()

STATE GuiElement::getState ( )

Gets the element's current state.

Returns: state

Definition at line 274 of file GuiElement.cpp.

◆ getStateChan()

int GuiElement::getStateChan ( )

Gets the controller channel that last changed the element's state.

Returns: Channel number (0-3, -1 = no channel)

Definition at line 279 of file GuiElement.cpp.

◆ getTop()

int GuiElement::getTop ( )

Gets the current topmost coordinate of the element Considers vertical alignment, y offset, height, and parent element's GetTop() / GetHeight() values.

Returns: top coordinate

Definition at line 99 of file GuiElement.cpp.

◆ getWidth()

int GuiElement::getWidth ( )

Gets the current width of the element.

Does not currently consider the scale

Returns: width

Definition at line 170 of file GuiElement.cpp.

◆ isClickable()

bool GuiElement::isClickable ( )

Checks whether or not the element is clickable.

Returns: true if clickable, false otherwise

Definition at line 322 of file GuiElement.cpp.

◆ isFocused()

int GuiElement::isFocused ( )

Checks whether the element is in focus.

Returns: true if element is in focus, false otherwise

Definition at line 345 of file GuiElement.cpp.

◆ isHoldable()

bool GuiElement::isHoldable ( )

Checks whether or not the element is holdable.

Returns: true if holdable, false otherwise

Definition at line 332 of file GuiElement.cpp.

◆ isInside()

bool GuiElement::isInside	(	int	x,
		int	y )

Checks whether the specified coordinates are within the element's boundaries.

Parameters

x	X coordinate
y	Y coordinate

Returns: true if contained within, false otherwise

Definition at line 566 of file GuiElement.cpp.

◆ isRumble()

bool GuiElement::isRumble ( )

Checks whether rumble was requested by the element.

Returns: true is rumble was requested, false otherwise

Definition at line 372 of file GuiElement.cpp.

◆ isSelectable()

bool GuiElement::isSelectable ( )

Checks whether or not the element is selectable.

Returns: true if selectable, false otherwise

Definition at line 314 of file GuiElement.cpp.

◆ isVisible()

bool GuiElement::isVisible ( )

Checks whether or not the element is visible.

Returns: true if visible, false otherwise

Definition at line 187 of file GuiElement.cpp.

◆ layout()

void GuiElement::layout ( )

virtual

Brings the element's own layout up to date.

Containers call this on their children first, so nested layouts settle in a single pass (default: nothing to do).

Reimplemented in GuiLayout.

Definition at line 592 of file GuiElement.cpp.

◆ remove()

virtual void GuiElement::remove ( GuiElement * )

inlinevirtual

Removes the specified child.

Reimplemented in GuiLayout, and GuiWindow.

Definition at line 74 of file GuiElement.h.

◆ resetState()

void GuiElement::resetState ( )

virtual

Resets the element's state to STATE::DEFAULT.

Reimplemented in GuiButton, GuiFileBrowser, GuiOptionBrowser, and GuiWindow.

Definition at line 290 of file GuiElement.cpp.

◆ resetText()

void GuiElement::resetText ( )

virtual

Called when the language has changed, to obtain new text values for all text elements.

Reimplemented in GuiButton, GuiOptionBrowser, GuiText, and GuiWindow.

Definition at line 562 of file GuiElement.cpp.

◆ setAlignment()

void GuiElement::setAlignment	(	ALIGN_H	hor,
		ALIGN_V	vert )

virtual

Sets the element's alignment respective to its parent element.

Parameters

hor	Horizontal alignment (LEFT, RIGHT, CENTRE)
vert	Vertical alignment (TOP, BOTTOM, MIDDLE)

Reimplemented in GuiText.

Definition at line 551 of file GuiElement.cpp.

◆ setAlpha()

void GuiElement::setAlpha ( int a )

Sets the element's alpha value.

Parameters

a	alpha value

Definition at line 197 of file GuiElement.cpp.

◆ setClickable()

void GuiElement::setClickable ( bool c )

Sets whether or not the element is clickable.

Parameters

c Clickable

Definition at line 299 of file GuiElement.cpp.

◆ setEffect()

void GuiElement::setEffect	(	int	e,
		int	a,
		int	t = 0 )

Set an effect for the element.

Parameters

e	Effect to enable
a	Amount of the effect (usage varies on effect)
t	Target amount of the effect (usage varies on effect)

Definition at line 387 of file GuiElement.cpp.

◆ setEffectGrow()

void GuiElement::setEffectGrow ( )

Shortcut to SetEffectOnOver(EFFECT::SCALE, 4, 110)

Definition at line 421 of file GuiElement.cpp.

◆ setEffectOnOver()

void GuiElement::setEffectOnOver	(	int	e,
		int	a,
		int	t = 0 )

Sets an effect to be enabled on wiimote cursor over.

Parameters

e	Effect to enable
a	Amount of the effect (usage varies on effect)
t	Target amount of the effect (usage varies on effect)

Definition at line 414 of file GuiElement.cpp.

◆ setFocus()

void GuiElement::setFocus ( int f )

virtual

Sets the element's focus.

Parameters

f	Focus (true = in focus)

Reimplemented in GuiFileBrowser, GuiOptionBrowser, and GuiWindow.

Definition at line 340 of file GuiElement.cpp.

◆ setHoldable()

void GuiElement::setHoldable ( bool h )

Sets whether or not the element is holdable.

Parameters

h Holdable

Definition at line 309 of file GuiElement.cpp.

◆ setLayoutPosition()

void GuiElement::setLayoutPosition	(	int	x,
		int	y )

virtual

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)

Definition at line 580 of file GuiElement.cpp.

◆ setLayoutSize()

void GuiElement::setLayoutSize	(	int	w,
		int	h )

virtual

Gives the element a size chosen by a container (default: sets width and height)

Reimplemented in GuiLayout.

Definition at line 586 of file GuiElement.cpp.

◆ setMaxX()

void GuiElement::setMaxX ( int x )

Sets the maximum x offset of the element.

Parameters

x X offset

Definition at line 140 of file GuiElement.cpp.

◆ setMaxY()

void GuiElement::setMaxY ( int y )

Sets the maximum y offset of the element.

Parameters

y Y offset

Definition at line 160 of file GuiElement.cpp.

◆ setMinX()

void GuiElement::setMinX ( int x )

Sets the minimum x offset of the element.

Parameters

x X offset

Definition at line 130 of file GuiElement.cpp.

◆ setMinY()

void GuiElement::setMinY ( int y )

Sets the minimum y offset of the element.

Parameters

y Y offset

Definition at line 150 of file GuiElement.cpp.

◆ setParent()

void GuiElement::setParent ( GuiElement * e )

Set the element's parent.

Parameters

e	Pointer to parent element

Definition at line 58 of file GuiElement.cpp.

◆ setPosition()

void GuiElement::setPosition	(	int	x,
		int	y )

Sets the element's position.

Parameters

x	X coordinate
y	Y coordinate

Definition at line 545 of file GuiElement.cpp.

◆ setRemoveOnDestroy()

void GuiElement::setRemoveOnDestroy ( bool autoRemove )

inline

Whether to notify parent on destruction to allow removal.

Definition at line 76 of file GuiElement.h.

◆ setRumble()

void GuiElement::setRumble ( bool r )

Sets whether or not the element is requesting a rumble event.

Parameters

r	true if requesting rumble, false if not

Definition at line 377 of file GuiElement.cpp.

◆ setScale() [1/2]

void GuiElement::setScale ( float s )

Sets the element's x and y scale.

Parameters

s	scale (1 is 100%)

Definition at line 215 of file GuiElement.cpp.

◆ setScale() [2/2]

void GuiElement::setScale	(	int	w,
		int	h )

Sets the element's x and y scale, using the provided max width/height.

Parameters

w	Maximum width
h	Maximum height

Definition at line 231 of file GuiElement.cpp.

◆ setScaleX()

void GuiElement::setScaleX ( float s )

Sets the element's x scale.

Parameters

s	scale (1 is 100%)

Definition at line 221 of file GuiElement.cpp.

◆ setScaleY()

void GuiElement::setScaleY ( float s )

Sets the element's y scale.

Parameters

s	scale (1 is 100%)

Definition at line 226 of file GuiElement.cpp.

◆ setSelectable()

void GuiElement::setSelectable ( bool s )

Sets whether or not the element is selectable.

Parameters

s	Selectable

Definition at line 304 of file GuiElement.cpp.

◆ setSize()

void GuiElement::setSize	(	int	w,
		int	h )

Sets the size (width/height) of the element.

Parameters

w	Width of element
h	Height of element

Definition at line 180 of file GuiElement.cpp.

◆ setState()

void GuiElement::setState	(	STATE	s,
		int	c = -1 )

virtual

Sets the element's state.

Parameters

s	State (STATE::DEFAULT, STATE::SELECTED, STATE::CLICKED, STATE::DISABLED)
c	Controller channel (0-3, -1 = none)

Reimplemented in GuiButton, and GuiWindow.

Definition at line 284 of file GuiElement.cpp.

◆ setTrigger() [1/2]

void GuiElement::setTrigger ( GuiTrigger * t )

Set a new GuiTrigger for the element.

Parameters

t	Pointer to GuiTrigger

Definition at line 350 of file GuiElement.cpp.

◆ setTrigger() [2/2]

void GuiElement::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.

Parameters

i	Index of trigger array to set
t	Pointer to GuiTrigger

Definition at line 366 of file GuiElement.cpp.

◆ setUpdateCallback()

void GuiElement::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.

Definition at line 540 of file GuiElement.cpp.

◆ setVisible()

void GuiElement::setVisible ( bool v )

virtual

Sets the element's visibility.

Parameters

v	Visibility (true = visible)

Reimplemented in GuiWindow.

Definition at line 192 of file GuiElement.cpp.

◆ update()

void GuiElement::update ( InputController * c )

virtual

Called constantly to allow the element to respond to the current input data.

Parameters

c	Pointer to a InputController, containing the current input data

Reimplemented in GuiButton, GuiFileBrowser, GuiKeyboard, GuiLayout, GuiOptionBrowser, GuiWindow, and UiScope::Runner.

Definition at line 534 of file GuiElement.cpp.

◆ updateEffects()

void GuiElement::updateEffects ( )

Updates the element's effects (dynamic values) Called by Draw(), used for animation purposes.

Definition at line 426 of file GuiElement.cpp.

Member Data Documentation

◆ alignmentHor

ALIGN_H GuiElement::alignmentHor

protected

Horizontal element alignment, respective to parent element (LEFT, RIGHT, CENTRE)

Definition at line 289 of file GuiElement.h.

◆ alignmentVert

ALIGN_V GuiElement::alignmentVert

protected

Horizontal element alignment, respective to parent element (TOP, BOTTOM, MIDDLE)

Definition at line 290 of file GuiElement.h.

◆ alpha

int GuiElement::alpha

protected

Element alpha value (0-255)

Definition at line 278 of file GuiElement.h.

◆ alphaDyn

int GuiElement::alphaDyn

protected

Element alpha, dynamic (multiplied by alpha value for blending/fading effects)

Definition at line 279 of file GuiElement.h.

◆ clickable

bool GuiElement::clickable

protected

Whether or not this element is clickable (can change to CLICKED state)

Definition at line 294 of file GuiElement.h.

◆ effectAmount

int GuiElement::effectAmount

protected

Effect amount.

Used by different effects for different purposes

Definition at line 284 of file GuiElement.h.

◆ effectAmountOver

int GuiElement::effectAmountOver

protected

EffectAmount to set when wiimote cursor is over this element.

Definition at line 287 of file GuiElement.h.

◆ effects

int GuiElement::effects

protected

Currently enabled effect(s).

0 when no effects are enabled

Definition at line 283 of file GuiElement.h.

◆ effectsOver

int GuiElement::effectsOver

protected

Effects to enable when wiimote cursor is over this element.

Copied to effects variable on over event

Definition at line 286 of file GuiElement.h.

◆ effectTarget

int GuiElement::effectTarget

protected

Effect target amount.

Used by different effects for different purposes

Definition at line 285 of file GuiElement.h.

◆ effectTargetOver

int GuiElement::effectTargetOver

protected

EffectTarget to set when wiimote cursor is over this element.

Definition at line 288 of file GuiElement.h.

◆ focus

int GuiElement::focus

protected

Element focus (-1 = focus disabled, 0 = not focused, 1 = focused)

Definition at line 267 of file GuiElement.h.

◆ height

int GuiElement::height

protected

Element height.

Definition at line 269 of file GuiElement.h.

◆ holdable

bool GuiElement::holdable

protected

Whether or not this element is holdable (can change to HELD state)

Definition at line 295 of file GuiElement.h.

◆ parentElement

GuiElement* GuiElement::parentElement

protected

Parent element.

Definition at line 265 of file GuiElement.h.

◆ removeOnDestroy

bool GuiElement::removeOnDestroy

protected

Whether to instruct parent to remove this element when it is destroyed.

Definition at line 266 of file GuiElement.h.

◆ rumble

bool GuiElement::rumble

protected

Wiimote rumble (on/off) - set to on when this element requests a rumble event.

Definition at line 297 of file GuiElement.h.

◆ scaleDyn

float GuiElement::scaleDyn

protected

Element scale, dynamic (multiplied by alpha value for blending/fading effects)

Definition at line 282 of file GuiElement.h.

◆ selectable

bool GuiElement::selectable

protected

Whether or not this element selectable (can change to SELECTED state)

Definition at line 293 of file GuiElement.h.

◆ state

STATE GuiElement::state

protected

Element state (DEFAULT, SELECTED, CLICKED, DISABLED)

Definition at line 291 of file GuiElement.h.

◆ stateChan

int GuiElement::stateChan

protected

Which controller channel is responsible for the last change in state.

Definition at line 292 of file GuiElement.h.

◆ trigger

GuiTrigger* GuiElement::trigger[MAX_TRIGGERS]

protected

GuiTriggers (input actions) that this element responds to.

Definition at line 263 of file GuiElement.h.

◆ updateCB

UpdateCallback GuiElement::updateCB

protected

Callback function to call when this element is updated.

Definition at line 264 of file GuiElement.h.

◆ visible

bool GuiElement::visible

protected

Visibility of the element.

If false, Draw() is skipped

Definition at line 296 of file GuiElement.h.

◆ width

int GuiElement::width

protected

Element width.

Definition at line 268 of file GuiElement.h.

◆ xmax

int GuiElement::xmax

protected

Element's max X offset allowed.

Definition at line 275 of file GuiElement.h.

◆ xmin

int GuiElement::xmin

protected

Element's min X offset allowed.

Definition at line 274 of file GuiElement.h.

◆ xoffset

int GuiElement::xoffset

protected

Element X offset.

Definition at line 270 of file GuiElement.h.

◆ xoffsetDyn

int GuiElement::xoffsetDyn

protected

Element X offset, dynamic (added to xoffset value for animation effects)

Definition at line 276 of file GuiElement.h.

◆ xscale

float GuiElement::xscale

protected

Element X scale (1 = 100%)

Definition at line 280 of file GuiElement.h.

◆ ymax

int GuiElement::ymax

protected

Element's max Y offset allowed.

Definition at line 273 of file GuiElement.h.

◆ ymin

int GuiElement::ymin

protected

Element's min Y offset allowed.

Definition at line 272 of file GuiElement.h.

◆ yoffset

int GuiElement::yoffset

protected

Element Y offset.

Definition at line 271 of file GuiElement.h.

◆ yoffsetDyn

int GuiElement::yoffsetDyn

protected

Element Y offset, dynamic (added to yoffset value for animation effects)

Definition at line 277 of file GuiElement.h.

◆ yscale

float GuiElement::yscale

protected

Element Y scale (1 = 100%)

Definition at line 281 of file GuiElement.h.

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

source/libgui/GuiElement.h
source/libgui/GuiElement.cpp

libgui 2.01 libgui is a GUI library for the GameCube, Wii, and Wii U

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GuiElement()

◆ ~GuiElement()

Member Function Documentation

◆ collectNavigable()

◆ draw()

◆ getAlpha()

◆ getEffect()

◆ getHeight()

◆ getLeft()

◆ getMaxX()

◆ getMaxY()

◆ getMinX()

◆ getMinY()

◆ getNaturalSize()

◆ getParent()

◆ getScale()

◆ getScaleX()

◆ getScaleY()

◆ getSelected()

◆ getState()

◆ getStateChan()

◆ getTop()

◆ getWidth()

◆ isClickable()

◆ isFocused()

◆ isHoldable()

◆ isInside()

◆ isRumble()

◆ isSelectable()

◆ isVisible()

◆ layout()

◆ remove()

◆ resetState()

◆ resetText()

◆ setAlignment()

◆ setAlpha()

◆ setClickable()

◆ setEffect()

◆ setEffectGrow()

◆ setEffectOnOver()

◆ setFocus()

◆ setHoldable()

◆ setLayoutPosition()

◆ setLayoutSize()

◆ setMaxX()

◆ setMaxY()

◆ setMinX()

◆ setMinY()

◆ setParent()

◆ setPosition()

◆ setRemoveOnDestroy()

◆ setRumble()

◆ setScale() [1/2]

◆ setScale() [2/2]

◆ setScaleX()

◆ setScaleY()

◆ setSelectable()

◆ setSize()

◆ setState()

◆ setTrigger() [1/2]

◆ setTrigger() [2/2]

◆ setUpdateCallback()

◆ setVisible()

◆ update()

◆ updateEffects()

Member Data Documentation

◆ alignmentHor

◆ alignmentVert

◆ alpha

◆ alphaDyn

◆ clickable

◆ effectAmount

◆ effectAmountOver

◆ effects

◆ effectsOver

◆ effectTarget