Main MRPT website > C++ reference
MRPT logo
Public Member Functions | Public Attributes

mrpt::math::TLine3D Struct Reference


Detailed Description

3D line, represented by a base point and a director vector.

See also:
TLine2D,TSegment3D,TPlane,TPolygon3D,TPoint3D

Definition at line 891 of file lightweight_geom_data.h.

#include <mrpt/math/lightweight_geom_data.h>

List of all members.

Public Member Functions

bool contains (const TPoint3D &point) const
 Check whether a point is inside the line.
double distance (const TPoint3D &point) const
 Distance between the line and a point.
void unitarize ()
 Unitarize director vector.
void getDirectorVector (double(&vector)[3]) const
 Get director vector.
void getUnitaryDirectorVector (double(&vector)[3])
 Unitarize and then get director vector.
void generate2DObject (TLine2D &l) const
 Project into 2D space, discarding the Z coordinate.
 TLine3D (const TPoint3D &p1, const TPoint3D &p2) throw (std::logic_error)
 Constructor from two points, through which the line will pass.
 TLine3D (const TSegment3D &s)
 Constructor from 3D segment.
 TLine3D ()
 Fast default constructor.
 TLine3D (const TLine2D &l)
 Implicit constructor from 2D object.

Public Attributes

TPoint3D pBase
 Base point.
double director [3]
 Director vector.

Constructor & Destructor Documentation

mrpt::math::TLine3D::TLine3D ( const TPoint3D p1,
const TPoint3D p2 
) throw (std::logic_error)

Constructor from two points, through which the line will pass.

Exceptions:
std::logic_errorif both points are the same.
mrpt::math::TLine3D::TLine3D ( const TSegment3D s) [explicit]

Constructor from 3D segment.

mrpt::math::TLine3D::TLine3D ( ) [inline]

Fast default constructor.

Initializes to garbage.

Definition at line 945 of file lightweight_geom_data.h.

mrpt::math::TLine3D::TLine3D ( const TLine2D l)

Implicit constructor from 2D object.

Zeroes the z.


Member Function Documentation

bool mrpt::math::TLine3D::contains ( const TPoint3D point) const

Check whether a point is inside the line.

double mrpt::math::TLine3D::distance ( const TPoint3D point) const

Distance between the line and a point.

void mrpt::math::TLine3D::generate2DObject ( TLine2D l) const [inline]

Project into 2D space, discarding the Z coordinate.

Exceptions:
std::logic_errorif the line's director vector is orthogonal to the XY plane.

Definition at line 930 of file lightweight_geom_data.h.

void mrpt::math::TLine3D::getDirectorVector ( double(&)  vector[3]) const [inline]

Get director vector.

Definition at line 916 of file lightweight_geom_data.h.

void mrpt::math::TLine3D::getUnitaryDirectorVector ( double(&)  vector[3]) [inline]

Unitarize and then get director vector.

Definition at line 922 of file lightweight_geom_data.h.

void mrpt::math::TLine3D::unitarize ( )

Unitarize director vector.


Member Data Documentation

Director vector.

Definition at line 900 of file lightweight_geom_data.h.

Referenced by mrpt::math::operator<<(), and mrpt::math::operator>>().

Base point.

Definition at line 896 of file lightweight_geom_data.h.

Referenced by mrpt::math::operator<<(), and mrpt::math::operator>>().




Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN: at Sat Mar 26 06:16:28 UTC 2011