| public |
Inheritance Graph
graph BT
_Line
_Line --> _LineBase
click _Line "classGeometry_1_1__Line"
click _LineBase "classGeometry_1_1__LineBase"
Description
Line defined by anoriginand adirection. Points p on the line fulfill the equation p =origin+*direction** t for arbitrary values of t.
Public Functions
| _Line(const vec_t & _origin, const vec_t & _direction) | |
| _Line() | |
| std::pair< value_t, value_t > | getClosestValues(const line_t & lineB) const |
| std::pair< value_t, value_t > | getClosestValues(const ray_t & ray) const |
| vec_t | getClosestPointToRay(const ray_t & ray) const |
| void | normalize() |
| void | setDirection(const vec_t & newDirection) |
| void | setOrigin(const vec_t & newOrigin) |
Documentation
function
Geometry::_Line::_Line
| public | inline |
| _Line( | const vec_t & | _origin, |
| const vec_t & | _direction | |
| ) |
Defined in Geometry/Line.h:142
function
Geometry::_Line::_Line
| public | inline |
| _Line( | ) |
Defined in Geometry/Line.h:146
function
Geometry::_Line::getClosestValues
| public | const | inline |
| std::pair< value_t, value_t > getClosestValues( | const line_t & | lineB ) const |
Calculate a pair of points (= values for points) on this line and the givenlineBthat is closest to each other.
Parameters
- lineB
- The second line
Returns
pair(parameterA,parameterB) Return value that can be used to calculate the point on the lines
Note: The function* [_Line<_T>::getPoint](classGeometry_1_1%5F%5FLineBase#classGeometry_1_1%5F%5FLineBase_1a88fe304ea210b3731917159f07a43721) *can be used with the returned parameters as argument to calculate the points.
Note: The direction vectors is required to have unit length.
Author: Benjamin Eikel
Date: 2010-10-14
Defined in Geometry/Line.h:163
function
Geometry::_Line::getClosestValues
| public | const | inline |
| std::pair< value_t, value_t > getClosestValues( | const ray_t & | ray ) const |
Calculate a pair of points (= values for points) on this line and givenraythat is closest to each other.
Parameters
- ray
- The ray
Returns
pair(parameterA,parameterB) Return value that can be used to calculate the point on the line and the ray
Note: The function* [_Line<_T>::getPoint](classGeometry_1_1%5F%5FLineBase#classGeometry_1_1%5F%5FLineBase_1a88fe304ea210b3731917159f07a43721) *and* [_Ray<_T>::getPoint](classGeometry_1_1%5F%5FLineBase#classGeometry_1_1%5F%5FLineBase_1a88fe304ea210b3731917159f07a43721) *can be used with the returned parameters as argument to calculate the points.
Note: The direction vectors is required to have unit length.
Author: Benjamin Eikel
Date: 2010-10-14
Defined in Geometry/Line.h:206
function
Geometry::_Line::getClosestPointToRay
| public | const | inline |
| vec_t getClosestPointToRay( | const ray_t & | ray ) const |
Defined in Geometry/Line.h:244
function
Geometry::_Line::normalize
| public | inline |
| void normalize( | ) |
Defined in Geometry/Line.h:248
function
Geometry::_Line::setDirection
| public | inline |
| void setDirection( | const vec_t & | newDirection ) |
Defined in Geometry/Line.h:251
function
Geometry::_Line::setOrigin
| public | inline |
| void setOrigin( | const vec_t & | newOrigin ) |
Defined in Geometry/Line.h:254