CScroller Class Reference

Class used to handle scrolling, allow using tweeners. More...

#include <VisibleEffect.h>

Public Member Functions
	CScroller (unsigned int duration=200, std::shared_ptr< Tweener > tweener=std::shared_ptr< Tweener >())
	CScroller (const CScroller &right)
CScroller &	operator= (const CScroller &src)
void	ScrollTo (float endPos)
	Set target value scroller will be scrolling to. More...
void	Stop ()
	Immediately stop scrolling.
bool	Update (unsigned int time)
	Update the scroller to where it would be at the given time point, calculating a new Value. More...
float	GetValue () const
	Value of scroll.
void	SetValue (float scrollValue)
bool	IsScrolling () const
bool	IsScrollingUp () const
bool	IsScrollingDown () const
unsigned int	GetDuration () const

Detailed Description

Class used to handle scrolling, allow using tweeners.

Usage: start scrolling using ScrollTo() method / stop scrolling using Stop() method update scroll value each frame with current time using Update() method get/set scroll value using GetValue()/SetValue()

Member Function Documentation

ScrollTo()

void CScroller::ScrollTo

(

float

endPos

)

Set target value scroller will be scrolling to.

Parameters

endPos

target

Update()

bool CScroller::Update

(

unsigned int

time

)

Update the scroller to where it would be at the given time point, calculating a new Value.

Parameters

time	time point

Returns

True if we are scrolling at given time point

---

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

• xbmc/guilib/VisibleEffect.h
• xbmc/guilib/VisibleEffect.cpp