AxisAlignedBox Class Reference
Detailed Description
Implements BoundingRegion abstract class for axis-aligned-box-shaped bounding regions.
#include <include/maliput/math/axis_aligned_box.h>
Inheritance diagram for AxisAlignedBox:
Public Member Functions | |
| AxisAlignedBox (const Vector3 &min_corner, const Vector3 &max_corner) | |
| AxisAlignedBox (const Vector3 &min_corner, const Vector3 &max_corner, double tolerance) | |
| ~AxisAlignedBox ()=default | |
| const Vector3 & | min_corner () const |
| Get the minimum corner of the bounding box. More... | |
| const Vector3 & | max_corner () const |
| Get the maximum corner of the bounding box. More... | |
| std::vector< Vector3 > | get_vertices () const |
| bool | IsBoxContained (const AxisAlignedBox &other) const |
| bool | IsBoxIntersected (const AxisAlignedBox &other) const |
| std::optional< AxisAlignedBox > | GetIntersection (const AxisAlignedBox &other) const |
Computes the intersection of this region with other . More... | |
 Public Member Functions inherited from BoundingRegion< Vector3 > | |
| virtual | ~BoundingRegion ()=default |
| const Vector3 & | position () const |
| Obtains the bounding region's position in the Inertial-frame. More... | |
| bool | Contains (const Vector3 &position) const |
Determines whether a position in the Inertial-frame is contained in this bounding region. More... | |
| OverlappingType | Overlaps (const BoundingRegion< Vector3 > &other) const |
Determines the overlapping type with other BoundingRegion instance. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from BoundingRegion< Vector3 > | |
| BoundingRegion ()=default | |
Constructor & Destructor Documentation
◆ AxisAlignedBox() [1/2]
| AxisAlignedBox | ( | const Vector3 & | min_corner, |
| const Vector3 & | max_corner | ||
| ) |
◆ AxisAlignedBox() [2/2]
| AxisAlignedBox | ( | const Vector3 & | min_corner, |
| const Vector3 & | max_corner, | ||
| double | tolerance | ||
| ) |
◆ ~AxisAlignedBox()
|
default |
Member Function Documentation
◆ get_vertices()
| std::vector< Vector3 > get_vertices | ( | ) | const |
- Returns
- The vertices of the bounding box in the Inertial-frame.
◆ GetIntersection()
| std::optional< AxisAlignedBox > GetIntersection | ( | const AxisAlignedBox & | other | ) | const |
Computes the intersection of this region with other .
- Parameters
-
other The other region to intersect with.
- Returns
- The intersection of this region with
other.
◆ IsBoxContained()
| bool IsBoxContained | ( | const AxisAlignedBox & | other | ) | const |
- Returns
- True when this region contains
other.
◆ IsBoxIntersected()
| bool IsBoxIntersected | ( | const AxisAlignedBox & | other | ) | const |
- Returns
- True when this region intersects
other.
◆ max_corner()
| const Vector3& max_corner | ( | ) | const |
Get the maximum corner of the bounding box.
◆ min_corner()
| const Vector3& min_corner | ( | ) | const |
Get the minimum corner of the bounding box.
The documentation for this class was generated from the following files:
