AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
|
#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.4.0/src/axom/primal/geometry/Ray.hpp>
Public Types | |
typedef Point< T, NDIMS > | PointType |
typedef Segment< T, NDIMS > | SegmentType |
typedef Vector< T, NDIMS > | VectorType |
Public Member Functions | |
Ray (const PointType &origin, const VectorType &direction) | |
Constructs a ray object with the given origin and direction. More... | |
Ray (const SegmentType &S) | |
Constructs a ray object from a directed segment. More... | |
~Ray () | |
Ray Destructor. More... | |
const PointType & | origin () const |
Returns the point of origin of this Ray instance. More... | |
PointType | at (const T &t) const |
Returns a point along the ray by evaluating \( R(t) \). More... | |
const VectorType & | direction () const |
Returns the direction vector of this Ray instance. More... | |
std::ostream & | print (std::ostream &os) const |
Simple formatted print of a ray instance. More... | |
typedef Point<T, NDIMS> axom::primal::Ray< T, NDIMS >::PointType |
typedef Segment<T, NDIMS> axom::primal::Ray< T, NDIMS >::SegmentType |
typedef Vector<T, NDIMS> axom::primal::Ray< T, NDIMS >::VectorType |
axom::primal::Ray< T, NDIMS >::Ray | ( | const PointType & | origin, |
const VectorType & | direction | ||
) |
Constructs a ray object with the given origin and direction.
[in] | origin | the origin of the ray. |
[in] | direction | the direction of the ray. |
References SLIC_ASSERT, and axom::primal::Vector< T, NDIMS >::squared_norm().
|
explicit |
Constructs a ray object from a directed segment.
[in] | S | user-supplied segment. |
References axom::primal::Segment< T, NDIMS >::source(), axom::primal::Segment< T, NDIMS >::target(), and axom::primal::Vector< T, NDIMS >::unitVector().
axom::primal::Ray< T, NDIMS >::~Ray | ( | ) |
Ray Destructor.
|
inline |
Returns the point of origin of this Ray instance.
References axom::primal::Ray< T, NDIMS >::at().
|
inline |
Returns a point along the ray by evaluating \( R(t) \).
[in] | t | user-supplied value for R(t). |
Referenced by axom::primal::Ray< T, NDIMS >::origin().
|
inline |
Returns the direction vector of this Ray instance.
Referenced by axom::quest::InOutOctree< DIM >::generateIndex().
|
inline |
Simple formatted print of a ray instance.
os | The output stream to write to |