JOGL 2.3.2 · com.jogamp.nativewindow.util.PointImmutable

Method Summary

Modifier and Type	Method and Description
public int	compareTo(final PointImmutable the object to be compared. d) Redeclares java.lang.Comparable.compareTo. Compares the square of the position.
public boolean	Returns: `true` if the two points are equal; otherwise `false`. equals(Object obj) Checks whether two points objects are equal.
public int	getX()
public int	getY()
public int	hashCode()

Inherited from com.jogamp.common.type.WriteCloneable:: cloneMutable

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(final PointImmutable d) Redeclares java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares the square of the position. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters d:PointImmutable the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(final PointImmutable d)

Redeclares java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares the square of the position.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

d:PointImmutable: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object obj) Checks whether two points objects are equal. Two instances of `PointReadOnly` are equal if the two components `y` and `x` are equal. Returns:boolean `true` if the two points are equal; otherwise `false`. Annotations @Override

public boolean equals(Object obj)

Checks whether two points objects are equal. Two instances of PointReadOnly are equal if the two components y and x are equal.

Returns:boolean

true if the two points are equal; otherwise false.

Annotations

@Override

getX	back to summary
public int getX()

getY	back to summary
public int getY()

hashCode	back to summary
public int hashCode() Annotations @Override

public Interface PointImmutable

Method Summary

Method Detail