Android APIs
public class

PointF

extends Object
implements Parcelable
java.lang.Object
   ↳ android.graphics.PointF

Class Overview

PointF holds two float coordinates

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<PointF> CREATOR
public float x
public float y
Public Constructors
PointF()
PointF(float x, float y)
PointF(Point p)
Public Methods
int describeContents()
Parcelable interface methods
boolean equals(Object o)
Compares this instance with the specified object and indicates if they are equal.
final boolean equals(float x, float y)
Returns true if the point's coordinates equal (x,y)
int hashCode()
Returns an integer hash code for this object.
final float length()
Return the euclidian distance from (0,0) to the point
static float length(float x, float y)
Returns the euclidian distance from (0,0) to (x,y)
final void negate()
final void offset(float dx, float dy)
void readFromParcel(Parcel in)
Set the point's coordinates from the data stored in the specified parcel.
final void set(float x, float y)
Set the point's x and y coordinates
final void set(PointF p)
Set the point's x and y coordinates to the coordinates of p
String toString()
Returns a string containing a concise, human-readable description of this object.
void writeToParcel(Parcel out, int flags)
Write this point to the specified parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator<PointF> CREATOR

Added in API level 13

public float x

Added in API level 1

public float y

Added in API level 1

Public Constructors

public PointF ()

Added in API level 1

public PointF (float x, float y)

Added in API level 1

Parameters
x float
y float

public PointF (Point p)

Added in API level 1

Parameters
p Point

Public Methods

public int describeContents ()

Added in API level 13

Parcelable interface methods

Returns
int a bitmask indicating the set of special object types marshalled by the Parcelable.

public boolean equals (Object o)

Added in API level 1

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
o Object: the object to compare this instance with.
Returns
boolean true if the specified object is equal to this Object; false otherwise.

public final boolean equals (float x, float y)

Added in API level 1

Returns true if the point's coordinates equal (x,y)

Parameters
x float
y float
Returns
boolean

public int hashCode ()

Added in API level 1

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
int this object's hash code.

public final float length ()

Added in API level 1

Return the euclidian distance from (0,0) to the point

Returns
float

public static float length (float x, float y)

Added in API level 1

Returns the euclidian distance from (0,0) to (x,y)

Parameters
x float
y float
Returns
float

public final void negate ()

Added in API level 1

public final void offset (float dx, float dy)

Added in API level 1

Parameters
dx float
dy float

public void readFromParcel (Parcel in)

Added in API level 13

Set the point's coordinates from the data stored in the specified parcel. To write a point to a parcel, call writeToParcel().

Parameters
in Parcel: The parcel to read the point's coordinates from

public final void set (float x, float y)

Added in API level 1

Set the point's x and y coordinates

Parameters
x float
y float

public final void set (PointF p)

Added in API level 1

Set the point's x and y coordinates to the coordinates of p

Parameters
p PointF

public String toString ()

Added in API level 1

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
String a printable representation of this object.

public void writeToParcel (Parcel out, int flags)

Added in API level 13

Write this point to the specified parcel. To restore a point from a parcel, use readFromParcel()

Parameters
out Parcel: The parcel to write the point's coordinates into
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.