A class that is composed of Checks to represent a gesture. More...

Inheritance diagram for Gestures.Gesture:

Public Member Functions
	Gesture ()
	Create a Gesture object. Use additional methods to specify gesture composition for events, checks, and normalizers. More...

bool	GestureCompleted (List< GTransform > transforms)
	Determines if the specified GTransforms generated satisfy the requirements of this gesture. More...

void	FireEvent (GestureMetaData metaData)
	Fires the specifie GestureEvent associated with this gesture. More...

Gesture	AddEvent (UnityAction< GestureMetaData > eventAction)
	Adds a GestureEvent to be called at gesture completion. More...

void	ClearEvents ()
	Removes all events associated with this gesture. More...

Gesture	SetNormalizer (Normalizer normalizer)
	Sets the Normalizer to be applied to every incoming GTransform data point. More...

Normalizer	GetNormalizer ()
	Gets the Normalizer attached to this Gesture More...

Gesture	AddCheck (Check newCheck)
	Adds a single check to the list of checks that only need to be satisfied once for gesture completion. More...

Gesture	AddChecks (IEnumerable< Check > newChecks)
	Adds a range of checks to the list of checks that only need to be satisfied once for gesture completion. More...

Gesture	AddAlwaysCheck (Check newCheck)
	Adds a single check to the list of checks that need to be satisfied by every data point for gesture completion. More...

Gesture	AddAlwaysChecks (IEnumerable< Check > newChecks)
	Adds a range of check to the list of checks that need to be satisfied by every data point for gesture completion. More...

Gesture	AddSequentialCheck (Check newCheck)
	Adds a single check to the list of checks that must be satisfied in sequential order for gesture completion. More...

Gesture	AddSequentialChecks (IEnumerable< Check > newChecks)
	Adds a range of checks to the list of chekcs that must be satisfied in sequential order for gesture completion. More...

List< Check >	GetAllChecks ()
	Get all checks attached to this Gesture More...

Properties
bool	isEnabled `[get, set]`
	Whether the gesture is actively being detected or not. More...

float	gestureCompleteConfidence `[get, set]`
	The ratio of points that needs to satisfy gesture checks for gesture completion. More...

float	gestureCompletionPrecision `[get, set]`
	A measure of how close a set of GTransforms is to the gesture definition. More...

Detailed Description

A class that is composed of Checks to represent a gesture.

Constructor & Destructor Documentation

Gestures.Gesture.Gesture ( )

inline

Create a Gesture object. Use additional methods to specify gesture composition for events, checks, and normalizers.

Member Function Documentation

Gesture Gestures.Gesture.AddAlwaysCheck ( Check newCheck )

inline

Adds a single check to the list of checks that need to be satisfied by every data point for gesture completion.

Parameters

newCheck The check to be added to the always-check list.

Returns: Reference to the Gesture

Gesture Gestures.Gesture.AddAlwaysChecks ( IEnumerable< Check > newChecks )

inline

Adds a range of check to the list of checks that need to be satisfied by every data point for gesture completion.

Parameters

newChecks IEnumerable of Checks to be passed in.

Returns: Reference to the Gesture

Gesture Gestures.Gesture.AddCheck ( Check newCheck )

inline

Adds a single check to the list of checks that only need to be satisfied once for gesture completion.

Parameters

newCheck

Returns: Reference to the Gesture

Gesture Gestures.Gesture.AddChecks ( IEnumerable< Check > newChecks )

inline

Adds a range of checks to the list of checks that only need to be satisfied once for gesture completion.

Parameters

newChecks IEnumerator of Checks

Returns: Reference to the Gesture

Gesture Gestures.Gesture.AddEvent ( UnityAction< GestureMetaData > eventAction )

inline

Adds a GestureEvent to be called at gesture completion.

Parameters

eventAction

Returns: Reference to the Gesture

Gesture Gestures.Gesture.AddSequentialCheck ( Check newCheck )

inline

Adds a single check to the list of checks that must be satisfied in sequential order for gesture completion.

Parameters

newCheck The Check to be added.

Returns: Reference to the Gesture

Gesture Gestures.Gesture.AddSequentialChecks ( IEnumerable< Check > newChecks )

inline

Adds a range of checks to the list of chekcs that must be satisfied in sequential order for gesture completion.

Parameters

newChecks IEnumerable of Checks to be passed in.

Returns: Reference to the Gesture

void Gestures.Gesture.ClearEvents ( )

inline

Removes all events associated with this gesture.

void Gestures.Gesture.FireEvent ( GestureMetaData metaData )

inline

Fires the specifie GestureEvent associated with this gesture.

Parameters

metaData The GestureMetaData created from the gesture data.

bool Gestures.Gesture.GestureCompleted ( List< GTransform > transforms )

inline

Determines if the specified GTransforms generated satisfy the requirements of this gesture.

Parameters

transforms The List of Transforms to be checked

Returns

List<Check> Gestures.Gesture.GetAllChecks ( )

inline

Get all checks attached to this Gesture

Returns: Return a List of Checks

Normalizer Gestures.Gesture.GetNormalizer ( )

inline

Gets the Normalizer attached to this Gesture

Returns: Return the Normalizer attached to the Gesture

Gesture Gestures.Gesture.SetNormalizer ( Normalizer normalizer )

inline

Sets the Normalizer to be applied to every incoming GTransform data point.

Parameters

normalizer The Normalizer to be set.

Returns: Reference to the Gesture

Property Documentation

float Gestures.Gesture.gestureCompleteConfidence

getset

The ratio of points that needs to satisfy gesture checks for gesture completion.

Highly advised to leave at 1, or remain above 0.9. Low values will cause unwanted side effects like gesture overlap, or acceptance of random movements as gestures.

float Gestures.Gesture.gestureCompletionPrecision

getset

A measure of how close a set of GTransforms is to the gesture definition.

0.0 is a perfect gesture. Humanly impossible. 1.0 is as imperfect as possible while still passing the gesture at full confidence. When gesture confidence is not 1, the value is actual gesture completion precision minus the proportion of points satisfing gesture.

bool Gestures.Gesture.isEnabled

getset

Whether the gesture is actively being detected or not.

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

Gesturing/Assets/Gestures/Scripts/Core/Gesture.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation