Class BoundingBox
- All Implemented Interfaces:
Serializable
A bounding box is characterised by a reference point that is located in the center of the bounding box's base (i.e. at height 0). Therefore, the length and width of the bounding box are symmetrical in relation to the reference point and the height is measured from the base of the bounding box. Additionally, an offset to the reference point describes the position of the bounding box in relation to another point. This is useful when describing the bounding box of an object whose reference point is not at its geometric center. The coordinates of the reference offset refer to a coordinate system whose origin is located at the bounding box's reference point and whose axes run along the longitudinal and transverse axes of the bounding box (i.e. the x-coordinate of the reference offset runs along the length and the y-coordinate along the width of the bounding box).
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionBoundingBox
(long length, long width, long height) Creates a new instance with a (0, 0) reference offset. -
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
long
Returns the bounding box's height.long
Returns the bounding box's length.Returns the bounding box's reference offset.long
getWidth()
Returns the bounding box's width.int
hashCode()
toString()
withHeight
(long height) Creates a copy of this object, with the given height.withLength
(long length) Creates a copy of this object, with the given length.withReferenceOffset
(Couple referenceOffset) Creates a copy of this object, with the given reference offset.withWidth
(long width) Creates a copy of this object, with the given width.
-
Constructor Details
-
BoundingBox
public BoundingBox(long length, long width, long height) Creates a new instance with a (0, 0) reference offset.- Parameters:
length
- The bounding box's length.width
- The bounding box's width.height
- The bounding box's height.
-
-
Method Details
-
getLength
public long getLength()Returns the bounding box's length.- Returns:
- The bounding box's length.
-
withLength
Creates a copy of this object, with the given length.- Parameters:
length
- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getWidth
public long getWidth()Returns the bounding box's width.- Returns:
- The bounding box's width.
-
withWidth
Creates a copy of this object, with the given width.- Parameters:
width
- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getHeight
public long getHeight()Returns the bounding box's height.- Returns:
- The bounding box's height.
-
withHeight
Creates a copy of this object, with the given height.- Parameters:
height
- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getReferenceOffset
Returns the bounding box's reference offset.- Returns:
- The bounding box's reference offset.
-
withReferenceOffset
Creates a copy of this object, with the given reference offset.- Parameters:
referenceOffset
- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
equals
-
hashCode
public int hashCode() -
toString
-