geoalgo::HalfLine Class Reference

Representation of a 3D semi-infinite line. Defines a semi-infinite 3D line by having a start point (Point_t) and direction (Vector_t)
along which the line extends. It hides the start and direction attributes from users for
protecting the dimensionality. More...

#include "GeoHalfLine.h"

Inheritance diagram for geoalgo::HalfLine:

Public Member Functions
	HalfLine ()
	Default constructor. More...
virtual	~HalfLine ()
	Default destructor. More...
	HalfLine (double const x, double const y, double const z, double const dirx, double const diry, double const dirz)
	Alternative ctor (1) More...
	HalfLine (Point_t const &start, Vector_t const &dir)
	Altenartive ctor (2) More...
Point_t const &	Start () const
	Start 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	Dir (double const x, double const y, double const z)
	Dir setter. More...
void	Start (TVector3 const &pt)
	Start setter. More...
void	Dir (TVector3 const &dir)
	Dir setter. More...
template<class T , class U >
	HalfLine (T const &start, U const &dir)
	Alternative ctor using template (3) More...
template<class T >
void	Start (T const &pos)
	Start setter template. More...
template<class T >
void	Dir (T const &dir)
	Dir setter template. More...

Protected Member Functions
void	Normalize ()
	Normalize direction. More...

Protected Attributes
Point_t	_start
	Beginning of the half line. More...
Vector_t	_dir
	Direction of the half line from _start. More...

Detailed Description

Representation of a 3D semi-infinite line. Defines a semi-infinite 3D line by having a start point (Point_t) and direction (Vector_t)
along which the line extends. It hides the start and direction attributes from users for
protecting the dimensionality.

Definition at line 30 of file GeoHalfLine.h.

Constructor & Destructor Documentation

geoalgo::HalfLine::HalfLine

(

)

Default constructor.

Definition at line 5 of file GeoHalfLine.cxx.

References Normalize().

Referenced by ~HalfLine().

                     : _start(3), _dir(3)
  {
    Normalize();
  }

virtual geoalgo::HalfLine::~HalfLine ( )

inlinevirtual

Default destructor.

Definition at line 37 of file GeoHalfLine.h.

References dir, Dir(), HalfLine(), Normalize(), pt, Start(), x, y, and z.

{};

geoalgo::HalfLine::HalfLine	(	double const	x,
		double const	y,
		double const	z,
		double const	dirx,
		double const	diry,
		double const	dirz
	)

Alternative ctor (1)

Definition at line 10 of file GeoHalfLine.cxx.

References Normalize().

    : _start(x, y, z), _dir(dirx, diry, dirz)
  {
    Normalize();
  }

geoalgo::HalfLine::HalfLine	(	Point_t const &	start,
		Vector_t const &	dir
	)

Altenartive ctor (2)

Definition at line 21 of file GeoHalfLine.cxx.

References Normalize().

                                                              : _start(start), _dir(dir)
  {
    if (start.size() != 3 || dir.size() != 3)
      throw GeoAlgoException("HalfLine ctor accepts only 3D Point!");
    Normalize();
  }

template<class T , class U >

geoalgo::HalfLine::HalfLine ( T const &  start, U const &  dir  )

inline

Alternative ctor using template (3)

Definition at line 71 of file GeoHalfLine.h.

                                           : HalfLine(Point_t(start), Vector_t(dir))
    {}

Member Function Documentation

Vector_t const & geoalgo::HalfLine::Dir

(

)

const

Direction getter.

Definition at line 33 of file GeoHalfLine.cxx.

References _dir.

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

  {
    return _dir;
  }

void geoalgo::HalfLine::Dir	(	double const	x,
		double const	y,
		double const	z
	)

Dir setter.

Definition at line 45 of file GeoHalfLine.cxx.

References _dir, Normalize(), x, y, and z.

  {
    _dir[0] = x;
    _dir[1] = y;
    _dir[2] = z;
    Normalize();
  }

void geoalgo::HalfLine::Dir

(

TVector3 const &

dir

)

Dir setter.

Definition at line 60 of file GeoHalfLine.cxx.

References _dir, and Normalize().

  {
    _dir[0] = dir[0];
    _dir[1] = dir[1];
    _dir[2] = dir[2];
    Normalize();
  }

template<class T >

void geoalgo::HalfLine::Dir ( T const &  dir )

inline

Dir setter template.

Definition at line 85 of file GeoHalfLine.h.

References Normalize().

    {
      _dir = Vector_t(dir);
      if (_dir.size() != 3)
        throw GeoAlgoException("<<Start>> Only 3 dimensional start point allowed!");
      Normalize();
    }

void geoalgo::HalfLine::Normalize ( )

protected

Normalize direction.

Definition at line 68 of file GeoHalfLine.cxx.

References _dir, and geoalgo::Vector::Length().

Referenced by Dir(), HalfLine(), and ~HalfLine().

  {
    auto l = _dir.Length();
    if (!l) throw GeoAlgoException("<<Normalize>> cannot normalize 0-length direction vector!");

    // inf check commented out till compatible solution found... --kazu
    //if(isnan(l))
    //throw GeoAlgoException("<<Normalize>> cannot normalize inf-length direction vector!");
    _dir /= l;
  }

Point_t const & geoalgo::HalfLine::Start

(

)

const

Start getter.

Definition at line 28 of file GeoHalfLine.cxx.

References _start.

Referenced by geoalgo::GeoAlgo::_ClosestPt_(), geoalgo::GeoAlgo::_commonOrigin_(), geoalgo::GeoAlgo::_SqDist_(), geoalgo::GeoObjCollection::Add(), geoalgo::GeoAlgo::BoxOverlap(), geoalgo::GeoAlgo::ClosestPt(), geoalgo::GeoAlgo::commonOrigin(), geoalgo::GeoAlgo::Intersection(), geoalgo::GeoAlgo::SqDist(), and ~HalfLine().

  {
    return _start;
  }

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

Start setter.

Definition at line 38 of file GeoHalfLine.cxx.

References _start, x, y, and z.

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

void geoalgo::HalfLine::Start

(

TVector3 const &

pt

)

Start setter.

Definition at line 53 of file GeoHalfLine.cxx.

References _start.

  {
    _start[0] = pt[0];
    _start[1] = pt[1];
    _start[2] = pt[2];
  }

template<class T >

void geoalgo::HalfLine::Start ( T const &  pos )

inline

Start setter template.

Definition at line 76 of file GeoHalfLine.h.

    {
      _start = Point_t(pos);
      if (_start.size() != 3)
        throw GeoAlgoException("<<Start>> Only 3 dimensional start point allowed!");
    }

Member Data Documentation

Vector_t geoalgo::HalfLine::_dir

protected

Direction of the half line from _start.

Definition at line 62 of file GeoHalfLine.h.

Referenced by Dir(), and Normalize().

Point_t geoalgo::HalfLine::_start

protected

Beginning of the half line.

Definition at line 61 of file GeoHalfLine.h.

Referenced by Start().

---

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

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