Click or drag to resize

FingersImageGestureHelperComponentScript Class

A little higher level script that includes an option to allow line renderers to draw the path for you. You can leave the line renderers and match text as null if you will be drawing your own lines and text for when there is a match.
Inheritance Hierarchy
SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          DigitalRubySharedGestureRecognizerComponentScriptBase
            DigitalRubySharedGestureRecognizerComponentScriptImageGestureRecognizer
              DigitalRubySharedImageGestureRecognizerComponentScript
                DigitalRubySharedFingersImageGestureHelperComponentScript

Namespace:  DigitalRubyShared
Assembly:  Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0
Syntax
C#
public class FingersImageGestureHelperComponentScript : ImageGestureRecognizerComponentScript

The FingersImageGestureHelperComponentScript type exposes the following members.

Constructors
  NameDescription
Public methodFingersImageGestureHelperComponentScript
Initializes a new instance of the FingersImageGestureHelperComponentScript class
Top
Properties
  NameDescription
Public propertyanimation Obsolete.

The Animation attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertyaudio Obsolete.

The AudioSource attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertycamera Obsolete.

The Camera attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertycollider Obsolete.

The Collider attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertycollider2D Obsolete.

The Collider2D component attached to the object.

(Inherited from Component.)
Public propertyconstantForce Obsolete.

The ConstantForce attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertyenabled

Enabled Behaviours are Updated, disabled Behaviours are not.

(Inherited from Behaviour.)
Public propertygameObject

The game object this component is attached to. A component is always attached to a game object.

(Inherited from Component.)
Public propertyGesture
Get the gesture for this component
(Inherited from GestureRecognizerComponentScriptT.)
Public propertyGestureBase
Base gesture
(Inherited from GestureRecognizerComponentScriptBase.)
Public propertyGestureImagesToKey
Allows looking up a key from a matched image
(Inherited from ImageGestureRecognizerComponentScript.)
Public propertyguiElement Obsolete. (Inherited from Component.)
Public propertyguiText Obsolete.

The GUIText attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertyguiTexture Obsolete.

The GUITexture attached to this GameObject (Read Only). (null if there is none attached).

(Inherited from Component.)
Public propertyhideFlags

Should the object be hidden, saved with the scene or modifiable by the user?

(Inherited from Object.)
Public propertyhingeJoint Obsolete.

The HingeJoint attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertyisActiveAndEnabled

Has the Behaviour had enabled called.

(Inherited from Behaviour.)
Public propertylight Obsolete.

The Light attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertyname

The name of the object.

(Inherited from Object.)
Public propertynetworkView Obsolete.

The NetworkView attached to this GameObject (Read Only). (null if there is none attached).

(Inherited from Component.)
Public propertyparticleEmitter Obsolete.

The ParticleEmitter attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertyparticleSystem Obsolete.

The ParticleSystem attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertyrenderer Obsolete.

The Renderer attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertyrigidbody Obsolete.

The Rigidbody attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertyrigidbody2D Obsolete.

The Rigidbody2D that is attached to the Component's GameObject.

(Inherited from Component.)
Public propertyrunInEditMode

Allow a specific instance of a MonoBehaviour to run in edit mode (only available in the editor).

(Inherited from MonoBehaviour.)
Public propertytag

The tag of this game object.

(Inherited from Component.)
Public propertytransform

The Transform attached to this GameObject.

(Inherited from Component.)
Public propertyuseGUILayout

Disabling this lets you skip the GUI layout phase.

(Inherited from MonoBehaviour.)
Top
Methods
  NameDescription
Protected methodAwake
Awake
(Inherited from GestureRecognizerComponentScriptT.)
Public methodBroadcastMessage(String)

Calls the method named methodName on every MonoBehaviour in this game object or any of its children.

(Inherited from Component.)
Public methodBroadcastMessage(String, Object)

Calls the method named methodName on every MonoBehaviour in this game object or any of its children.

(Inherited from Component.)
Public methodBroadcastMessage(String, SendMessageOptions)

Calls the method named methodName on every MonoBehaviour in this game object or any of its children.

(Inherited from Component.)
Public methodBroadcastMessage(String, Object, SendMessageOptions)

Calls the method named methodName on every MonoBehaviour in this game object or any of its children.

(Inherited from Component.)
Public methodCancelInvoke

Cancels all Invoke calls on this MonoBehaviour.

(Inherited from MonoBehaviour.)
Public methodCancelInvoke(String)

Cancels all Invoke calls with name methodName on this behaviour.

(Inherited from MonoBehaviour.)
Public methodCheckForImageMatch
Check for an image match
Public methodCompareTag

Is this game object tagged with tag ?

(Inherited from Component.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGestureCallback
Callback for gesture events
Protected methodGestureStateUpdatedCallback
Gesture callback
(Inherited from GestureRecognizerComponentScriptT.)
Public methodGetComponent(Type)

Returns the component of Type type if the game object has one attached, null if it doesn't.

(Inherited from Component.)
Public methodGetComponent(String)

Returns the component with name type if the game object has one attached, null if it doesn't.

(Inherited from Component.)
Public methodGetComponent``1 (Inherited from Component.)
Public methodGetComponentInChildren(Type)

Returns the component of Type type in the GameObject or any of its children using depth first search.

(Inherited from Component.)
Public methodGetComponentInChildren(Type, Boolean) (Inherited from Component.)
Public methodGetComponentInChildren``1 (Inherited from Component.)
Public methodGetComponentInChildren``1(Boolean) (Inherited from Component.)
Public methodGetComponentInParent(Type)

Returns the component of Type type in the GameObject or any of its parents.

(Inherited from Component.)
Public methodGetComponentInParent``1 (Inherited from Component.)
Public methodGetComponents(Type)

Returns all components of Type type in the GameObject.

(Inherited from Component.)
Public methodGetComponents(Type, ListComponent) (Inherited from Component.)
Public methodGetComponents``1 (Inherited from Component.)
Public methodGetComponents``1(ListUMP) (Inherited from Component.)
Public methodGetComponentsInChildren(Type)

Returns all components of Type type in the GameObject or any of its children.

(Inherited from Component.)
Public methodGetComponentsInChildren(Type, Boolean)

Returns all components of Type type in the GameObject or any of its children.

(Inherited from Component.)
Public methodGetComponentsInChildren``1 (Inherited from Component.)
Public methodGetComponentsInChildren``1(Boolean) (Inherited from Component.)
Public methodGetComponentsInChildren``1(ListUMP) (Inherited from Component.)
Public methodGetComponentsInChildren``1(Boolean, ListUMP) (Inherited from Component.)
Public methodGetComponentsInParent(Type) (Inherited from Component.)
Public methodGetComponentsInParent(Type, Boolean)

Returns all components of Type type in the GameObject or any of its parents.

(Inherited from Component.)
Public methodGetComponentsInParent``1 (Inherited from Component.)
Public methodGetComponentsInParent``1(Boolean) (Inherited from Component.)
Public methodGetComponentsInParent``1(Boolean, ListUMP) (Inherited from Component.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetInstanceID

Returns the instance id of the object.

(Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodInvoke

Invokes the method methodName in time seconds.

(Inherited from MonoBehaviour.)
Public methodInvokeRepeating

Invokes the method methodName in time seconds, then repeatedly every repeatRate seconds.

(Inherited from MonoBehaviour.)
Public methodIsInvoking

Is any invoke pending on this MonoBehaviour?

(Inherited from MonoBehaviour.)
Public methodIsInvoking(String)

Is any invoke on methodName pending?

(Inherited from MonoBehaviour.)
Protected methodLateUpdate
LateUpdate
(Overrides GestureRecognizerComponentScriptTLateUpdate.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodOnDestroy
OnDestroy
(Inherited from GestureRecognizerComponentScriptT.)
Protected methodOnDisable
OnDisable
(Inherited from GestureRecognizerComponentScriptT.)
Protected methodOnEnable
OnEnable
(Overrides ImageGestureRecognizerComponentScriptOnEnable.)
Public methodReloadGestureImageEntries
Reload all gesture images from the GestureImages field
(Inherited from ImageGestureRecognizerComponentScript.)
Public methodReset
Reset state, clear all lines
Public methodSendMessage(String)

Calls the method named methodName on every MonoBehaviour in this game object.

(Inherited from Component.)
Public methodSendMessage(String, Object)

Calls the method named methodName on every MonoBehaviour in this game object.

(Inherited from Component.)
Public methodSendMessage(String, SendMessageOptions)

Calls the method named methodName on every MonoBehaviour in this game object.

(Inherited from Component.)
Public methodSendMessage(String, Object, SendMessageOptions)

Calls the method named methodName on every MonoBehaviour in this game object.

(Inherited from Component.)
Public methodSendMessageUpwards(String)

Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.

(Inherited from Component.)
Public methodSendMessageUpwards(String, Object)

Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.

(Inherited from Component.)
Public methodSendMessageUpwards(String, SendMessageOptions)

Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.

(Inherited from Component.)
Public methodSendMessageUpwards(String, Object, SendMessageOptions)

Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.

(Inherited from Component.)
Public methodStartCoroutine(IEnumerator)

Starts a coroutine.

(Inherited from MonoBehaviour.)
Public methodStartCoroutine(String)

Starts a coroutine named methodName.

(Inherited from MonoBehaviour.)
Public methodStartCoroutine(String, Object)

Starts a coroutine named methodName.

(Inherited from MonoBehaviour.)
Public methodStartCoroutine_Auto Obsolete. (Inherited from MonoBehaviour.)
Public methodStopAllCoroutines

Stops all coroutines running on this behaviour.

(Inherited from MonoBehaviour.)
Public methodStopCoroutine(String)

Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour.

(Inherited from MonoBehaviour.)
Public methodStopCoroutine(IEnumerator)

Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour.

(Inherited from MonoBehaviour.)
Public methodStopCoroutine(Coroutine)

Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour.

(Inherited from MonoBehaviour.)
Public methodToString

Returns the name of the GameObject.

(Inherited from Object.)
Protected methodUpdate
Update
(Inherited from GestureRecognizerComponentScriptT.)
Top
Fields
  NameDescription
Public fieldAllowSimultaneousExecutionWith
Gesture components to allow simultaneous execution with. By default, gestures cannot execute together.
(Inherited from GestureRecognizerComponentScriptT.)
Public fieldAllowSimultaneousExecutionWithAllGestures
Whether to allow the gesture to execute simultaneously with all other gestures.
(Inherited from GestureRecognizerComponentScriptT.)
Public fieldClearTrackedTouchesOnEndOrFail
Whether tracked touches are cleared when the gesture ends or fails, default is false. By setting to true, you allow the gesture to possibly execute again with a different touch even if the original touch it failed on is still on-going. This is a special case, so be sure to watch for problems if you set this to true, as leaving it false ensures the most correct behavior, especially with lots of gestures at once.
(Inherited from GestureRecognizerComponentScriptT.)
Public fieldDirectionTolerance
The amount that the path must change direction (in radians) to count as a new direction (0.39 is 1.8 of PI).
(Inherited from ImageGestureRecognizerComponentScript.)
Public fieldGestureImages
The images that should be compared against to find a match. The values are a ulong which match the bits of each generated image. See DemoSceneImage & DemoScriptImage.cs for an example.
(Inherited from ImageGestureRecognizerComponentScript.)
Public fieldGestureStateUpdated
Gesture state updated callback
(Inherited from GestureRecognizerComponentScriptT.)
Public fieldGestureView
The game object the gesture must execute over, null to allow the gesture to execute anywhere.
(Inherited from GestureRecognizerComponentScriptT.)
Public fieldLineRenderers
The line renderers to show drawn lines or NULL if you are drawing your own lines. Make sure to add enough line renderers to match the max path count for your image gesture recognizer.
Public fieldLinesCleared
Executed whenever lines are cleared.
Public fieldLinesUpdated
Executed whenever lines need updating. Use the gesture property FocusX and FocusY to determine the current point.
Public fieldMatchText
Label to show match in, null for none
Public fieldMaximumNumberOfTouchesToTrack
The maximum number of touches to track. This gesture will never track more touches than this. Default is usually 1 or 2. Not all gestures will honor values higher than 1.
(Inherited from GestureRecognizerComponentScriptT.)
Public fieldMaximumPathCount
The maximum number of distinct paths for each image. Gesture will reset when max path count is hit.
(Inherited from ImageGestureRecognizerComponentScript.)
Public fieldMinimumDistanceBetweenPointsUnits
Minimum difference beteen points in units to count as a new point.
(Inherited from ImageGestureRecognizerComponentScript.)
Public fieldMinimumNumberOfTouchesToTrack
The minimum number of touches to track. This gesture will not start unless this many touches are tracked. Default is usually 1 or 2. Not all gestures will honor values higher than 1.
(Inherited from GestureRecognizerComponentScriptT.)
Public fieldMinimumPointsToRecognize
The minimum number of points before the gesture will recognize.
(Inherited from ImageGestureRecognizerComponentScript.)
Public fieldRequireGestureRecognizersToFail
The gesture recognizers that should be required to fail
(Inherited from GestureRecognizerComponentScriptT.)
Public fieldSimilarityMinimum
The amount that the gesture image must match an image from the set to count as a match (0 - 1).
(Inherited from ImageGestureRecognizerComponentScript.)
Public fieldThresholdUnits
The distance in units that the touch must move before the gesture begins.
(Inherited from ImageGestureRecognizerComponentScript.)
Top
See Also