#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/primal/geometry/Segment.hpp>
◆ PointType
template<typename T , int NDIMS>
◆ VectorType
template<typename T , int NDIMS>
◆ anonymous enum
template<typename T , int NDIMS>
◆ Segment() [1/2]
template<typename T , int NDIMS>
◆ Segment() [2/2]
template<typename T , int NDIMS>
Creates a segment instance from point A to point B.
- Parameters
-
A | user-supplied source point |
B | user-supplied target point |
◆ source()
template<typename T , int NDIMS>
Returns the source point of the segment.
- Returns
- s the source point of the segment.
◆ target()
template<typename T , int NDIMS>
Returns the target point of the segment.
- Returns
- t the target point of the segment.
◆ operator[]() [1/2]
template<typename T , int NDIMS>
◆ operator[]() [2/2]
template<typename T , int NDIMS>
◆ at()
template<typename T , int NDIMS>
Returns a point \( (1 - t)A + tB \).
- Parameters
-
[in] | t | user-supplied parameter for blending A and B |
- Postcondition
- Return point P will always be collinear with the segment's start point A and end point B.
-
If \( t = 0, \) the return point \( P = A. \)
-
If \( t = 1, \) the return point \( P = B. \)
References axom::primal::Point< T, NDIMS >::lerp().
◆ length()
template<typename T , int NDIMS>
Returns the length of the segment.
◆ normal()
template<typename T , int NDIMS>
template<int TDIM = NDIMS>
Returns a vector normal to the segment.
- Note
- Only available in 2D
◆ print()
template<typename T , int NDIMS>
Simple formatted print of a segment instance.
- Parameters
-
os | The output stream to write to |
- Returns
- A reference to the modified ostream
◆ operator==
template<typename T , int NDIMS>
bool operator== |
( |
const Segment< T, NDIMS > & |
lhs, |
|
|
const Segment< T, NDIMS > & |
rhs |
|
) |
| |
|
friend |
Equality comparison operator for segments.
◆ operator!=
template<typename T , int NDIMS>
bool operator!= |
( |
const Segment< T, NDIMS > & |
lhs, |
|
|
const Segment< T, NDIMS > & |
rhs |
|
) |
| |
|
friend |
Inequality operator for segments.
The documentation for this class was generated from the following file:
- /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/primal/geometry/Segment.hpp