mrpt::math::TSegment3D Struct Reference

3D segment, consisting of two points. More...

#include <mrpt/math/lightweight_geom_data.h>

Collaboration diagram for mrpt::math::TSegment3D:

List of all members.

Public Member Functions
double	length () const
	Segment length.
double	distance (const TPoint3D &point) const
	Distance to point.
bool	contains (const TPoint3D &point) const
	Check whether a point is inside the segment.
TPoint3D &	operator[] (size_t i)
	Unsafe point access using [] operator, intended for loops.
const TPoint3D &	operator[] (size_t i) const
	Unsafe point access using [] operator, intended for loops.
void	generate2DObject (TSegment2D &s) const
	Projection into 2D space, discarding the z.
void	getCenter (TPoint3D &p) const
	Segment's central point.
	TSegment3D (const TPoint3D &p1, const TPoint3D &p2)
	Constructor from both points.
	TSegment3D ()
	Fast default constructor.
	TSegment3D (const TSegment2D &s)
	Constructor from 2D object.
bool	operator< (const TSegment3D &s) const
Public Attributes
TPoint3D	point1
	Origin point.
TPoint3D	point2
	Destiny point.

---

Detailed Description

3D segment, consisting of two points.

See also:

TSegment2D,TLine3D,TPlane,TPolygon3D,TPoint3D

Definition at line 588 of file lightweight_geom_data.h.

---

Constructor & Destructor Documentation

mrpt::math::TSegment3D::TSegment3D	(	const TPoint3D &	p1,
		const TPoint3D &	p2
	)			[inline]

Constructor from both points.

Definition at line 639 of file lightweight_geom_data.h.

mrpt::math::TSegment3D::TSegment3D

(

)

[inline]

Fast default constructor.

Initializes to garbage.

Definition at line 643 of file lightweight_geom_data.h.

mrpt::math::TSegment3D::TSegment3D

(

const TSegment2D &

s

)

[inline]

Constructor from 2D object.

Sets the z to zero.

Definition at line 647 of file lightweight_geom_data.h.

---

Member Function Documentation

bool mrpt::math::TSegment3D::contains

(

const TPoint3D &

point

)

const

Check whether a point is inside the segment.

double mrpt::math::TSegment3D::distance

(

const TPoint3D &

point

)

const

Distance to point.

void mrpt::math::TSegment3D::generate2DObject

(

TSegment2D &

s

)

const [inline]

Projection into 2D space, discarding the z.

Definition at line 625 of file lightweight_geom_data.h.

void mrpt::math::TSegment3D::getCenter

(

TPoint3D &

p

)

const [inline]

Segment's central point.

Definition at line 631 of file lightweight_geom_data.h.

References mrpt::math::TPoint3D::x, mrpt::math::TPoint3D::y, and mrpt::math::TPoint3D::z.

double mrpt::math::TSegment3D::length

(

)

const

Segment length.

bool mrpt::math::TSegment3D::operator<

(

const TSegment3D &

s

)

const

TPoint3D& mrpt::math::TSegment3D::operator[]

(

size_t

i

)

[inline]

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

Definition at line 613 of file lightweight_geom_data.h.

const TPoint3D& mrpt::math::TSegment3D::operator[]

(

size_t

i

)

const [inline]

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

Definition at line 619 of file lightweight_geom_data.h.

---

Member Data Documentation

TPoint3D mrpt::math::TSegment3D::point1

Origin point.

Definition at line 593 of file lightweight_geom_data.h.

Referenced by mrpt::math::TPlane::contains(), mrpt::math::operator!=(), mrpt::math::operator<<(), mrpt::math::operator==(), mrpt::math::operator>>(), and mrpt::math::project3D().

TPoint3D mrpt::math::TSegment3D::point2

Destiny point.

Definition at line 597 of file lightweight_geom_data.h.

Referenced by mrpt::math::TPlane::contains(), mrpt::math::operator!=(), mrpt::math::operator<<(), mrpt::math::operator==(), mrpt::math::operator>>(), and mrpt::math::project3D().