PointF
open class PointF : Parcelable
| kotlin.Any | |
| ↳ | android.graphics.PointF |
PointF holds two float coordinates
Summary
| Inherited constants | |
|---|---|
| Public constructors | |
|---|---|
PointF() |
|
|
Create a new PointF initialized with the values in the specified PointF (which is left unmodified). |
|
| Public methods | |
|---|---|
| open Int |
Parcelable interface methods |
| Boolean |
Returns true if the point's coordinates equal (x,y) |
| open Boolean |
Indicates whether some other object is "equal to" this one. |
| open Int |
hashCode()Returns a hash code value for the object. |
| Float |
length()Return the euclidian distance from (0,0) to the point |
| open static Float |
Returns the euclidian distance from (0,0) to (x,y) |
| Unit |
negate() |
| Unit | |
| open Unit |
readFromParcel(in: Parcel)Set the point's coordinates from the data stored in the specified parcel. |
| Unit |
Set the point's x and y coordinates to the coordinates of p |
| Unit |
Set the point's x and y coordinates |
| open String |
toString()Returns a string representation of the object. |
| open Unit |
writeToParcel(out: Parcel, flags: Int)Write this point to the specified parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<PointF!> | |
| Float | |
| Float | |
Public constructors
PointF
PointF(p: PointF)
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
open fun describeContents(): Int
Parcelable interface methods
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
fun equals(
x: Float,
y: Float
): Boolean
Returns true if the point's coordinates equal (x,y)
equals
open fun equals(other: Any?): Boolean
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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 | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
hashCode
open fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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.
| Return | |
|---|---|
Int |
a hash code value for this object. |
length
fun length(): Float
Return the euclidian distance from (0,0) to the point
length
open static fun length(
x: Float,
y: Float
): Float
Returns the euclidian distance from (0,0) to (x,y)
readFromParcel
open fun readFromParcel(in: Parcel): Unit
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
fun set(p: PointF): Unit
Set the point's x and y coordinates to the coordinates of p
| Parameters | |
|---|---|
p |
PointF: This value cannot be null. |
toString
open fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
open fun writeToParcel(
out: Parcel,
flags: Int
): Unit
Write this point to the specified parcel. To restore a point from a parcel, use readFromParcel()
| Parameters | |
|---|---|
dest |
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_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|
out |
Parcel: The parcel to write the point's coordinates into |