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

Method Summary

Modifier and Type	Method and Description
public int	compareTo(final RectangleImmutable the object to be compared. d) Redeclares java.lang.Comparable.compareTo. Compares square of size 1st, if equal the square of position.
public float	coverage(RectangleImmutable r) Returns the coverage of given rectangle w/ this this one, i.e. between `0.0` and `1.0`.
public boolean	Returns: `true` if the two rectangles are equal; otherwise `false`. equals(Object obj) Checks whether two rect objects are equal.
public int	getHeight()
public int	getWidth()
public int	getX()
public int	getY()
public int	hashCode()
public RectangleImmutable	intersection(RectangleImmutable r) Returns the intersection of this rectangleand the given rectangle.
public RectangleImmutable	intersection(final int rx1, final int ry1, final int rx2, final int ry2) Returns the intersection of this rectangleand the given coordinates.
public RectangleImmutable	union(final RectangleImmutable r) Returns the union of this rectangle and the given rectangle.
public RectangleImmutable	union(final int rx1, final int ry1, final int rx2, final int ry2) Returns the union of this rectangleand the given coordinates.

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

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(final RectangleImmutable d) Redeclares java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares square of size 1st, if equal the square of 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:RectangleImmutable 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 RectangleImmutable d)

Redeclares java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares square of size 1st, if equal the square of 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:RectangleImmutable: 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

coverage back to summary

coverage	back to summary
public float coverage(RectangleImmutable r) Returns the coverage of given rectangle w/ this this one, i.e. between `0.0` and `1.0`. Coverage is computed by: isect = this.intersection(r); coverage = area( isect ) / area( this ) ;

public float coverage(RectangleImmutable r)

Returns the coverage of given rectangle w/ this this one, i.e. between 0.0 and 1.0.

Coverage is computed by:

   isect = this.intersection(r);
   coverage = area( isect ) / area( this ) ;

equals back to summary

equals	back to summary
public boolean equals(Object obj) Checks whether two rect objects are equal. Two instances of `Rectangle` are equal if the four integer values of the fields `y`, `x`, `height`, and `width` are all equal. Returns:boolean `true` if the two rectangles are equal; otherwise `false`. Annotations @Override

public boolean equals(Object obj)

Checks whether two rect objects are equal. Two instances of Rectangle are equal if the four integer values of the fields y, x, height, and width are all equal.

Returns:boolean

true if the two rectangles are equal; otherwise false.

Annotations

@Override

getHeight	back to summary
public int getHeight()

getWidth	back to summary
public int getWidth()

getX	back to summary
public int getX()

getY	back to summary
public int getY()

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

intersection	back to summary
public RectangleImmutable intersection(RectangleImmutable r) Returns the intersection of this rectangleand the given rectangle.

intersection	back to summary
public RectangleImmutable intersection(final int rx1, final int ry1, final int rx2, final int ry2) Returns the intersection of this rectangleand the given coordinates.

union	back to summary
public RectangleImmutable union(final RectangleImmutable r) Returns the union of this rectangle and the given rectangle.

union	back to summary
public RectangleImmutable union(final int rx1, final int ry1, final int rx2, final int ry2) Returns the union of this rectangleand the given coordinates.

public Interface RectangleImmutable

Method Summary

Method Detail