ListElement Class Reference

Inheritance diagram for ListElement:

Collaboration diagram for ListElement:

Public Member Functions
bool	process (InputEvents *event)
	process any input that is received for this element More...
bool	handleInertiaScroll (InputEvents *event)
bool	processUpDown (InputEvents *event)
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...

Public Attributes
int	highlighted = -1
int	initialTouchDown = -1
int	minYScroll = 0
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}
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
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 ListElement.hpp.

Member Function Documentation

handleInertiaScroll()

bool ListElement::handleInertiaScroll

(

InputEvents *

event

)

Definition at line 35 of file ListElement.cpp.

{
    bool ret = false;
    ListElement* elem = this;
 
    if (event->isTouchDown())
    {
        // make sure that the mouse down's X coordinate is over the app list (not sidebar)
        if (event->xPos < elem->xAbs)
            return false;
 
        // saw mouse down so set it in our element object
        elem->dragging = true;
        elem->lastMouseY = event->yPos;
        elem->initialTouchDown = event->yPos;
 
        ret |= true;
    }
    // drag event for scrolling up or down
    else if (event->isTouchDrag())
    {
        if (elem->dragging)
        {
            // prevent scrolling until we exceed a treshold distance in the Y direction
            if (this->initialTouchDown >= 0 && (abs(event->yPos - this->initialTouchDown) < 10 / SCALER))
                return false;
 
            this->initialTouchDown = -1;
 
            int distance = event->yPos - elem->lastMouseY;
            elem->y += distance;
            elem->lastMouseY = event->yPos;
 
            // use the last distance as the rubber band value
            elem->elasticCounter = distance;
 
            ret |= true;
        }
    }
    else if (event->isTouchUp())
    {
        // mouse up, no more mouse down (TODO: fire selected event here)
        elem->dragging = false;
 
        // if the scroll offset is less than the total number of apps
        // (put on the mouse up to make it "snap" when going out of bounds)
        // TODO: account for max number of apps too (prevent scrolling down forever)
        if (elem->y > minYScroll)
            elem->y = minYScroll;
 
        ret |= true;
    }
 
    // if mouse is up, and there's some elastic counter left, burn out remaining elastic value
    if (!elem->dragging && elem->elasticCounter != 0)
    {
        elem->y += elem->elasticCounter;
 
        // reduce the elastic counter by 5% each time (slows down the scroll)
        elem->elasticCounter *= 0.95;
        
        // if we're less than 10 pixels on the counter, just stop
        if (abs(elem->elasticCounter) < 10)
            elem->elasticCounter = 0;
 
        // TODO: same problem as above todo, also extract into method?
        if (elem->y > minYScroll)
            elem->y = minYScroll;
 
        ret |= true;
    }
 
    if (ret) event->isScrolling = true;
 
    if (event->wheelScroll != 0)
    {
        // apply wheel scroll directly to y position, and then reset
        elem->y += event->wheelScroll * 10;
        if (elem->y > minYScroll)
            elem->y = minYScroll;
        event->wheelScroll *= 0.95;
 
        if (abs(event->wheelScroll) < 0.1)
            event->wheelScroll = 0;
            
        ret |= true;
    }
 
    return ret;
}

process()

bool ListElement::process ( InputEvents *  event )

virtual

process any input that is received for this element

Reimplemented from Element.

Definition at line 3 of file ListElement.cpp.

{
    bool ret = false;
 
    // if we're hidden, don't process input
    if (hidden) return ret;
 
    // perform inertia scrolling for this element
    ret |= this->handleInertiaScroll(event);
 
    ret |= super::process(event);
 
    return ret;
}

References Element::hidden, and Element::process().

processUpDown()

bool ListElement::processUpDown

(

InputEvents *

event

)

Definition at line 18 of file ListElement.cpp.

{
    bool ret = false;
    int SPEED = 1;
 
    // handle up and down for the scroll view
    if (event->isKeyDown())
    {
        // scroll the view by offsetting the elastic counter
        event->wheelScroll += (SPEED * event->held(UP_BUTTON) - SPEED * event->held(DOWN_BUTTON));
 
        ret |= event->held(UP_BUTTON) || event->held(DOWN_BUTTON);
    }
 
    return ret;
}

Member Data Documentation

highlighted

int ListElement::highlighted = -1

Definition at line 9 of file ListElement.hpp.

initialTouchDown

int ListElement::initialTouchDown = -1

Definition at line 10 of file ListElement.hpp.

minYScroll

int ListElement::minYScroll = 0

Definition at line 11 of file ListElement.hpp.

---

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

• src/ListElement.hpp
• src/ListElement.cpp