Added in API level 4

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

Gesture

Kotlin |Java

public class Gesture
extends Object implements Parcelable

java.lang.Object
↳	android.gesture.Gesture

A gesture is a hand-drawn shape on a touch screen. It can have one or multiple strokes. Each stroke is a sequence of timed points. A user-defined gesture can be recognized by a GestureLibrary.

Summary

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<Gesture>`	`CREATOR`

Public constructors
`Gesture()`

Public methods
`void`	`addStroke(GestureStroke stroke)` Adds a stroke to the gesture.
`Object`	`clone()` Creates and returns a copy of this object.
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`RectF`	`getBoundingBox()`
`long`	`getID()`
`float`	`getLength()` Calculates the total length of the gesture.
`ArrayList<GestureStroke>`	`getStrokes()`
`int`	`getStrokesCount()`
`Bitmap`	`toBitmap(int width, int height, int edge, int numSample, int color)` Creates a bitmap of the gesture with a transparent background.
`Bitmap`	`toBitmap(int width, int height, int inset, int color)` Creates a bitmap of the gesture with a transparent background.
`Path`	`toPath(Path path)`
`Path`	`toPath(int width, int height, int edge, int numSample)`
`Path`	`toPath(Path path, int width, int height, int edge, int numSample)`
`Path`	`toPath()`
`void`	`writeToParcel(Parcel out, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 4

public static final Creator<Gesture> CREATOR

Public constructors

Gesture

Added in API level 4

public Gesture ()

Public methods

addStroke

Added in API level 4

public void addStroke (GestureStroke stroke)

Adds a stroke to the gesture.

clone

Added in API level 4

public Object clone ()

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x

will be true, and that the expression:

 x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

 x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns
`Object`	a clone of this instance.

describeContents

Added in API level 4

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getBoundingBox

Added in API level 4

public RectF getBoundingBox ()

Returns
`RectF`	the bounding box of the gesture

getID

Added in API level 4

public long getID ()

Returns
`long`	the id of the gesture

getLength

Added in API level 4

public float getLength ()

Calculates the total length of the gesture. When there are multiple strokes in the gesture, this returns the sum of the lengths of all the strokes.

Returns
`float`	the length of the gesture

getStrokes

Added in API level 4

public ArrayList<GestureStroke> getStrokes ()

Returns
`ArrayList<GestureStroke>`	all the strokes of the gesture

getStrokesCount

Added in API level 4

public int getStrokesCount ()

Returns
`int`	the number of strokes included by this gesture

toBitmap

Added in API level 4

public Bitmap toBitmap (int width, 
                int height, 
                int edge, 
                int numSample, 
                int color)

Creates a bitmap of the gesture with a transparent background.

Parameters
`width`	`int`: width of the target bitmap
`height`	`int`: height of the target bitmap
`edge`	`int`: the edge

Returns
`Bitmap`	the bitmap

toBitmap

Added in API level 4

public Bitmap toBitmap (int width, 
                int height, 
                int inset, 
                int color)

Creates a bitmap of the gesture with a transparent background.

Returns
`Bitmap`	the bitmap

toPath

Added in API level 4

public Path toPath (Path path)

Parameters
`path`	`Path`

Returns
`Path`

toPath

Added in API level 4

public Path toPath (int width, 
                int height, 
                int edge, 
                int numSample)

Parameters
`width`	`int`
`height`	`int`
`edge`	`int`
`numSample`	`int`

Returns
`Path`

toPath

Added in API level 4

public Path toPath (Path path, 
                int width, 
                int height, 
                int edge, 
                int numSample)

Parameters
`path`	`Path`
`width`	`int`
`height`	`int`
`edge`	`int`
`numSample`	`int`

Returns
`Path`

toPath

Added in API level 4

public Path toPath ()

Returns
`Path`

writeToParcel

Added in API level 4

public void writeToParcel (Parcel out, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`out`	`Parcel`: The Parcel in which the object should be written. This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES