jafar::geom::Segment< dimension > Class Template Reference

This class defines a segment (which is a bounded space of dimension 1). More...

---

Detailed Description

template<int dimension>
class jafar::geom::Segment< dimension >

This class defines a segment (which is a bounded space of dimension 1).

Exemple of a segment define by the euclidean coordinates of the two extremeties:

 jblas::vec3 ext1;
 jblas::vec3 ext2;
 Segment<3> seg( new Segment<3>::TwoPointsDriver( ext1, ext2 ) );

Definition at line 24 of file Segment.hpp.

#include <Segment.hpp>

Inheritance diagram for jafar::geom::Segment< dimension >:

List of all members.

Classes
class	Driver
	Base class for the drivers of Segment. More...
class	LineDriver
class	TwoPointsDriver
class	TwoPointsPointerDriver
Public Types
typedef Atom< dimension > ::HomogenousVecD	HomogenousVecD
typedef Atom< dimension > ::HomogenousSymMatrixD	HomogenousSymMatrixD
typedef Atom< dimension >::VecD	VecD
typedef Atom< dimension > ::HomogenousMatrixD	HomogenousMatrixD
typedef Repere< dimension >	RepereD
Public Member Functions
	Segment ()
	Creates a Segment with a null Segment::Driver.
template<class _TDriver_ >
	Segment (_TDriver_ *)
	Creates a Segment with the Segment::Driver given in parameter.
	Segment (const Segment &)
Segment &	operator= (const Segment &rhs)
virtual BoundingBox< dimension >	boundingBox () const
virtual Atom< dimension >::Type	type () const
Line< dimension >	support () const
HomogenousVecD	firstPoint () const
HomogenousSymMatrixD	firstPointCov () const
HomogenousVecD	lastPoint () const
HomogenousSymMatrixD	lastPointCov () const
double	length () const
virtual std::string	toString () const
Private Attributes
Driver *	m_driver

---

Constructor & Destructor Documentation

template<int dimension>

template<class _TDriver_ >

jafar::geom::Segment< dimension >::Segment

(

_TDriver_ *

driver

)

[explicit]

Creates a Segment with the Segment::Driver given in parameter.

This class takes ownership of the Segment::Driver and will deletes it.

Definition at line 288 of file SegmentImpl.hpp.

---

Member Function Documentation

template<int dimension>

BoundingBox< dimension > jafar::geom::Segment< dimension >::boundingBox

(

)

const [virtual]

Returns:

the bounding box that completely include this Atom.

Reimplemented from jafar::geom::Line< dimension >.

Definition at line 316 of file SegmentImpl.hpp.

template<int dimension>

Segment< dimension >::HomogenousVecD jafar::geom::Segment< dimension >::firstPoint

(

)

const [inline]

Returns:

the so-called "first point" (it is expected that this point correspond to the point returned by pointAt(0.0); )

Definition at line 326 of file SegmentImpl.hpp.

template<int dimension>

Segment< dimension >::HomogenousVecD jafar::geom::Segment< dimension >::lastPoint

(

)

const [inline]

Returns:

the so-called "last point" (it is expected that this point correspond to the point returned by pointAt(1.0); )

Definition at line 336 of file SegmentImpl.hpp.

template<int dimension>

double jafar::geom::Segment< dimension >::length

(

)

const [inline]

Returns:

the distance between the first and last point

Definition at line 346 of file SegmentImpl.hpp.

template<int dimension>

Line< dimension > jafar::geom::Segment< dimension >::support

(

)

const [inline]

Returns:

the Line that support this Segment (this is the Line that contains this Segment)

Definition at line 321 of file SegmentImpl.hpp.

template<int dimension>

std::string jafar::geom::Segment< dimension >::toString

(

)

const [virtual]

Returns:

a string describing this value (usefull for debugging purposes)

Reimplemented from jafar::geom::Atom< dimension >.

Definition at line 351 of file SegmentImpl.hpp.

template<int dimension>

virtual Atom<dimension>::Type jafar::geom::Segment< dimension >::type

(

)

const [inline, virtual]

Returns:

the type of the object.

Reimplemented from jafar::geom::Line< dimension >.

Definition at line 155 of file Segment.hpp.

---

The documentation for this class was generated from the following files:

• modules/geom/include/geom/Segment.hpp
• modules/geom/include/geom/SegmentImpl.hpp