#include <XnVSwipeDetector.h>

Inheritance diagram for XnVSwipeDetector:

Collaboration diagram for XnVSwipeDetector:

Public Types
typedef void(XN_CALLBACK_TYPE *	SwipeCB )(XnFloat fVelocity, XnFloat fAngle, void *pUserCxt)
typedef void(XN_CALLBACK_TYPE *	GeneralSwipeCB )(XnVDirection eDir, XnFloat fVelocity, XnFloat fAngle, void *pUserCxt)
Public Member Functions
	XnVSwipeDetector (XnBool bUseSteadyBeforeSwipe=true, const XnChar *strName="XnVSwipeDetector")
	~XnVSwipeDetector ()
void	OnPrimaryPointCreate (const XnVHandPointContext *pContext, const XnPoint3D &ptFocus)
void	OnPrimaryPointUpdate (const XnVHandPointContext *pContext)
void	OnPrimaryPointReplace (XnUInt32 nOldId, const XnVHandPointContext *pContext)
void	OnPrimaryPointDestroy (XnUInt32 nID)
void	Reset ()
XnCallbackHandle	RegisterSwipeUp (void *cxt, SwipeCB pCB)
XnCallbackHandle	RegisterSwipeDown (void *cxt, SwipeCB pCB)
XnCallbackHandle	RegisterSwipeLeft (void *cxt, SwipeCB pCB)
XnCallbackHandle	RegisterSwipeRight (void *cxt, SwipeCB pCB)
XnCallbackHandle	RegisterSwipe (void *cxt, GeneralSwipeCB pCB)
void	UnregisterSwipeUp (XnCallbackHandle handle)
void	UnregisterSwipeDown (XnCallbackHandle handle)
void	UnregisterSwipeLeft (XnCallbackHandle handle)
void	UnregisterSwipeRight (XnCallbackHandle handle)
void	UnregisterSwipe (XnCallbackHandle handle)
void	SetMotionSpeedThreshold (XnFloat fThreshold)
XnFloat	GetMotionSpeedThreshold () const
void	SetMotionTime (XnUInt32 nThreshold)
XnUInt32	GetMotionTime () const
void	SetXAngleThreshold (XnFloat fThreshold)
XnFloat	GetXAngleThreshold () const
void	SetYAngleThreshold (XnFloat fThreshold)
XnFloat	GetYAngleThreshold () const
void	SetSteadyMaxStdDev (XnFloat fStdDev)
XnFloat	GetSteadyMaxStdDev () const
XnFloat	XN_API_DEPRECATED ("Use GetSteadyMaxStdDev() instead") GetSteadyMaxVelocity() const
void	XN_API_DEPRECATED ("Use SetSteadyMaxStdDev() instead") SetSteadyMaxVelocity(XnFloat fVelocity)
void	SetSteadyDuration (XnUInt32 nDuration)
XnUInt32	GetSteadyDuration () const
void	SetUseSteady (XnBool bUse)
XnBool	GetUseSteady () const
Protected Member Functions
XnStatus	AddPoint (const XnPoint3D &pt, XnFloat fTime)
Static Protected Member Functions
static void XN_CALLBACK_TYPE	Steady_Steady (XnUInt32 nId, XnFloat fVelocity, void *cxt)
Protected Attributes
XnVPointBuffer *	m_pMovementDetectionBuffer
XnFloat	m_fMotionDetectionSpeed
XnUInt32	m_nMotionDetectionTime
XnFloat	m_fLowestVelocity
XnBool	m_bWaitingForSlowdown
XnFloat	m_fAngleXThreshold
XnFloat	m_fAngleYThreshold
XnVFloatFloatSpecificEvent *	m_pPendingEvent
XnVDirection	m_ePendingDirection
XnFloat	m_fPendingVelocity
XnFloat	m_fPendingAngle
XnVFloatFloatSpecificEvent *	m_pSwipeDownCBs
XnVFloatFloatSpecificEvent *	m_pSwipeUpCBs
XnVFloatFloatSpecificEvent *	m_pSwipeLeftCBs
XnVFloatFloatSpecificEvent *	m_pSwipeRightCBs
XnVGeneralSwipeSpecificEvent *	m_pSwipeCBs
XnBool	m_bUseSteady
XnBool	m_bInSteady
XnVSteadyDetector	m_Steady
Static Protected Attributes
static const XnFloat	ms_fDefaultMotionDetectionVelocity
static const XnUInt32	ms_nDefaultMotionDetectionDuration

Detailed Description

A control that identifies swipes - moves on the x and y axes. The XnVSwipeDetector defines 4 events for specific direction swipes:

A swipe up identified
A swipe down identified
A swipe left identified
A swipe right identified

Additionally, a general swipe event is defined, and is called (with a XnVDirection parameter) for any swipe.

Definition at line 31 of file XnVSwipeDetector.h.

Member Typedef Documentation

typedef void(XN_CALLBACK_TYPE * XnVSwipeDetector::GeneralSwipeCB)(XnVDirection eDir, XnFloat fVelocity, XnFloat fAngle, void *pUserCxt)

Definition at line 39 of file XnVSwipeDetector.h.

typedef void(XN_CALLBACK_TYPE * XnVSwipeDetector::SwipeCB)(XnFloat fVelocity, XnFloat fAngle, void *pUserCxt)

Type for all swipe events callbacks

Definition at line 38 of file XnVSwipeDetector.h.

Constructor & Destructor Documentation

XnVSwipeDetector::XnVSwipeDetector	(	XnBool	bUseSteadyBeforeSwipe = `true`,
		const XnChar *	strName = `"XnVSwipeDetector"`
	)

Creation

Parameters:

`[in]`	bUseSteadyBeforeSwipe	Wait for steady before looking for swipes
`[in]`	strName	Name of the control, for log purposes.

XnVSwipeDetector::~XnVSwipeDetector ( )

Member Function Documentation

XnStatus XnVSwipeDetector::AddPoint	(	const XnPoint3D &	pt,
		XnFloat	fTime
	)			`[protected]`

XnFloat XnVSwipeDetector::GetMotionSpeedThreshold ( ) const

XnUInt32 XnVSwipeDetector::GetMotionTime ( ) const

XnUInt32 XnVSwipeDetector::GetSteadyDuration ( ) const

XnFloat XnVSwipeDetector::GetSteadyMaxStdDev ( ) const

XnBool XnVSwipeDetector::GetUseSteady ( ) const

XnFloat XnVSwipeDetector::GetXAngleThreshold ( ) const

XnFloat XnVSwipeDetector::GetYAngleThreshold ( ) const

void XnVSwipeDetector::OnPrimaryPointCreate	(	const XnVHandPointContext *	pContext,
		const XnPoint3D &	ptFocus
	)			`[virtual]`

Called when the primary point is created.

Parameters:

`[in]`	pContext	The hand context of the newly created primary point
`[in]`	ptFocus	The point in which the session has started.

Reimplemented from XnVPointControl.

void XnVSwipeDetector::OnPrimaryPointDestroy ( XnUInt32 nID ) [virtual]

Called when the primary point is destroyed.

Parameters:

[in] nID The ID of the destroyed hand

Reimplemented from XnVPointControl.

void XnVSwipeDetector::OnPrimaryPointReplace	(	XnUInt32	nOldId,
		const XnVHandPointContext *	pContext
	)			`[virtual]`

Called when the primary point is replaced. This will cause the algorithm to look for swipes on a different hand - the new primary

Parameters:

`[in]`	nOldId	The ID of the hand that was the primary until now
`[in]`	pContext	The hand context of the new primary point

Reimplemented from XnVPointControl.

void XnVSwipeDetector::OnPrimaryPointUpdate ( const XnVHandPointContext * pContext ) [virtual]

Called when the primary point is updated. This will cause the algorithm to look for swipes.

Parameters:

[in] pContext The hand context of the updated primary point

Reimplemented from XnVPointControl.

XnCallbackHandle XnVSwipeDetector::RegisterSwipe	(	void *	cxt,
		GeneralSwipeCB	pCB
	)

Register for the general swipe event

Parameters:

`[in]`	cxt	User's context
`[in]`	pCB	The Callback to call when the event is invoked.

Returns:: A handle, to allow unregistration.

XnCallbackHandle XnVSwipeDetector::RegisterSwipeDown	(	void *	cxt,
		SwipeCB	pCB
	)

Register for the swipe down event

Parameters:

`[in]`	cxt	User's context
`[in]`	pCB	The Callback to call when the event is invoked.

Returns:: A handle, to allow unregistration.

XnCallbackHandle XnVSwipeDetector::RegisterSwipeLeft	(	void *	cxt,
		SwipeCB	pCB
	)

Register for the swipe left event

Parameters:

`[in]`	cxt	User's context
`[in]`	pCB	The Callback to call when the event is invoked.

Returns:: A handle, to allow unregistration.

XnCallbackHandle XnVSwipeDetector::RegisterSwipeRight	(	void *	cxt,
		SwipeCB	pCB
	)

Register for the swipe right event

Parameters:

`[in]`	cxt	User's context
`[in]`	pCB	The Callback to call when the event is invoked.

Returns:: A handle, to allow unregistration.

XnCallbackHandle XnVSwipeDetector::RegisterSwipeUp	(	void *	cxt,
		SwipeCB	pCB
	)

Register for the swipe up event

Parameters:

`[in]`	cxt	User's context
`[in]`	pCB	The Callback to call when the event is invoked.

Returns:: A handle, to allow unregistration.

void XnVSwipeDetector::Reset ( )

Start looking for swipes, forgetting the preexisting state.

void XnVSwipeDetector::SetMotionSpeedThreshold ( XnFloat fThreshold )

Change the minimal speed to recognize as a swipe. Default is 0.25m/s

Parameters:

[in] fThreshold The minimal speed to be considered a swipe

void XnVSwipeDetector::SetMotionTime ( XnUInt32 nThreshold )

Change the minimal duration to recognize as swipe. Default is 350 ms

Parameters:

[in] nThreshold The minimal duration to be considered a swipe

void XnVSwipeDetector::SetSteadyDuration ( XnUInt32 nDuration )

Change internal Steady Detector's steady detection duration

Parameters:

[in] nDuration Duration of steady state

void XnVSwipeDetector::SetSteadyMaxStdDev ( XnFloat fStdDev )

Change internal Steady Detector's maximum standard deviation to consider steady

Parameters:

[in] fStdDev Maximum standard deviation to consider steady state

void XnVSwipeDetector::SetUseSteady ( XnBool bUse )

void XnVSwipeDetector::SetXAngleThreshold ( XnFloat fThreshold )

Change the angle difference from the X-Axis to consider Left/Right movement. Default is 25 degrees

Parameters:

[in] fThreshold The angle difference

void XnVSwipeDetector::SetYAngleThreshold ( XnFloat fThreshold )

Change the angle difference from the Y-Axis to consider Up/Down movement. Default is 20 degrees

Parameters:

[in] fThreshold The angle difference

static void XN_CALLBACK_TYPE XnVSwipeDetector::Steady_Steady	(	XnUInt32	nId,
		XnFloat	fVelocity,
		void *	cxt
	)			`[static, protected]`

void XnVSwipeDetector::UnregisterSwipe ( XnCallbackHandle handle )

Unregister from the general swipe event

Parameters: