Class describing a Plane in the 3D space.
More...
#include <dataobjects/Plane.h>
Class describing a Plane in the 3D space.
◆ Plane() [1/4]
| Herd::Plane::Plane |
( |
Point |
point, |
|
|
const float |
polar, |
|
|
const float |
azimuth |
|
) |
| |
Constructor.
Constructs a infinite plane starting from a point on the plane (the "point of origin") and two angles defining the normal to the plane.
- Parameters
-
| point | A point on the plane [cm]. |
| polar | The polar angle of the normal [rad]. |
| azimuth | The azimuth angle of the normal [rad]. |
◆ Plane() [2/4]
Constructor.
Constructs a infinite plane starting from a point on the plane (the "point of origin") and the normal vector to the plane.
- Parameters
-
| point | A point on the plane [cm]. |
| normal | The normal vector. |
◆ Plane() [3/4]
| Herd::Plane::Plane |
( |
std::array< Point, 3 > |
points | ) |
|
Constructor.
Constructs a infinite plane from three points, using one of the point ("point of origin") and the normal vector to the two vectors defined with the three points (the normal vector to the plane).
- Parameters
-
| points | The points defining the rectangle. |
- Exceptions
-
| #Exception | if the given points are aligned. |
◆ Plane() [4/4]
Default constructor.
Constructs a infinite plane with default value
- Parameters
-
| point | A point on the plane [cm]. |
| polar | The polar angle of the normal [rad]. |
| azimuth | The azimuth angle of the normal [rad]. |
◆ ~Plane()
| virtual Herd::Plane::~Plane |
( |
| ) |
|
|
virtualdefault |
◆ Azimuth()
| float Herd::Plane::Azimuth |
( |
| ) |
const |
|
inline |
Returns the azimuth angle of the plane.
- Returns
- the azimuth angle [rad].
◆ Intersection()
| Point Herd::Plane::Intersection |
( |
Line |
line | ) |
const |
Returns the intersect between this plane and a Line If the plane and line are parallel, a point with the default coordinate: [std::numeric_limits<float>::max(), std::numeric_limits<float>::max(), std::numeric_limits<float>::max()].
- Parameters
-
- Returns
- The point of the intersect.
◆ Normal()
| Vec3D Herd::Plane::Normal |
( |
| ) |
const |
|
inline |
Returns the normal to the plane.
- Returns
- the normal vector.
◆ operator==()
| bool Herd::Plane::operator== |
( |
const Plane & |
rhs | ) |
const |
|
inline |
Comparison operator.
- Parameters
-
| rhs | The right-hand-side object of the comparison operation. |
- Returns
- true if the two Planes are member-wise equal.
◆ Origin()
| Point Herd::Plane::Origin |
( |
| ) |
const |
|
inline |
Returns the "point of origin" of the plane.
The "point of origin" is the point passed to the constructor to build the plane.
- Returns
- the "origin point" (cm, cm, cm).
◆ Polar()
| float Herd::Plane::Polar |
( |
| ) |
const |
|
inline |
Returns the polar angle of the normal of the plane with respect to the NEGATIVE Z axis.
The angle is 0 for a plane with the normal along the Z axis towards the negative direction.
- Returns
- the polar angle [rad].
◆ _normal
| Vec3D Herd::Plane::_normal |
|
private |
◆ _point
| Point Herd::Plane::_point |
|
private |
The documentation for this class was generated from the following files:
- /builds/herd/HerdSoftware/include/analysis/dataobjects/Plane.h
- /builds/herd/HerdSoftware/src/analysis/dataobjects/Plane.cpp
