TransformGestureBase Class

Abstract base class for Transform Gestures.

Inheritance Hierarchy

SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          TouchScript.CoreDebuggableMonoBehaviour
            TouchScript.GesturesGesture
              TouchScript.Gestures.TransformGestures.BaseTransformGestureBase
                TouchScript.Gestures.TransformGestures.BaseOnePointTrasformGestureBase
                TouchScript.Gestures.TransformGestures.BaseTwoPointTransformGestureBase

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

Syntax

Copy

public abstract class TransformGestureBase : Gesture, 
	ITransformGesture

The TransformGestureBase type exposes the following members.

Constructors

	Name	Description
	TransformGestureBase	Initializes a new instance of the TransformGestureBase 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.)
	DeltaPosition	Gets delta position between this frame and the last frame in world coordinates. This value is only available during Transformed or StateChanged events.
	DeltaRotation	Gets delta rotation between this frame and last frame in degrees. This value is only available during Transformed or StateChanged events.
	DeltaScale	Contains local delta scale when gesture is recognized. Value is between 0 and +infinity, where 1 is no scale, 0.5 is scaled in half, 2 scaled twice. This value is only available during Transformed or StateChanged events.
	gestureManager	Reference to global GestureManager. (Inherited from Gesture.)
	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.)
	RotationAxis	Gets rotation axis of the gesture in world coordinates.
	ScreenPosition	Gets current screen position. (Inherited from Gesture.)
	ScreenTransformThreshold	Gets or sets minimum distance in cm for pointers to move for gesture to begin.
	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.)
	TransformMask	Contains transform operations which happened this frame.
	Type	Gets or sets types of transformation this gesture supports.
	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. (Inherited from 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. (Inherited from 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. (Overrides GestureonBegan.)
	onCancelled	Called when state is changed to Cancelled. (Inherited from Gesture.)
	onChanged	Called when state is changed to Changed. (Overrides GestureonChanged.)
	OnDestroy	Unity OnDestroy handler. (Inherited from Gesture.)
	OnDisable	Unity OnDisable handler. (Inherited from Gesture.)
	OnEnable	Unity Start handler. (Overrides GestureOnEnable.)
	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.)
	OverrideTargetPosition	Overrides the target position used in calculations this frame. If used, has to be set after every transform event. TransformGestureBase.
	pointersCancelled	Called when pointers are cancelled. (Inherited from Gesture.)
	pointersPressed	Called when new pointers appear. (Overrides GesturepointersPressed(IListPointer).)
	pointersReleased	Called if pointers are removed. (Overrides GesturepointersReleased(IListPointer).)
	pointersUpdated	Called for moved pointers. (Inherited from Gesture.)
	reset	Called to reset gesture state after it fails or recognizes. (Overrides Gesturereset.)
	resetValues
	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. (Inherited from Gesture.)
	updateType

Top

Events

	Name	Description
	Cancelled	Occurs when gesture is cancelled. (Inherited from Gesture.)
	StateChanged	Occurs when gesture changes state. (Inherited from Gesture.)
	TransformCompleted	Occurs when gesture finishes.
	Transformed	Occurs when gesture data updates.
	TransformStarted	Occurs when gesture starts.

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.)
	deltaPosition	Calculated delta position.
	deltaRotation	Calculated delta rotation.
	deltaScale	Calculated delta scale.
	isTransforming	Indicates whether transformation started;
	OnStateChange	Occurs when gesture changes state. (Inherited from Gesture.)
	OnTransform	Unity event, occurs when the gesture is updated.
	OnTransformComplete	Unity event, occurs when the gesture ends.
	OnTransformStart	Unity event, occurs when the gesture starts.
	rotationAxis	Rotation axis to use with deltaRotation.
	screenTransformPixelThreshold	ScreenTransformThreshold in pixels.
	screenTransformPixelThresholdSquared	ScreenTransformThreshold in pixels squared.
	targetPosition	Target overridden position. OverrideTargetPosition(Vector3).
	targetPositionOverridden	Indicates if current position is being overridden for the next frame. OverrideTargetPosition(Vector3).
	TRANSFORM_COMPLETE_MESSAGE	Message name when gesture ends
	TRANSFORM_MESSAGE	Message name when gesture updates
	TRANSFORM_START_MESSAGE	Message name when gesture starts
	transformMask
	type

Top

Remarks

Relationship with Transformer component requires that if current object position is not exactly the one acquired by transformation events from this gesture (i.e. when smoothing is applied current transform is lagging a bit behind target transform), the gesture has to know about this to calculate translation properly. This is where OverrideTargetPosition(Vector3) method comes into play. Transformer has to call it after every transform event.

Reference

TouchScript.Gestures.TransformGestures.Base Namespace