PressGesture Class

Recognizes when an object is touched. Works with any gesture unless a Delegate is set.

Inheritance Hierarchy

SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          TouchScript.CoreDebuggableMonoBehaviour
            TouchScript.GesturesGesture
              TouchScript.GesturesPressGesture

Namespace: TouchScript.Gestures
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0

Syntax

Copy

public class PressGesture : Gesture

The PressGesture type exposes the following members.

Constructors

	Name	Description
	PressGesture	Initializes a new instance of the PressGesture class

Top

Properties

	Name	Description
	ActivePointers	Gets list of gesture's active pointers. (Inherited from Gesture.)
	DebugMode	Gets or sets if this object should show its debug information. (Inherited from DebuggableMonoBehaviour.)
	Delegate	Gets or sets an object implementing IGestureDelegate to be asked for gesture specific actions. (Inherited from Gesture.)
	gestureManager	Reference to global GestureManager. (Inherited from Gesture.)
	IgnoreChildren	Gets or sets a value indicating whether actions coming from children should be ingored.
	MaxPointers	Gets or sets maximum number of pointers this gesture reacts to. The gesture will not be recognized if it has more than MaxPointers pointers. (Inherited from Gesture.)
	MinPointers	Gets or sets minimum number of pointers this gesture reacts to. The gesture will not be recognized if it has less than MinPointers pointers. (Inherited from Gesture.)
	NormalizedScreenPosition	Gets normalized screen position. (Inherited from Gesture.)
	NumPointers	Gets the number of active pointerss. (Inherited from Gesture.)
	pointersNumState	The state of min/max number of pointers. (Inherited from Gesture.)
	PreviousNormalizedScreenPosition	Gets previous screen position. (Inherited from Gesture.)
	PreviousScreenPosition	Gets previous screen position. (Inherited from Gesture.)
	PreviousState	Gets previous gesture state. (Inherited from Gesture.)
	RequireGestureToFail	Gets or sets another gesture which must fail before this gesture can be recognized. (Inherited from Gesture.)
	ScreenPosition	Gets current screen position. (Inherited from Gesture.)
	SendMessageTarget	Gets or sets the target of Unity messages sent from this gesture. (Inherited from Gesture.)
	SendStateChangeEvents	Gets or sets a value indicating whether state change events are broadcasted if UseUnityEvents is true. (Inherited from Gesture.)
	SendStateChangeMessages	Gets or sets a value indicating whether state change events are broadcasted if UseSendMessage is true. (Inherited from Gesture.)
	State	Gets current gesture state. (Inherited from Gesture.)
	touchManager	Reference to global TouchManager. (Inherited from Gesture.)
	UseSendMessage	Gets or sets whether gesture should use Unity's SendMessage in addition to C# events. (Inherited from Gesture.)
	UseUnityEvents	Gets or sets whether gesture should use Unity Events in addition to C# events. (Inherited from Gesture.)

Top

Methods

	Name	Description
	AddFriendlyGesture	Adds a friendly gesture. (Inherited from Gesture.)
	Awake	(Inherited from Gesture.)
	CanBePreventedByGesture	Determines whether this instance can be prevented by specified gesture. (Overrides GestureCanBePreventedByGesture(Gesture).)
	Cancel	Cancels this gesture. (Inherited from Gesture.)
	Cancel(Boolean, Boolean)	Cancels this gesture. (Inherited from Gesture.)
	CanPreventGesture	Determines whether this instance can prevent the specified gesture. (Overrides GestureCanPreventGesture(Gesture).)
	GetScreenPositionHitData	Returns HitData for gesture's ScreenPosition, i.e. what is right beneath it. (Inherited from Gesture.)
	HasPointer	Determines whether gesture controls a pointer. (Inherited from Gesture.)
	IsFriendly	Checks if a gesture is friendly with this gesture. (Inherited from Gesture.)
	onBegan	Called when state is changed to Began. (Inherited from Gesture.)
	onCancelled	Called when state is changed to Cancelled. (Inherited from Gesture.)
	onChanged	Called when state is changed to Changed. (Inherited from Gesture.)
	OnDestroy	Unity OnDestroy handler. (Inherited from Gesture.)
	OnDisable	Unity OnDisable handler. (Inherited from Gesture.)
	OnEnable	Unity Start handler. (Inherited from Gesture.)
	onFailed	Called when state is changed to Failed. (Inherited from Gesture.)
	onIdle	Called when state is changed to Idle. (Inherited from Gesture.)
	onPossible	Called when state is changed to Possible. (Inherited from Gesture.)
	onRecognized	Called when state is changed to Recognized. (Overrides GestureonRecognized.)
	pointersCancelled	Called when pointers are cancelled. (Inherited from Gesture.)
	pointersPressed	Called when new pointers appear. (Overrides GesturepointersPressed(IListPointer).)
	pointersReleased	Called if pointers are removed. (Inherited from Gesture.)
	pointersUpdated	Called for moved pointers. (Inherited from Gesture.)
	reset	Called to reset gesture state after it fails or recognizes. (Inherited from Gesture.)
	setState	Tries to change gesture state. (Inherited from Gesture.)
	ShouldBegin	Specifies if gesture can begin or recognize. (Inherited from Gesture.)
	shouldCachePointerPosition	Should the gesture cache this pointers to use it later in calculation of ScreenPosition. (Inherited from Gesture.)
	ShouldReceivePointer	Specifies if gesture can receive this specific pointer point. (Overrides GestureShouldReceivePointer(Pointer).)

Top

Events

	Name	Description
	Cancelled	Occurs when gesture is cancelled. (Inherited from Gesture.)
	Pressed	Occurs when gesture is recognized.
	StateChanged	Occurs when gesture changes state. (Inherited from Gesture.)

Top

Fields

	Name	Description
	activePointers	Pointers the gesture currently owns and works with. (Inherited from Gesture.)
	basicEditor	(Inherited from Gesture.)
	cachedPreviousScreenPosition	Cached previous screen position. Used to keep tap's position which can't be calculated from pointers when the gesture is recognized since all pointers are gone. (Inherited from Gesture.)
	cachedScreenPosition	Cached screen position. Used to keep tap's position which can't be calculated from pointers when the gesture is recognized since all pointers are gone. (Inherited from Gesture.)
	cachedTransform	Cached transform of the parent object. (Inherited from Gesture.)
	OnPress	Unity event, occurs when gesture is recognized.
	OnStateChange	Occurs when gesture changes state. (Inherited from Gesture.)
	PRESS_MESSAGE	Message name when gesture is recognized

Top

Remarks

PressGesture fires immediately and would ultimately kill every other non-friendly gesture. So one would have to manually make it friendly with everything in a general use-case. That's why it's made friendly with everyone by default.

But there are cases when one would like to determine if parent container was pressed or its child. In current implementation both PressGestures will fire.

One approach would be to somehow make parent's PressGesture not friendly with child's one. But looking at how gesture recognition works we can see that this won't work. Since we would like child's gesture to fail parent's gesture. When child's PressGesture is recognized the system asks it if it can prevent parent's gesture, and it obviously can't because it's friendly with everything. And it doesn't matter that parent's gesture can be prevented by child's one... because child's one can't prevent parent's gesture and this is asked first.

This is basically what IgnoreChildren is for. It makes parent's PressGesture only listen for TouchPoints which lend directly on it.

Reference

TouchScript.Gestures Namespace