Represents a 2d rectangular space containing translational, rotational, and scaling components.
More...
#include <frc/geometry/Rectangle2d.h>
Represents a 2d rectangular space containing translational, rotational, and scaling components.
◆ Rectangle2d() [1/2]
| constexpr frc::Rectangle2d::Rectangle2d |
( |
const Pose2d & |
center, |
|
|
units::meter_t |
xWidth, |
|
|
units::meter_t |
yWidth |
|
) |
| |
|
inlineconstexpr |
Constructs a rectangle at the specified position with the specified width and height.
- Parameters
-
| center | The position (translation and rotation) of the rectangle. |
| xWidth | The x size component of the rectangle, in unrotated coordinate frame. |
| yWidth | The y size component of the rectangle, in unrotated coordinate frame. |
◆ Rectangle2d() [2/2]
Creates an unrotated rectangle from the given corners.
The corners should be diagonally opposite of each other.
- Parameters
-
| cornerA | The first corner of the rectangle. |
| cornerB | The second corner of the rectangle. |
◆ Center()
| constexpr const Pose2d & frc::Rectangle2d::Center |
( |
| ) |
const |
|
inlineconstexpr |
Returns the center of the rectangle.
- Returns
- The center of the rectangle.
◆ Contains()
| constexpr bool frc::Rectangle2d::Contains |
( |
const Translation2d & |
point | ) |
const |
|
inlineconstexpr |
Checks if a point is contained within the rectangle.
This is inclusive, if the point lies on the perimeter it will return true.
- Parameters
-
- Returns
- True, if the rectangle contains the point or the perimeter intersects the point.
◆ Distance()
| constexpr units::meter_t frc::Rectangle2d::Distance |
( |
const Translation2d & |
point | ) |
const |
|
inlineconstexpr |
Returns the distance between the perimeter of the rectangle and the point.
- Parameters
-
- Returns
- The distance (0, if the point is contained by the rectangle)
◆ FindNearestPoint()
Returns the nearest point that is contained within the rectangle.
- Parameters
-
| point | The point that this will find the nearest point to. |
- Returns
- A new point that is nearest to
point and contained in the rectangle.
◆ Intersects()
| constexpr bool frc::Rectangle2d::Intersects |
( |
const Translation2d & |
point | ) |
const |
|
inlineconstexpr |
Checks if a point is intersected by the rectangle's perimeter.
- Parameters
-
- Returns
- True, if the rectangle's perimeter intersects the point.
◆ operator==()
| constexpr bool frc::Rectangle2d::operator== |
( |
const Rectangle2d & |
other | ) |
const |
|
inlineconstexpr |
Checks equality between this Rectangle2d and another object.
- Parameters
-
- Returns
- Whether the two objects are equal.
◆ RotateBy()
Rotates the center of the rectangle and returns the new rectangle.
- Parameters
-
| other | The rotation to transform by. |
- Returns
- The rotated rectangle.
◆ Rotation()
| constexpr const Rotation2d & frc::Rectangle2d::Rotation |
( |
| ) |
const |
|
inlineconstexpr |
Returns the rotational component of the rectangle.
- Returns
- The rotational component of the rectangle.
◆ TransformBy()
Transforms the center of the rectangle and returns the new rectangle.
- Parameters
-
| other | The transform to transform by. |
- Returns
- The transformed rectangle
◆ XWidth()
| constexpr units::meter_t frc::Rectangle2d::XWidth |
( |
| ) |
const |
|
inlineconstexpr |
Returns the x size component of the rectangle.
- Returns
- The x size component of the rectangle.
◆ YWidth()
| constexpr units::meter_t frc::Rectangle2d::YWidth |
( |
| ) |
const |
|
inlineconstexpr |
Returns the y size component of the rectangle.
- Returns
- The y size component of the rectangle.
The documentation for this class was generated from the following file:
1.9.4