Button Class Reference

Inheritance diagram for Button:

Collaboration diagram for Button:

Public Member Functions
	Button (std::string text, int button, bool dark=false, int size=20, int width=0)
void	render (Element *parent)
	display the current state of the display More...
bool	process (InputEvents *event)
	process any input that is received for this element More...
void	updateBounds ()
void	updateText (const char *inc_text)
const std::string	getText ()
Public Member Functions inherited from Element
virtual bool	process (InputEvents *event)
	process any input that is received for this element More...
virtual void	render (Element *parent)
	display the current state of the display More...
bool	onTouchDown (InputEvents *event)
bool	onTouchDrag (InputEvents *event)
bool	onTouchUp (InputEvents *event)
void	hide ()
void	unhide ()
void	renderBackground (bool fill=true)
void	append (Element *element)
void	remove (Element *element)
void	removeAll (bool moveToTrash=false)
void	position (int x, int y)
	position the element More...
void	recalcPosition (Element *parent)
CST_Rect	getBounds ()
CST_Renderer *	getRenderer ()
void	wipeAll (bool delSelf=false)
Element *	child (Element *child)
Element *	setPosition (int x, int y)
Element *	setAction (std::function< void()> func)
Element *	centerHorizontallyIn (Element *parent)
Element *	centerVerticallyIn (Element *parent)
Element *	centerIn (Element *parent)
Element *	setAbsolute (bool isAbs)
Element *	constrain (int flags, int padding=0)
Element *	animate (int durationIn, std::function< void(float)> onStep, std::function< void()> onFinish)
Element *	moveToFront ()
Element *	setTouchable (bool touchable)
void	screenshot (std::string path)
	Take a screenshot of this element and its children, and save it to the given path. More...

Static Public Member Functions
static std::string	getControllerButtonImageForPlatform (int button, bool isGray, bool isOutline)

Public Attributes
std::string	myLastSeenGamepad = ""
TextElement	text
Public Attributes inherited from Element
std::function< void()>	action = NULL
	the action to call (from binded callback) on touch or button selection https://stackoverflow.com/questions/14189440/c-class-member-callback-simple-examples More...
std::function< void(InputEvents *event)>	actionWithEvents = NULL
std::vector< Element * >	elements
	visible GUI child elements of this element More...
float	scale = 1.0f
bool	touchable = false
	whether or not this element can be touched (highlights bounds) More...
bool	dragging = false
	whether or not this element is currently being dragged More...
bool	needsRedraw = false
	whether or not this element needs the screen redrawn next time it's processed More...
int	futureRedrawCounter = 0
	whether this element needs a redraw for the next X redraws (decreases each time) (0 is no redraws) More...
int	lastMouseY = 0
	the last Y, X coordinate of the mouse (from a drag probably) More...
int	lastMouseX = 0
bool	hasBackground = false
rgb	backgroundColor = {0, 0, 0}
int	backgroundOpacity = 0xff
bool	isAbsolute = false
Element *	parent = NULL
	the parent element (can sometimes be null if it isn't set) More...
bool	hidden = false
	whether this element should skip rendering or not More...
bool	isProtected = false
int	elasticCounter = 0
	how much time is left in an elastic-type flick/scroll set by the last distance traveled in a scroll, and counts down every frame More...
int	width = 0
	width and height of this element (must be manually set, isn't usually calculated (but is in some cases, like text or images)) More...
int	height = 0
int	x = 0
int	y = 0
int	xAbs = 0
int	yAbs = 0
double	angle = 0
	rotation angle in degrees More...
int	xOff = 0
int	yOff = 0
int	cornerRadius = 0
std::vector< Constraint * >	constraints
std::vector< Animation * >	animations
bool	useColorMask = false
	whether or not to overlay a color mask on top of this element More...
CST_Color	maskColor = {0,0,0,0}
	The color to overlay on top. More...

Additional Inherited Members
Public Types inherited from Element
typedef Element	super

Detailed Description

Definition at line 6 of file Button.hpp.

Constructor & Destructor Documentation

Button()

Button::Button	(	std::string	text,
		int	button,
		bool	dark = false,
		int	size = 20,
		int	width = 0
	)

Definition at line 9 of file Button.cpp.

    : physical(button)
    , dark(dark)
    , icon(getControllerButtonImageForPlatform(button, !dark, false))
    , text(message, (size / SCALER), &colors[dark])
{
 
    super::append(&text);
    super::append(&icon);
 
    // on initialization, store the last gamepad info
    myLastSeenGamepad = "";
 
    icon.resize(text.height*1.5, text.height*1.5);
    
    if (shouldRenderGlossy()) {
        icon.hide();
    }
 
    fixedWidth = width;
 
    updateBounds();
 
    this->touchable = true;
    this->hasBackground = true;
 
    // protect "stack" children
    text.isProtected = icon.isProtected = true;
 
    if (dark)
    {
        backgroundColor = RootDisplay::mainDisplay->backgroundColor;
        backgroundColor.r += 0x25/255.0;
        backgroundColor.g += 0x25/255.0;
        backgroundColor.b += 0x25/255.0;
        // backgroundColor.r = fmin(backgroundColor.r, 1.0);
    }
    else
        backgroundColor = (rgb){ 0xee/255.0, 0xee/255.0, 0xee/255.0 };
}

Member Function Documentation

getControllerButtonImageForPlatform()

std::string Button::getControllerButtonImageForPlatform ( int  button, bool  isGray, bool  isOutline  )

static

Definition at line 78 of file Button.cpp.

{
    // grab the current gamepad info
    GamepadInfo& gamepad = InputEvents::getLastGamepadInfo();
 
    // find the button index in the gamepad.buttons array
    // TODO: use a hashmap instead of an array
    if (gamepad.buttons != nullptr) {
        for (int i = 0; i < TOTAL_BUTTONS; i++)
        {
            if (gamepad.buttons[i] == button)
            {
                auto outlineSuffix = isOutline ? "_outline" : "";
                auto graySuffix = isGray ? "_gray" : "";
                auto retVal = RAMFS "res/controllers/buttons/" + gamepad.prefix + "_" + gamepad.names[i] + outlineSuffix + graySuffix + ".svg";
                return retVal;
            }
        }
    }
    // if we didn't find it, return an empty string
    printf("Button %d not found in gamepad, returning empty string\n", button);
    return "";
}

getText()

const std::string Button::getText

(

)

Definition at line 180 of file Button.cpp.

{
    return this->text.text;
}

process()

bool Button::process ( InputEvents *  event )

virtual

process any input that is received for this element

Reimplemented from Element.

Definition at line 149 of file Button.cpp.

{
    if (event->isKeyDown() && this->physical != 0 && event->held(this->physical))
    {
        // invoke our action, since we saw a physical button press that matches!
        this->action();
        return true;
    }
 
    bool ret = false;
 
    // if the last gamepad is different from the current one, update the button image
    if (myLastSeenGamepad != InputEvents::lastGamepadKey)
    {
        if (shouldRenderGlossy()) {
            icon.hide();
            hasBackground = false; // we'll handle our own two-toned and outlined background drawing
            cornerRadius = fmin(25, height / 4); // bound the corner radius to the height of our darker highlight
        } else {
            auto newPath = getControllerButtonImageForPlatform(this->physical, !dark, false);
            icon.unhide();
            hasBackground = true;
            icon.loadPath(newPath);
            icon.resize(text.height*1.5, text.height*1.5);
        }
        myLastSeenGamepad = InputEvents::lastGamepadKey;
    }
 
    return super::process(event) || ret;
}

References Element::action, InputEvents::held(), Texture::loadPath(), Element::process(), and Texture::resize().

render()

void Button::render ( Element *  parent )

virtual

display the current state of the display

Reimplemented from Element.

Definition at line 102 of file Button.cpp.

{
    if (hidden) return;
 
    CST_SetDrawBlend(RootDisplay::renderer, true);
 
    this->recalcPosition(parent);
 
    if (shouldRenderGlossy()) {
        // draw a glossy button
        auto r = backgroundColor.r * 0xff;
        auto g = backgroundColor.g * 0xff;
        auto b = backgroundColor.b * 0xff;
 
        CST_roundedBoxRGBA(
            RootDisplay::renderer,
            xAbs, yAbs, xAbs + width, yAbs + height, cornerRadius,
            r, g, b, 0xff
        );
        // slightly darker overlay for the second half of the button
        auto darkenOffset = dark ? 0x10 : 0x00; // use a deeper color for dark buttons
        CST_roundedBoxRGBA(
            RootDisplay::renderer,
            xAbs, yAbs + height / 2, xAbs + width, yAbs + height, cornerRadius,
            0x00, 0x00, 0x00, 0x15 + darkenOffset
        );
        // inner white outline around the whole thing
        auto p = 0.5;
        CST_roundedRectangleRGBA(
            RootDisplay::renderer,
            xAbs+2*p, yAbs+2*p, xAbs + width - p, yAbs + height - p, cornerRadius,
            0xff, 0xff, 0xff, 0x40
        );
        // thicker outer gray outline
        CST_roundedRectangleRGBA(
            RootDisplay::renderer,
            xAbs, yAbs, xAbs + width, yAbs + height, cornerRadius,
            0x00, 0x00, 0x00, 0x80
        );
    }
 
    // render text/icon and bg if needed
    super::render(parent);
 
    CST_SetDrawBlend(RootDisplay::renderer, false);
}

References Element::hidden, Element::parent, Element::render(), and Element::width.

updateBounds()

void Button::updateBounds

(

)

Definition at line 50 of file Button.cpp.

{
    int PADDING = 10 / SCALER;
 
    int bWidth = PADDING * 0.5 * (icon.width != 0); // gap space between button
 
    if (shouldRenderGlossy()) {
        icon.position(0, 0); // the icon is the overlay, same size as the button
    } else {
        text.position(PADDING * 2 + bWidth + icon.width, PADDING);
        icon.position(PADDING * 1.7, PADDING + (text.height - icon.height) / 2);
    }
 
    this->width = (fixedWidth > 0) ? fixedWidth : text.width + PADDING * 4 + bWidth + (icon.hidden ? 0 : icon.width);
    this->height = text.height + PADDING * 2;
 
    if (shouldRenderGlossy()) {
        text.position(width / 2 - text.width / 2, PADDING); // y is already centered
    }
}

updateText()

void Button::updateText

(

const char *

inc_text

)

Definition at line 71 of file Button.cpp.

{
    this->text.setText(inc_text);
    this->text.update();
    updateBounds();
}

Member Data Documentation

myLastSeenGamepad

std::string Button::myLastSeenGamepad = ""

Definition at line 18 of file Button.hpp.

text

TextElement Button::text

Definition at line 20 of file Button.hpp.

---

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

• src/Button.hpp
• src/Button.cpp