lightbulb_outline Please take our October 2018 developer survey. Start survey

Gesture

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

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

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.

The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface Cloneable and that the return type of the clone method of an array type T[] is T[] where T is any reference or primitive type. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.

The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is Object will result in throwing an exception at run time.

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(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.

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.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.