geoalgo::LineSegment Class Reference

Representation of a simple 3D line segment Defines a finite 3D straight line by having the start and end position (Point_t).
. More...

#include "GeoLineSegment.h"

Public Member Functions
	LineSegment ()
	Default constructor. More...
virtual	~LineSegment ()
	Default destructor. More...
	LineSegment (double const start_x, double const start_y, double const start_z, double const end_x, double const end_y, double const end_z)
	Alternative ctor (1) More...
	LineSegment (Point_t const &start, Point_t const &end)
	Altenartive ctor (2) More...
Point_t const &	Start () const
	Start getter. More...
Point_t const &	End () const
	End getter. More...
Vector_t const	Dir () const
	Direction getter. More...
void	Start (double const x, double const y, double const z)
	Start setter. More...
void	End (double const x, double const y, double const z)
	End setter. More...
template<class T , class U >
	LineSegment (T const &start, U const &end)
	Alternative ctor using template (3) More...

Protected Member Functions
void	DirReset ()
	Internal function to reset direction. More...

Protected Attributes
Point_t	_start
	Start position of a line. More...
Point_t	_end
	End position of a line. More...
Vector_t	_dir
	Direction. More...

Detailed Description

Representation of a simple 3D line segment Defines a finite 3D straight line by having the start and end position (Point_t).
.

Definition at line 25 of file GeoLineSegment.h.

Constructor & Destructor Documentation

geoalgo::LineSegment::LineSegment

(

)

Default constructor.

Definition at line 6 of file GeoLineSegment.cxx.

References DirReset().

Referenced by ~LineSegment().

                           : _start(3), _end(3), _dir(3)
  {
    DirReset();
  }

virtual geoalgo::LineSegment::~LineSegment ( )

inlinevirtual

Default destructor.

Definition at line 32 of file GeoLineSegment.h.

References Dir(), DirReset(), End(), util::end(), LineSegment(), Start(), x, y, and z.

{}

geoalgo::LineSegment::LineSegment	(	double const	start_x,
		double const	start_y,
		double const	start_z,
		double const	end_x,
		double const	end_y,
		double const	end_z
	)

Alternative ctor (1)

Definition at line 11 of file GeoLineSegment.cxx.

References DirReset().

    : _start(start_x, start_y, start_z), _end(end_x, end_y, end_z), _dir(3)
  {
    DirReset();
  }

geoalgo::LineSegment::LineSegment	(	Point_t const &	start,
		Point_t const &	end
	)

Altenartive ctor (2)

Definition at line 22 of file GeoLineSegment.cxx.

References DirReset().

    : _start(start), _end(end), _dir(3)
  {
    if (start.size() != 3 || end.size() != 3)
      throw GeoAlgoException("LineSegment ctor accepts only 3D Point!");
    DirReset();
  }

template<class T , class U >

geoalgo::LineSegment::LineSegment ( T const &  start, U const &  end  )

inline

Alternative ctor using template (3)

Definition at line 70 of file GeoLineSegment.h.

                                              : LineSegment(Point_t(start), Point_t(end))
    {}

Member Function Documentation

Vector_t const geoalgo::LineSegment::Dir

(

)

const

Direction getter.

Definition at line 40 of file GeoLineSegment.cxx.

References _dir.

Referenced by geoalgo::GeoAlgo::_ClosestPt_(), geoalgo::GeoAlgo::_commonOrigin_(), and ~LineSegment().

  {
    return _dir;
  }

void geoalgo::LineSegment::DirReset ( )

protected

Internal function to reset direction.

Definition at line 61 of file GeoLineSegment.cxx.

References _dir, _end, and _start.

Referenced by End(), LineSegment(), Start(), and ~LineSegment().

  {
    _dir = _end - _start;
  }

Point_t const & geoalgo::LineSegment::End

(

)

const

End getter.

Definition at line 35 of file GeoLineSegment.cxx.

References _end.

Referenced by geoalgo::GeoAlgo::_ClosestPt_(), geoalgo::GeoAlgo::_SqDist_(), geoalgo::GeoObjCollection::Add(), geoalgo::GeoAlgo::Intersection(), and ~LineSegment().

  {
    return _end;
  }

void geoalgo::LineSegment::End	(	double const	x,
		double const	y,
		double const	z
	)

End setter.

Definition at line 53 of file GeoLineSegment.cxx.

References _end, DirReset(), x, y, and z.

  {
    _end[0] = x;
    _end[1] = y;
    _end[2] = z;
    DirReset();
  }

Point_t const & geoalgo::LineSegment::Start

(

)

const

Start getter.

Definition at line 30 of file GeoLineSegment.cxx.

References _start.

Referenced by geoalgo::GeoAlgo::_ClosestPt_(), geoalgo::GeoAlgo::_commonOrigin_(), geoalgo::GeoAlgo::_SqDist_(), geoalgo::GeoAlgo::ClosestPt(), geoalgo::GeoAlgo::commonOrigin(), geoalgo::GeoAlgo::Intersection(), geoalgo::GeoAlgo::SqDist(), and ~LineSegment().

  {
    return _start;
  }

void geoalgo::LineSegment::Start	(	double const	x,
		double const	y,
		double const	z
	)

Start setter.

Definition at line 45 of file GeoLineSegment.cxx.

References _start, DirReset(), x, y, and z.

  {
    _start[0] = x;
    _start[1] = y;
    _start[2] = z;
    DirReset();
  }

Member Data Documentation

Vector_t geoalgo::LineSegment::_dir

protected

Direction.

Definition at line 62 of file GeoLineSegment.h.

Referenced by Dir(), and DirReset().

Point_t geoalgo::LineSegment::_end

protected

End position of a line.

Definition at line 61 of file GeoLineSegment.h.

Referenced by DirReset(), and End().

Point_t geoalgo::LineSegment::_start

protected

Start position of a line.

Definition at line 60 of file GeoLineSegment.h.

Referenced by DirReset(), and Start().

---

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

• larcorealg/v10_00_02/source/larcorealg/GeoAlgo/GeoLineSegment.h
• larcorealg/v10_00_02/source/larcorealg/GeoAlgo/GeoLineSegment.cxx