Main MRPT website > C++ reference
MRPT logo
List of all members | Public Member Functions | Public Attributes

Detailed Description

3D Plane, represented by its equation $Ax+By+Cz+D=0$

See also
TSegment3D,TLine3D,TPolygon3D,TPoint3D

Definition at line 975 of file lightweight_geom_data.h.

#include <mrpt/math/lightweight_geom_data.h>

Public Member Functions

double evaluatePoint (const TPoint3D &point) const
 Evaluate a point in the plane's equation. More...
 
bool contains (const TPoint3D &point) const
 Check whether a point is contained into the plane. More...
 
bool contains (const TSegment3D &segment) const
 Check whether a segment is fully contained into the plane. More...
 
bool contains (const TLine3D &line) const
 Check whether a line is fully contained into the plane. More...
 
double distance (const TPoint3D &point) const
 Distance to 3D point. More...
 
double distance (const TLine3D &line) const
 Distance to 3D line. More...
 
void getNormalVector (double(&vec)[3]) const
 Get plane's normal vector. More...
 
void unitarize ()
 Unitarize normal vector. More...
 
void getUnitaryNormalVector (double(&vec)[3])
 Unitarize, then get normal vector. More...
 
void getAsPose3D (mrpt::poses::CPose3D &outPose)
 Gets a pose whose XY plane corresponds to this plane. More...
 
void getAsPose3D (mrpt::poses::CPose3D &outPose) const
 Gets a pose whose XY plane corresponds to this plane. More...
 
void getAsPose3DForcingOrigin (const TPoint3D &newOrigin, mrpt::poses::CPose3D &pose)
 Gets a pose whose XY plane corresponds to this, forcing an exact point as its spatial coordinates. More...
 
void getAsPose3DForcingOrigin (const TPoint3D &newOrigin, mrpt::poses::CPose3D &pose) const
 Gets a pose whose XY plane corresponds to this, forcing an exact point as its spatial coordinates. More...
 
 TPlane (const TPoint3D &p1, const TPoint3D &p2, const TPoint3D &p3) throw (std::logic_error)
 Gets a plane which contains these three points. More...
 
 TPlane (const TPoint3D &p1, const TLine3D &r2) throw (std::logic_error)
 Gets a plane which contains this point and this line. More...
 
 TPlane (const TLine3D &r1, const TLine3D &r2) throw (std::logic_error)
 Gets a plane which contains the two lines. More...
 
 TPlane ()
 Fast default constructor. More...
 
 TPlane (double A, double B, double C, double D)
 Constructor from plane coefficients. More...
 
 TPlane (const double(&vec)[4])
 Constructor from an array of coefficients. More...
 

Public Attributes

double coefs [4]
 Plane coefficients, stored as an array: $\left[A,B,C,D\right]$. More...
 

Constructor & Destructor Documentation

◆ TPlane() [1/6]

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

Gets a plane which contains these three points.

Exceptions
std::logic_errorif the points are linearly dependants.

◆ TPlane() [2/6]

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

Gets a plane which contains this point and this line.

Exceptions
std::logic_errorif the point is inside the line.

◆ TPlane() [3/6]

mrpt::math::TPlane::TPlane ( const TLine3D r1,
const TLine3D r2 
)
throw (std::logic_error
)

Gets a plane which contains the two lines.

Exceptions
std::logic_errorif the lines do not cross.

◆ TPlane() [4/6]

mrpt::math::TPlane::TPlane ( )
inline

Fast default constructor.

Initializes to garbage.

Definition at line 1064 of file lightweight_geom_data.h.

◆ TPlane() [5/6]

mrpt::math::TPlane::TPlane ( double  A,
double  B,
double  C,
double  D 
)
inline

Constructor from plane coefficients.

Definition at line 1068 of file lightweight_geom_data.h.

◆ TPlane() [6/6]

mrpt::math::TPlane::TPlane ( const double(&)  vec[4])
inline

Constructor from an array of coefficients.

Definition at line 1077 of file lightweight_geom_data.h.

Member Function Documentation

◆ contains() [1/3]

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

Check whether a point is contained into the plane.

◆ contains() [2/3]

bool mrpt::math::TPlane::contains ( const TSegment3D segment) const
inline

Check whether a segment is fully contained into the plane.

Definition at line 992 of file lightweight_geom_data.h.

References mrpt::math::TSegment3D::point1, and mrpt::math::TSegment3D::point2.

◆ contains() [3/3]

bool mrpt::math::TPlane::contains ( const TLine3D line) const

Check whether a line is fully contained into the plane.

◆ distance() [1/2]

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

Distance to 3D point.

◆ distance() [2/2]

double mrpt::math::TPlane::distance ( const TLine3D line) const

Distance to 3D line.

Will be zero if the line is not parallel to the plane.

◆ evaluatePoint()

double mrpt::math::TPlane::evaluatePoint ( const TPoint3D point) const

Evaluate a point in the plane's equation.

◆ getAsPose3D() [1/2]

void mrpt::math::TPlane::getAsPose3D ( mrpt::poses::CPose3D outPose)

Gets a pose whose XY plane corresponds to this plane.

Referenced by getAsPose3D(), and mrpt::math::project3D().

◆ getAsPose3D() [2/2]

void mrpt::math::TPlane::getAsPose3D ( mrpt::poses::CPose3D outPose) const
inline

Gets a pose whose XY plane corresponds to this plane.

Definition at line 1029 of file lightweight_geom_data.h.

References getAsPose3D().

◆ getAsPose3DForcingOrigin() [1/2]

void mrpt::math::TPlane::getAsPose3DForcingOrigin ( const TPoint3D newOrigin,
mrpt::poses::CPose3D pose 
)

Gets a pose whose XY plane corresponds to this, forcing an exact point as its spatial coordinates.

Exceptions
std::logic_errorif the point is not inside the plane.

Referenced by getAsPose3DForcingOrigin().

◆ getAsPose3DForcingOrigin() [2/2]

void mrpt::math::TPlane::getAsPose3DForcingOrigin ( const TPoint3D newOrigin,
mrpt::poses::CPose3D pose 
) const
inline

Gets a pose whose XY plane corresponds to this, forcing an exact point as its spatial coordinates.

Exceptions
std::logic_errorif the point is not inside the plane.

Definition at line 1042 of file lightweight_geom_data.h.

References getAsPose3DForcingOrigin().

◆ getNormalVector()

void mrpt::math::TPlane::getNormalVector ( double(&)  vec[3]) const

Get plane's normal vector.

◆ getUnitaryNormalVector()

void mrpt::math::TPlane::getUnitaryNormalVector ( double(&)  vec[3])
inline

Unitarize, then get normal vector.

Definition at line 1018 of file lightweight_geom_data.h.

◆ unitarize()

void mrpt::math::TPlane::unitarize ( )

Unitarize normal vector.

Member Data Documentation

◆ coefs

double mrpt::math::TPlane::coefs[4]

Plane coefficients, stored as an array: $\left[A,B,C,D\right]$.

Definition at line 980 of file lightweight_geom_data.h.

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




Page generated by Doxygen 1.8.14 for MRPT 1.0.2 SVN: at lun oct 28 00:52:41 CET 2019 Hosted on:
SourceForge.net Logo