Chesto::Grid Class Reference

Inheritance diagram for Chesto::Grid:

Collaboration diagram for Chesto::Grid:

Public Member Functions
	Grid (int columns, int width, int cellPadding=0, int rowPadding=0)
void	refresh ()
	Recalculate positions for all child elements.
bool	process (InputEvents *event) override
	process any input that is received for this element
Public Member Functions inherited from Chesto::Element
virtual void	render (Element *parent)
	display the current state of the display
bool	onTouchDown (InputEvents *event)
bool	onTouchDrag (InputEvents *event)
bool	onTouchUp (InputEvents *event)
void	hide ()
void	unhide ()
void	renderBackground (bool fill=true)
void	addNode (std::unique_ptr< Element > node)
void	remove (Element *element)
void	removeAll ()
void	position (int x, int y)
	position the element
void	recalcPosition (Element *parent)
float	getEffectiveScale () const
CST_Rect	getBounds ()
CST_Renderer *	getRenderer ()
Element *	setPosition (int x, int y)
Element *	setAction (std::function< void()> func)
Element *	setAbsolute (bool isAbs)
template<typename T , typename... Args>
T *	createNode (Args &&... args)
Element *	constrain (int flags, int padding=0)
Element *	constrainToTarget (Element *target, 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.

Public Attributes
int	columns
int	width
int	cellPadding
int	rowPadding
int	highlighted = -1
	Cursor state.
bool	touchMode = true
Public Attributes inherited from Chesto::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
std::function< void(InputEvents *event)>	actionWithEvents = NULL
std::vector< std::unique_ptr< Element, std::function< void(Element *)> > >	elements
	visible GUI child elements of this element
float	scale = 1.0f
bool	touchable = false
	whether or not this element can be touched (highlights bounds)
bool	dragging = false
	whether or not this element is currently being dragged
bool	needsRedraw = false
	whether or not this element needs the screen redrawn next time it's processed
int	futureRedrawCounter = 0
	whether this element needs a redraw for the next X redraws (decreases each time) (0 is no redraws)
int	lastMouseY = 0
	the last Y, X coordinate of the mouse (from a drag probably)
int	lastMouseX = 0
bool	hasBackground = false
rgb	backgroundColor = {0, 0, 0}
int	backgroundOpacity = 0xff
bool	isAbsolute = false
Element *	parent = nullptr
	the parent element (reference only, not owned)
bool	hidden = false
	whether this element should skip rendering or not
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
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))
int	height = 0
int	x = 0
int	y = 0
int	xAbs = 0
int	yAbs = 0
double	angle = 0
	rotation angle in degrees
int	cornerRadius = 0
int	tag = 0
std::vector< std::unique_ptr< Constraint > >	constraints
std::vector< std::unique_ptr< Animation > >	animations
bool	useColorMask = false
	whether or not to overlay a color mask on top of this element
CST_Color	maskColor = {0,0,0,0}
	The color to overlay on top.

Additional Inherited Members
Public Types inherited from Chesto::Element
typedef Element	super
Protected Member Functions inherited from Chesto::Element
void	addStackMember (Element *element)

Detailed Description

Definition at line 8 of file Grid.hpp.

Constructor & Destructor Documentation

Grid()

Chesto::Grid::Grid	(	int	columns,
		int	width,
		int	cellPadding = 0,
		int	rowPadding = 0
	)

The Grid component is similar to Container in that it has to deal with positioning its child elements, but unlike container, it is designed to take in the full list of elements, and then arrange them based on some fixed width.

Calling refresh rebuilds the grid, again according to the width and its elements, which allows for reflowing when container sizes change.

Definition at line 14 of file Grid.cpp.

    : columns(columns)
    , width(width)
    , cellPadding(cellPadding)
    , rowPadding(rowPadding)
{
    this->width = width;
    this->height = 0; // calculated on refresh()
}

Member Function Documentation

process()

bool Chesto::Grid::process ( InputEvents *  event )

overridevirtual

process any input that is received for this element

Reimplemented from Chesto::Element.

Definition at line 72 of file Grid.cpp.

{
    // This method lets the children elements handle their
    // touch events, but manages grid-like cursor navigation    
    bool ret = false;
    
    // normal event handling
    ret |= Element::process(event);
    
    if (elements.empty()) {
        return ret;
    }
    
    if (touchMode) {
        return ret;
    }
    
    // cursor logic from HBAS's AppList
    // int origHighlighted = highlighted;
    
    // start highlight if none
    if (highlighted < 0 && !elements.empty()) {
        highlighted = 0;
    }
    
    // ensure highlighted is in bounds
    if (highlighted >= (int)elements.size()) {
        highlighted = elements.size() - 1;
    }
 
    // TODO: fiinsh grid navigation logic
    ret = true;
    
    return ret;
}

References Chesto::Element::elements, highlighted, and Chesto::Element::process().

refresh()

void Chesto::Grid::refresh

(

)

Recalculate positions for all child elements.

Definition at line 24 of file Grid.cpp.

{
    if (elements.empty()) {
        this->height = 0;
        return;
    }
    
    // calculate cell width: (total width - padding between cells) / columns
    int cellWidth = (this->width - (cellPadding * (columns - 1))) / columns;
    
    int xPos = 0;
    int yPos = 0;
    int currentRowHeight = 0;
    int col = 0;
    
    for (auto& elem : elements) {
        // actually position the element
        elem->x = xPos;
        elem->y = yPos;
        
        // the tallest element in this row
        if (elem->height > currentRowHeight) {
            currentRowHeight = elem->height;
        }
        
        // advance column
        col++;
        xPos += cellWidth + cellPadding;
        
        // do we need to start a new row?
        if (col >= columns) {
            col = 0;
            xPos = 0;
            yPos += currentRowHeight + rowPadding;
            currentRowHeight = 0;
        }
    }
    
    // final grid height
    if (col > 0) {
        yPos += currentRowHeight; // commit last row height
    } else if (yPos > 0) {
        yPos -= rowPadding;
    }
    
    this->height = yPos;
}

References Chesto::Element::elements.

Member Data Documentation

cellPadding

int Chesto::Grid::cellPadding

Definition at line 19 of file Grid.hpp.

columns

int Chesto::Grid::columns

Definition at line 17 of file Grid.hpp.

highlighted

int Chesto::Grid::highlighted = -1

Cursor state.

Definition at line 23 of file Grid.hpp.

Referenced by process().

rowPadding

int Chesto::Grid::rowPadding

Definition at line 20 of file Grid.hpp.

touchMode

bool Chesto::Grid::touchMode = true

Definition at line 24 of file Grid.hpp.

width

int Chesto::Grid::width

Definition at line 18 of file Grid.hpp.

---

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

• src/Grid.hpp
• src/Grid.cpp