ControlsFX 11.2.2 · impl.org.controlsfx.tools.rectangle.Edge2D

Modifier and Type	Field and Description
private final Point2D	centerPoint The edge's center point.
private final double	length The edge's length.
private final Orientation	orientation The edge's orientation.

Access	Constructor and Description
public	Edge2D(Point2D the edge's center point centerPoint, Orientation the edge's orientation orientation, double the edge's length; must be non-negative. length) Creates a new edge which is specified by its center point, orientation and length.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Point2D	getCenterPoint() Returns: the edge's center point
public double	getLength() Returns: the edge's length
public Point2D	Returns: the edge's lower right point getLowerRight() Returns the edge's lower right end point.
public Orientation	Returns: the edge's orientation getOrientation() Returns this edge's orientation.
public double	Returns: the distance getOrthogonalDifference(Point2D the point to where the distance is computed otherPoint) Returns the distance of the specified point to the edge in terms of the dimension orthogonal to the edge's orientation.
public Point2D	Returns: the edge's upper left point getUpperLeft() Returns the edge's upper left end point.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	Returns: true if `getOrientation()` returns `Orientation#HORIZONTAL` isHorizontal() Indicates whether this is a `horizontal` edge.
public boolean	Returns: true if `getOrientation()` returns `Orientation#VERTICAL` isVertical() Indicates whether this is a `horizontal` edge.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

centerPoint	back to summary
private final Point2D centerPoint The edge's center point.

length	back to summary
private final double length The edge's length.

orientation	back to summary
private final Orientation orientation The edge's orientation.

Edge2D	back to summary
public Edge2D(Point2D centerPoint, Orientation orientation, double length) Creates a new edge which is specified by its center point, orientation and length. Parameters centerPoint:Point2D the edge's center point orientation:Orientation the edge's orientation length:double the edge's length; must be non-negative.

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. 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. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

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.

Annotations

@Override

getCenterPoint	back to summary
public Point2D getCenterPoint() Returns:Point2D the edge's center point

getLength	back to summary
public double getLength() Returns:double the edge's length

getLowerRight back to summary

getLowerRight	back to summary
public Point2D getLowerRight() Returns the edge's lower right end point. It has (`length` / 2) distance from the center point and depending on the edge's orientation either the same X (for `Orientation#HORIZONTAL`) or Y (for `Orientation#VERTICAL`) coordinate. Returns:Point2D the edge's lower right point

public Point2D getLowerRight()

Returns the edge's lower right end point. It has (length / 2) distance from the center point and depending on the edge's orientation either the same X (for Orientation#HORIZONTAL) or Y (for Orientation#VERTICAL) coordinate.

Returns:Point2D: the edge's lower right point

getOrientation back to summary

getOrientation	back to summary
public Orientation getOrientation() Returns this edge's orientation. Note that the orientation can also be checked with `isHorizontal()` and `isVertical()`. Returns:Orientation the edge's orientation

public Orientation getOrientation()

Returns this edge's orientation. Note that the orientation can also be checked with isHorizontal() and isVertical().

Returns:Orientation: the edge's orientation

getOrthogonalDifference	back to summary
public double getOrthogonalDifference(Point2D otherPoint) Returns the distance of the specified point to the edge in terms of the dimension orthogonal to the edge's orientation. The sign denotes whether on which side of the edge, the point lies. So e.g. if the edge is horizontal, only the Y coordinate's difference between the specified point and the edge is considered. If the point lies to the right of the edge, the returned value is positive. Parameters otherPoint:Point2D the point to where the distance is computed Returns:double the distance

getOrthogonalDifference

back to summary

public double getOrthogonalDifference(Point2D otherPoint)

Returns the distance of the specified point to the edge in terms of the dimension orthogonal to the edge's orientation. The sign denotes whether on which side of the edge, the point lies.
So e.g. if the edge is horizontal, only the Y coordinate's difference between the specified point and the edge is considered. If the point lies to the right of the edge, the returned value is positive.

Parameters

otherPoint:Point2D: the point to where the distance is computed

Returns:double

the distance

getUpperLeft back to summary

getUpperLeft	back to summary
public Point2D getUpperLeft() Returns the edge's upper left end point. It has (`length` / 2) distance from the center point and depending on the edge's orientation either the same X (for `Orientation#HORIZONTAL`) or Y (for `Orientation#VERTICAL`) coordinate. Returns:Point2D the edge's upper left point

public Point2D getUpperLeft()

Returns the edge's upper left end point. It has (length / 2) distance from the center point and depending on the edge's orientation either the same X (for Orientation#HORIZONTAL) or Y (for Orientation#VERTICAL) coordinate.

Returns:Point2D: the edge's upper left point

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this 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 `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. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this 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 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.

Annotations

@Override

isHorizontal back to summary

isHorizontal	back to summary
public boolean isHorizontal() Indicates whether this is a `horizontal` edge. Returns:boolean true if `getOrientation()` returns `Orientation#HORIZONTAL`

public boolean isHorizontal()

Indicates whether this is a horizontal edge.

Returns:boolean: true if getOrientation() returns Orientation#HORIZONTAL

isVertical back to summary

isVertical	back to summary
public boolean isVertical() Indicates whether this is a `horizontal` edge. Returns:boolean true if `getOrientation()` returns `Orientation#VERTICAL`

public boolean isVertical()

Indicates whether this is a horizontal edge.

Returns:boolean: true if getOrientation() returns Orientation#VERTICAL

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public Class Edge2D

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail