tgui::TwoFingerScrollDetect Class Reference

Public Member Functions
void	reportFingerDown (std::uintptr_t fingerId, float x, float y)
	Informs the detector that a finger began touching.
void	reportFingerUp (std::uintptr_t fingerId)
	Informs the detector that a touching finger has moved.
void	reportFingerMotion (std::uintptr_t fingerId, float x, float y)
	Informs the detector that a finger stopped touching.
bool	isScrolling () const
	Returns whether two fingers are currently being held down and we have detected it as a scroll event.
Vector2f	getTouchPosition () const
	Returns the original centroid of the finger positions when the fingers began touching.
float	getDelta (float scale)
	Returns the amount that the centroid of the finger positions have moved vertically.

Member Function Documentation

getDelta()

float tgui::TwoFingerScrollDetect::getDelta

(

float

scale

)

Returns the amount that the centroid of the finger positions have moved vertically.

Parameters

scale

Factor to multiply with distance, for when the view size differs from the window size

Returns

Distance to scroll. Positive value when the fingers went down (and we should scroll upwards).

Warning

This function should only be called when isScrolling() returns true.

getTouchPosition()

Vector2f tgui::TwoFingerScrollDetect::getTouchPosition

(

)

const

Returns the original centroid of the finger positions when the fingers began touching.

Warning

This function should only be called when isScrolling() returns true.

isScrolling()

bool tgui::TwoFingerScrollDetect::isScrolling

(

)

const

Returns whether two fingers are currently being held down and we have detected it as a scroll event.

Returns

Should the generateScrollEvent function be called?

reportFingerDown()

void tgui::TwoFingerScrollDetect::reportFingerDown	(	std::uintptr_t	fingerId,
		float	x,
		float	y )

Informs the detector that a finger began touching.

Parameters

fingerId	Id for the finger that is unique for at least as long as the finger is held down
x	X position of the finger on the window
y	Y position of the finger on the window

reportFingerMotion()

void tgui::TwoFingerScrollDetect::reportFingerMotion	(	std::uintptr_t	fingerId,
		float	x,
		float	y )

Informs the detector that a finger stopped touching.

Parameters

fingerId	Id for the finger that was passed to reportFingerDown when the touch began
x	X position of the finger on the window
y	Y position of the finger on the window

reportFingerUp()

void tgui::TwoFingerScrollDetect::reportFingerUp

(

std::uintptr_t

fingerId

)

Informs the detector that a touching finger has moved.

Parameters

fingerId

Id for the finger that was passed to reportFingerDown when the touch began

---

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

• include/TGUI/TwoFingerScrollDetect.hpp