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

Detailed Description

2D segment, consisting of two points.

See also
TSegment3D,TLine2D,TPolygon2D,TPoint2D

Definition at line 658 of file lightweight_geom_data.h.

#include <mrpt/math/lightweight_geom_data.h>

Public Member Functions

double length () const
 Segment length. More...
 
double distance (const TPoint2D &point) const
 Distance to point. More...
 
double signedDistance (const TPoint2D &point) const
 Distance with sign to point (sign indicates which side the point is). More...
 
bool contains (const TPoint2D &point) const
 Check whether a point is inside a segment. More...
 
TPoint2Doperator[] (size_t i)
 Unsafe point access using [] operator, intended for loops. More...
 
const TPoint2Doperator[] (size_t i) const
 Unsafe point access using [] operator, intended for loops. More...
 
void generate3DObject (TSegment3D &s) const
 Project into 3D space, setting the z to 0. More...
 
void getCenter (TPoint2D &p) const
 Segment's central point. More...
 
 TSegment2D (const TPoint2D &p1, const TPoint2D &p2)
 Constructor from both points. More...
 
 TSegment2D ()
 Fast default constructor. More...
 
 TSegment2D (const TSegment3D &s)
 Explicit constructor from 3D object, discarding the z. More...
 
bool operator< (const TSegment2D &s) const
 

Public Attributes

TPoint2D point1
 Origin point. More...
 
TPoint2D point2
 Destiny point. More...
 

Constructor & Destructor Documentation

◆ TSegment2D() [1/3]

mrpt::math::TSegment2D::TSegment2D ( const TPoint2D p1,
const TPoint2D p2 
)
inline

Constructor from both points.

Definition at line 710 of file lightweight_geom_data.h.

◆ TSegment2D() [2/3]

mrpt::math::TSegment2D::TSegment2D ( )
inline

Fast default constructor.

Initializes to garbage.

Definition at line 714 of file lightweight_geom_data.h.

◆ TSegment2D() [3/3]

mrpt::math::TSegment2D::TSegment2D ( const TSegment3D s)
explicit

Explicit constructor from 3D object, discarding the z.

Member Function Documentation

◆ contains()

bool mrpt::math::TSegment2D::contains ( const TPoint2D point) const

Check whether a point is inside a segment.

◆ distance()

double mrpt::math::TSegment2D::distance ( const TPoint2D point) const

Distance to point.

◆ generate3DObject()

void mrpt::math::TSegment2D::generate3DObject ( TSegment3D s) const

Project into 3D space, setting the z to 0.

◆ getCenter()

void mrpt::math::TSegment2D::getCenter ( TPoint2D p) const
inline

Segment's central point.

Definition at line 703 of file lightweight_geom_data.h.

References mrpt::math::TPoint2D::x, and mrpt::math::TPoint2D::y.

◆ length()

double mrpt::math::TSegment2D::length ( ) const

Segment length.

◆ operator<()

bool mrpt::math::TSegment2D::operator< ( const TSegment2D s) const

◆ operator[]() [1/2]

TPoint2D& mrpt::math::TSegment2D::operator[] ( size_t  i)
inline

Unsafe point access using [] operator, intended for loops.

Definition at line 687 of file lightweight_geom_data.h.

◆ operator[]() [2/2]

const TPoint2D& mrpt::math::TSegment2D::operator[] ( size_t  i) const
inline

Unsafe point access using [] operator, intended for loops.

Definition at line 693 of file lightweight_geom_data.h.

◆ signedDistance()

double mrpt::math::TSegment2D::signedDistance ( const TPoint2D point) const

Distance with sign to point (sign indicates which side the point is).

Member Data Documentation

◆ point1

TPoint2D mrpt::math::TSegment2D::point1

◆ point2

TPoint2D mrpt::math::TSegment2D::point2



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