Added in API level 1

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

PointF

Kotlin |Java

public class PointF
extends Object implements Parcelable

java.lang.Object
↳	android.graphics.PointF

PointF holds two float coordinates

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<PointF>`	`CREATOR`
`public float`	`x`
`public float`	`y`

Public constructors
`PointF()`
`PointF(float x, float y)`
`PointF(Point p)`
`PointF(PointF p)` Create a new PointF initialized with the values in the specified PointF (which is left unmodified).

Public methods
`int`	`describeContents()` Parcelable interface methods
`final boolean`	`equals(float x, float y)` Returns true if the point's coordinates equal (x,y)
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`int`	`hashCode()` Returns a hash code value for the object.
`static float`	`length(float x, float y)` Returns the euclidian distance from (0,0) to (x,y)
`final float`	`length()` Return the euclidian distance from (0,0) to the point
`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(PointF p)` Set the point's x and y coordinates to the coordinates of p
`final void`	`set(float x, float y)` Set the point's x and y coordinates
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel out, int flags)` Write this point to the specified 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 13

public static final Creator<PointF> CREATOR

x

Added in API level 1

public float x

y

Added in API level 1

public float y

Public constructors

PointF

Added in API level 1

public PointF ()

PointF

Added in API level 1

public PointF (float x, 
                float y)

Parameters
`x`	`float`
`y`	`float`

PointF

Added in API level 1

public PointF (Point p)

Parameters
`p`	`Point`: This value cannot be `null`.

PointF

Added in API level 30

public PointF (PointF p)

Create a new PointF initialized with the values in the specified PointF (which is left unmodified).

Parameters
`p`	`PointF`: The point whose values are copied into the new point. This value cannot be `null`.

Public methods

describeContents

Added in API level 13

public int describeContents ()

Parcelable interface methods

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`

equals

Added in API level 1

public final boolean equals (float x, 
                float y)

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

Parameters
`x`	`float`
`y`	`float`

Returns
`boolean`

equals

Added in API level 1

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
`o`	`Object`: the reference object with which to compare.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

hashCode

Added in API level 1

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
`int`	a hash code value for this object.

length

Added in API level 1

public static float length (float x, 
                float y)

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

Parameters
`x`	`float`
`y`	`float`

Returns
`float`

length

Added in API level 1

public final float length ()

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

Returns
`float`

negate

Added in API level 1

public final void negate ()

offset

Added in API level 1

public final void offset (float dx, 
                float dy)

Parameters
`dx`	`float`
`dy`	`float`

readFromParcel

Added in API level 13

public void readFromParcel (Parcel in)

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 This value cannot be `null`.

set

Added in API level 1

public final void set (PointF p)

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

Parameters
`p`	`PointF`: This value cannot be `null`.

set

Added in API level 1

public final void set (float x, 
                float y)

Set the point's x and y coordinates

Parameters
`x`	`float`
`y`	`float`

toString

Added in API level 1

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 13

public void writeToParcel (Parcel out, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES