MythGesture Class Reference

Contains the points in a stroke, and translates them into gestures. More...

#include <libmythui/mythgesture.h>

Collaboration diagram for MythGesture:

Public Member Functions
	MythGesture (size_t MaxPoints=10000, size_t MinPoints=50, size_t MaxSequence=20, int ScaleRatio=4, float BinPercent=0.07F)
	Create a new stroke, specifying tuning values. More...
void	Start ()
	Start recording. More...
void	Stop (bool Timeout=false)
	Stop recording. More...
bool	Recording ()
	Determine if the stroke is being recorded. More...
MythGestureEvent *	GetGesture () const
	Complete the gesture event of the last completed stroke. More...
bool	Record (QPoint Point, Qt::MouseButton Button)
	Record a point. More...

Private Member Functions
bool	HasMinimumPoints () const
	Determine if the stroke has the minimum required points. More...
QString	Translate (bool Timeout)
	Translate the stroke into a sequence. More...
void	AdjustExtremes (int X, int Y)
	Adjust horizontal and vertical extremes. More...

Private Attributes
bool	m_recording { false }
int	m_minX { 10000 }
int	m_maxX { -1 }
int	m_minY { 10000 }
int	m_maxY { -1 }
size_t	m_maxPoints { 10000 }
size_t	m_minPoints { 50 }
size_t	m_maxSequence { 20 }
int	m_scaleRatio { 4 }
float	m_binPercent { 0.07F }
MythGestureEvent::Gesture	m_lastGesture { MythGestureEvent::Unknown }
QList< QPoint >	m_points
QMutex	m_lock
Qt::MouseButton	m_lastButton { Qt::NoButton }

Static Private Attributes
static const std::map< QString, MythGestureEvent::Gesture >	kSequences

Detailed Description

Contains the points in a stroke, and translates them into gestures.

Because the indended use of the stop method is to be called by either the expiration of a timer or when an event is called (or both at the same time) it must have a mutex.

Definition at line 99 of file mythgesture.h.

Constructor & Destructor Documentation

MythGesture()

MythGesture::MythGesture ( size_t  MaxPoints = 10000, size_t  MinPoints = 50, size_t  MaxSequence = 20, int  ScaleRatio = 4, float  BinPercent = 0.07F  )

explicit

Create a new stroke, specifying tuning values.

Parameters

max_points	The maximum number of points to record.
min_points	The minimum number of points to record.
max_sequence	The maximum producible sequence size.
scale_ratio	The stroke scale ratio
bin_percent	The bin count percentage required to add to the sequence.

Definition at line 116 of file mythgesture.cpp.

Member Function Documentation

AdjustExtremes()

void MythGesture::AdjustExtremes ( int  X, int  Y  )

private

Adjust horizontal and vertical extremes.

Parameters

x	The new horizontal extreme.
y	The new vertical extreme

Definition at line 131 of file mythgesture.cpp.

Referenced by Record().

GetGesture()

MythGestureEvent * MythGesture::GetGesture

(

void

)

const

Complete the gesture event of the last completed stroke.

Returns

A new gesture event, or nullptr on error.

Definition at line 190 of file mythgesture.cpp.

Referenced by MythMainWindow::eventFilter(), and MythMainWindow::MouseTimeout().

HasMinimumPoints()

bool MythGesture::HasMinimumPoints ( ) const

private

Determine if the stroke has the minimum required points.

Returns

true if the gesture can be translated, otherwise, false.

Definition at line 322 of file mythgesture.cpp.

Record()

bool MythGesture::Record	(	QPoint	Point,
		Qt::MouseButton	Button
	)

Record a point.

Parameters

Point

The point to record.

Returns

True if the point was recorded, otherwise, false.

Definition at line 331 of file mythgesture.cpp.

Referenced by MythMainWindow::eventFilter().

Recording()

bool MythGesture::Recording

(

void

)

Determine if the stroke is being recorded.

Returns

True if recording is in progress, otherwise, false.

Definition at line 142 of file mythgesture.cpp.

Referenced by MythMainWindow::eventFilter(), MythMainWindow::MouseTimeout(), and Record().

Start()

void MythGesture::Start

(

void

)

Start recording.

Definition at line 151 of file mythgesture.cpp.

Referenced by MythMainWindow::eventFilter().

Stop()

void MythGesture::Stop

(

bool

Timeout = false

)

Stop recording.

This method stores the gesture, as it is, and resets all information.

Definition at line 163 of file mythgesture.cpp.

Referenced by MythMainWindow::eventFilter(), and MythMainWindow::MouseTimeout().

Translate()

QString MythGesture::Translate ( bool  Timeout )

private

Translate the stroke into a sequence.

Returns

The sequence string made by the mouse.

Note

The points will be removed during this method.

Definition at line 217 of file mythgesture.cpp.

Referenced by Stop().

Member Data Documentation

kSequences

const std::map< QString, MythGestureEvent::Gesture > MythGesture::kSequences

staticprivate

Initial value:

=
{
    { "1",     MythGestureEvent::LongClick },
    { "5",     MythGestureEvent::Click },
    { "456",   MythGestureEvent::Right },
    { "654",   MythGestureEvent::Left  },
    { "258",   MythGestureEvent::Down  },
    { "852",   MythGestureEvent::Up    },
    { "951",   MythGestureEvent::UpLeft    },
    { "753",   MythGestureEvent::UpRight   },
    { "159",   MythGestureEvent::DownRight },
    { "357",   MythGestureEvent::DownLeft  },
    { "96321", MythGestureEvent::UpThenLeft    },
    { "74123", MythGestureEvent::UpThenRight   },
    { "36987", MythGestureEvent::DownThenLeft  },
    { "14789", MythGestureEvent::DownThenRight },
    { "32147", MythGestureEvent::LeftThenDown  },
    { "98741", MythGestureEvent::LeftThenUp    },
    { "12369", MythGestureEvent::RightThenDown },
    { "78963", MythGestureEvent::RightThenUp   },
    { "45654", MythGestureEvent::RightThenLeft },
    { "65456", MythGestureEvent::LeftThenRight },
    { "85258", MythGestureEvent::UpThenDown    },
    { "25852", MythGestureEvent::DownThenUp    }
}

Definition at line 132 of file mythgesture.h.

Referenced by Stop().

m_binPercent

float MythGesture::m_binPercent { 0.07F }

private

Definition at line 128 of file mythgesture.h.

Referenced by Translate().

m_lastButton

Qt::MouseButton MythGesture::m_lastButton { Qt::NoButton }

private

Definition at line 133 of file mythgesture.h.

Referenced by GetGesture(), and Record().

m_lastGesture

MythGestureEvent::Gesture MythGesture::m_lastGesture { MythGestureEvent::Unknown }

private

Definition at line 129 of file mythgesture.h.

Referenced by GetGesture(), and Stop().

m_lock

QMutex MythGesture::m_lock

private

Definition at line 131 of file mythgesture.h.

Referenced by Recording(), Start(), and Stop().

m_maxPoints

size_t MythGesture::m_maxPoints { 10000 }

private

Definition at line 124 of file mythgesture.h.

Referenced by Record(), and Translate().

m_maxSequence

size_t MythGesture::m_maxSequence { 20 }

private

Definition at line 126 of file mythgesture.h.

Referenced by Translate().

m_maxX

int MythGesture::m_maxX { -1 }

private

Definition at line 121 of file mythgesture.h.

Referenced by AdjustExtremes(), Stop(), and Translate().

m_maxY

int MythGesture::m_maxY { -1 }

private

Definition at line 123 of file mythgesture.h.

Referenced by AdjustExtremes(), Stop(), and Translate().

m_minPoints

size_t MythGesture::m_minPoints { 50 }

private

Definition at line 125 of file mythgesture.h.

Referenced by HasMinimumPoints(), and Translate().

m_minX

int MythGesture::m_minX { 10000 }

private

Definition at line 120 of file mythgesture.h.

Referenced by AdjustExtremes(), Stop(), and Translate().

m_minY

int MythGesture::m_minY { 10000 }

private

Definition at line 122 of file mythgesture.h.

Referenced by AdjustExtremes(), Stop(), and Translate().

m_points

QList<QPoint> MythGesture::m_points

private

Definition at line 130 of file mythgesture.h.

Referenced by HasMinimumPoints(), Record(), and Translate().

m_recording

bool MythGesture::m_recording { false }

private

Definition at line 119 of file mythgesture.h.

Referenced by Recording(), Start(), and Stop().

m_scaleRatio

int MythGesture::m_scaleRatio { 4 }

private

Definition at line 127 of file mythgesture.h.

Referenced by Translate().

---

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

• mythtv/libs/libmythui/mythgesture.h
• mythtv/libs/libmythui/mythgesture.cpp