java.lang.Object
javafx.geometry.Bounds
- Direct Known Subclasses:
BoundingBox
public abstract class Bounds extends Object
The base class for objects that are used to describe the bounds of a node or
other scene graph object. One interesting characteristic of a Bounds object
is that it may have a negative width, height, or depth. A negative value
for any of these indicates that the Bounds are "empty".
- Since:
- JavaFX 2.0
-
Constructor Summary
Constructors Modifier Constructor Description protected
Bounds(double minX, double minY, double minZ, double width, double height, double depth)
Creates a new instance ofBounds
class. -
Method Summary
Modifier and Type Method Description abstract boolean
contains(double x, double y)
Tests if the specified(x, y)
coordinates are inside the boundary ofBounds
.abstract boolean
contains(double x, double y, double z)
Tests if the specified(x, y, z)
coordinates are inside the boundary ofBounds
.abstract boolean
contains(double x, double y, double w, double h)
Tests if the interior of thisBounds
entirely contains the specified rectangular area.abstract boolean
contains(double x, double y, double z, double w, double h, double d)
Tests if the interior of thisBounds
entirely contains the specified rectangular area.abstract boolean
contains(Bounds b)
Tests if the interior of thisBounds
entirely contains the specified Bounds,b
.abstract boolean
contains(Point2D p)
Tests if the specified point is inside the boundary ofBounds
.abstract boolean
contains(Point3D p)
Tests if the specified point is inside the boundary ofBounds
.double
getCenterX()
The central x coordinate of thisBounds
.double
getCenterY()
The central y coordinate of thisBounds
.double
getCenterZ()
The central z coordinate of thisBounds
.double
getDepth()
The depth of thisBounds
.double
getHeight()
The height of thisBounds
.double
getMaxX()
The x coordinate of the lower-right corner of thisBounds
.double
getMaxY()
The y coordinate of the lower-right corner of thisBounds
.double
getMaxZ()
The maximum z coordinate of thisBounds
.double
getMinX()
The x coordinate of the upper-left corner of thisBounds
.double
getMinY()
The y coordinate of the upper-left corner of thisBounds
.double
getMinZ()
The minimum z coordinate of thisBounds
.double
getWidth()
The width of thisBounds
.abstract boolean
intersects(double x, double y, double w, double h)
Tests if the interior of thisBounds
intersects the interior of a specified rectangular area.abstract boolean
intersects(double x, double y, double z, double w, double h, double d)
Tests if the interior of thisBounds
intersects the interior of a specified rectangular area.abstract boolean
intersects(Bounds b)
Tests if the interior of thisBounds
intersects the interior of a specified Bounds,b
.abstract boolean
isEmpty()
Indicates whether any of the dimensions(width, height or depth) of this bounds is less than zero.
-
Constructor Details
-
Bounds
protected Bounds(double minX, double minY, double minZ, double width, double height, double depth)Creates a new instance ofBounds
class.- Parameters:
minX
- the X coordinate of the upper-left cornerminY
- the Y coordinate of the upper-left cornerminZ
- the minimum z coordinate of theBounds
width
- the width of theBounds
height
- the height of theBounds
depth
- the depth of theBounds
-
-
Method Details
-
getMinX
public final double getMinX()The x coordinate of the upper-left corner of thisBounds
.- Default value:
- 0.0
- Returns:
- the x coordinate of the upper-left corner
-
getMinY
public final double getMinY()The y coordinate of the upper-left corner of thisBounds
.- Default value:
- 0.0
- Returns:
- the y coordinate of the upper-left corner
-
getMinZ
public final double getMinZ()The minimum z coordinate of thisBounds
.- Default value:
- 0.0
- Returns:
- the minimum z coordinate
-
getWidth
public final double getWidth()The width of thisBounds
.- Default value:
- 0.0
- Returns:
- the width
-
getHeight
public final double getHeight()The height of thisBounds
.- Default value:
- 0.0
- Returns:
- the height
-
getDepth
public final double getDepth()The depth of thisBounds
.- Default value:
- 0.0
- Returns:
- the depth
-
getMaxX
public final double getMaxX()The x coordinate of the lower-right corner of thisBounds
.- Default value:
minX + width
- Returns:
- the x coordinate of the lower-right corner
-
getMaxY
public final double getMaxY()The y coordinate of the lower-right corner of thisBounds
.- Default value:
minY + height
- Returns:
- the y coordinate of the lower-right corner
-
getMaxZ
public final double getMaxZ()The maximum z coordinate of thisBounds
.- Default value:
minZ + depth
- Returns:
- the maximum z coordinate
-
getCenterX
public final double getCenterX()The central x coordinate of thisBounds
.- Implementation Requirements:
- This call is equivalent to
(getMaxX() + getMinX())/2.0
. - Returns:
- the central x coordinate
- Since:
- 11
-
getCenterY
public final double getCenterY()The central y coordinate of thisBounds
.- Implementation Requirements:
- This call is equivalent to
(getMaxY() + getMinY())/2.0
. - Returns:
- the central y coordinate
- Since:
- 11
-
getCenterZ
public final double getCenterZ()The central z coordinate of thisBounds
.- Implementation Requirements:
- This call is equivalent to
(getMaxZ() + getMinZ())/2.0
. - Returns:
- the central z coordinate
- Since:
- 11
-
isEmpty
public abstract boolean isEmpty()Indicates whether any of the dimensions(width, height or depth) of this bounds is less than zero.- Returns:
- true if any of the dimensions(width, height or depth) of this bounds is less than zero
-
contains
Tests if the specified point is inside the boundary ofBounds
.- Parameters:
p
- the specified point to be tested- Returns:
- true if the specified point is inside the boundary of this
Bounds
; false otherwise
-
contains
Tests if the specified point is inside the boundary ofBounds
.- Parameters:
p
- the specified 3D point to be tested- Returns:
- true if the specified point is inside the boundary of this
Bounds
; false otherwise
-
contains
public abstract boolean contains(double x, double y)Tests if the specified(x, y)
coordinates are inside the boundary ofBounds
.- Parameters:
x
- the specified x coordinate to be testedy
- the specified y coordinate to be tested- Returns:
- true if the specified
(x, y)
coordinates are inside the boundary of thisBounds
; false otherwise
-
contains
public abstract boolean contains(double x, double y, double z)Tests if the specified(x, y, z)
coordinates are inside the boundary ofBounds
.- Parameters:
x
- the specified x coordinate to be testedy
- the specified y coordinate to be testedz
- the specified z coordinate to be tested- Returns:
- true if the specified
(x, y)
coordinates are inside the boundary of thisBounds
; false otherwise
-
contains
Tests if the interior of thisBounds
entirely contains the specified Bounds,b
.- Parameters:
b
- The specified Bounds- Returns:
- true if the specified Bounds,
b
, is inside the boundary of thisBounds
; false otherwise
-
contains
public abstract boolean contains(double x, double y, double w, double h)Tests if the interior of thisBounds
entirely contains the specified rectangular area.- Parameters:
x
- the x coordinate of the upper-left corner of the specified rectangular areay
- the y coordinate of the upper-left corner of the specified rectangular areaw
- the width of the specified rectangular areah
- the height of the specified rectangular area- Returns:
- true if the interior of this
Bounds
entirely contains the specified rectangular area; false otherwise
-
contains
public abstract boolean contains(double x, double y, double z, double w, double h, double d)Tests if the interior of thisBounds
entirely contains the specified rectangular area.- Parameters:
x
- the x coordinate of the upper-left corner of the specified rectangular volumey
- the y coordinate of the upper-left corner of the specified rectangular volumez
- the z coordinate of the upper-left corner of the specified rectangular volumew
- the width of the specified rectangular volumeh
- the height of the specified rectangular volumed
- the depth of the specified rectangular volume- Returns:
- true if the interior of this
Bounds
entirely contains the specified rectangular area; false otherwise
-
intersects
Tests if the interior of thisBounds
intersects the interior of a specified Bounds,b
.- Parameters:
b
- The specified Bounds- Returns:
- true if the interior of this
Bounds
and the interior of the specified Bounds,b
, intersect
-
intersects
public abstract boolean intersects(double x, double y, double w, double h)Tests if the interior of thisBounds
intersects the interior of a specified rectangular area.- Parameters:
x
- the x coordinate of the upper-left corner of the specified rectangular areay
- the y coordinate of the upper-left corner of the specified rectangular areaw
- the width of the specified rectangular areah
- the height of the specified rectangular area- Returns:
- true if the interior of this
Bounds
and the interior of the rectangular area intersect
-
intersects
public abstract boolean intersects(double x, double y, double z, double w, double h, double d)Tests if the interior of thisBounds
intersects the interior of a specified rectangular area.- Parameters:
x
- the x coordinate of the upper-left corner of the specified rectangular volumey
- the y coordinate of the upper-left corner of the specified rectangular volumez
- the z coordinate of the upper-left corner of the specified rectangular volumew
- the width of the specified rectangular volumeh
- the height of the specified rectangular volumed
- the depth of the specified rectangular volume- Returns:
- true if the interior of this
Bounds
and the interior of the rectangular area intersect
-