HepGeom::Plane3D< T > Class Template Reference

#include <Plane3D.h>

Collaboration diagram for HepGeom::Plane3D< T >:

Public Member Functions
	Plane3D ()
	Plane3D (T a1, T b1, T c1, T d1)
	Plane3D (const Normal3D< T > &n, const Point3D< T > &p)
	Plane3D (const Point3D< T > &p1, const Point3D< T > &p2, const Point3D< T > &p3)
	Plane3D (const Plane3D< float > &p)
	~Plane3D ()
Plane3D< T > &	operator= (const Plane3D< T > &p)
T	a () const
T	b () const
T	c () const
T	d () const
Normal3D< T >	normal () const
Plane3D< T > &	normalize ()
T	distance (const Point3D< T > &p) const
Point3D< T >	point (const Point3D< T > &p) const
Point3D< T >	point () const
bool	operator== (const Plane3D< T > &p) const
bool	operator!= (const Plane3D< T > &p) const
Plane3D< T > &	transform (const Transform3D &m)

Protected Attributes
T	a_
T	b_
T	c_
T	d_

Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &os, const Plane3D< float > &p)
std::ostream &	operator<< (std::ostream &os, const Plane3D< double > &p)

Detailed Description

template<class T>
class HepGeom::Plane3D< T >

Template class for geometrical plane in 3D.

Author

Evgeni Chernyaev Evgue.nosp@m.ni.T.nosp@m.chern.nosp@m.iaev.nosp@m.@cern.nosp@m..ch

Definition at line 29 of file Plane3D.h.

Constructor & Destructor Documentation

Plane3D() [1/5]

template<class T>

HepGeom::Plane3D< T >::Plane3D ( )

inline

Default constructor - creates plane z=0.

Definition at line 36 of file Plane3D.h.

: a_(0.), b_(0.), c_(1.), d_(0.) {}

Plane3D() [2/5]

template<class T>

HepGeom::Plane3D< T >::Plane3D ( T  a1, T  b1, T  c1, T  d1  )

inline

Constructor from four numbers - creates plane a*x+b*y+c*z+d=0.

Definition at line 40 of file Plane3D.h.

: a_(a1), b_(b1), c_(c1), d_(d1) {}

Plane3D() [3/5]

template<class T>

HepGeom::Plane3D< T >::Plane3D ( const Normal3D< T > &  n, const Point3D< T > &  p  )

inline

Constructor from normal and point.

Definition at line 44 of file Plane3D.h.

      : a_(n.x()), b_(n.y()), c_(n.z()), d_(-n*p) {}

Plane3D() [4/5]

template<class T>

HepGeom::Plane3D< T >::Plane3D ( const Point3D< T > &  p1, const Point3D< T > &  p2, const Point3D< T > &  p3  )

inline

Constructor from three points.

Definition at line 49 of file Plane3D.h.

                               {
      Normal3D<T> n = (p2-p1).cross(p3-p1);
      a_ = n.x(); b_ = n.y(); c_ = n.z(); d_ = -n*p1;
    }

Plane3D() [5/5]

template<class T>

HepGeom::Plane3D< T >::Plane3D ( const Plane3D< float > &  p )

inline

Copy constructor. Plane3D<double> has two constructors: from Plane3D<double> (provided by compiler) and from Plane3D<float> (defined in this file). Plane3D<float> has only the last one.

Definition at line 62 of file Plane3D.h.

      : a_(p.a_), b_(p.b_), c_(p.c_), d_(p.d_) {}

~Plane3D()

template<class T>

HepGeom::Plane3D< T >::~Plane3D ( )

inline

Destructor.

Definition at line 67 of file Plane3D.h.

{};

Member Function Documentation

a()

template<class T>

T HepGeom::Plane3D< T >::a ( ) const

inline

Returns the a-coefficient in the plane equation: a*x+b*y+c*z+d=0.

Definition at line 77 of file Plane3D.h.

{ return a_; }

Here is the caller graph for this function:

b()

template<class T>

T HepGeom::Plane3D< T >::b ( ) const

inline

Returns the b-coefficient in the plane equation: a*x+b*y+c*z+d=0.

Definition at line 80 of file Plane3D.h.

{ return b_; }

Here is the caller graph for this function:

c()

template<class T>

T HepGeom::Plane3D< T >::c ( ) const

inline

Returns the c-coefficient in the plane equation: a*x+b*y+c*z+d=0.

Definition at line 83 of file Plane3D.h.

{ return c_; }

Here is the caller graph for this function:

d()

template<class T>

T HepGeom::Plane3D< T >::d ( ) const

inline

Returns the free member of the plane equation: a*x+b*y+c*z+d=0.

Definition at line 86 of file Plane3D.h.

{ return d_; }

Here is the caller graph for this function:

distance()

template<class T>

T HepGeom::Plane3D< T >::distance ( const Point3D< T > &  p ) const

inline

Returns distance to the point.

Definition at line 102 of file Plane3D.h.

                                           {
      return a()*p.x() + b()*p.y() + c()*p.z() + d();
    }

Here is the caller graph for this function:

normal()

template<class T>

Normal3D<T> HepGeom::Plane3D< T >::normal ( ) const

inline

Returns normal.

Definition at line 90 of file Plane3D.h.

{ return Normal3D<T>(a_,b_,c_); }

Here is the caller graph for this function:

normalize()

template<class T>

Plane3D<T>& HepGeom::Plane3D< T >::normalize ( )

inline

Normalization.

Definition at line 94 of file Plane3D.h.

                             {
      double ll = std::sqrt(a_*a_ + b_*b_ + c_*c_);
      if (ll > 0.) { a_ /= ll; b_ /= ll; c_ /= ll, d_ /= ll; }
      return *this;
    }

operator!=()

template<class T>

bool HepGeom::Plane3D< T >::operator!= ( const Plane3D< T > &  p ) const

inline

Test for inequality.

Definition at line 128 of file Plane3D.h.

                                                  {
      return a() != p.a() || b() != p.b() || c() != p.c() || d() != p.d();
    }

operator=()

template<class T>

Plane3D<T>& HepGeom::Plane3D< T >::operator= ( const Plane3D< T > &  p )

inline

Assignment.

Definition at line 71 of file Plane3D.h.

                                                 {
      a_ = p.a_; b_ = p.b_; c_ = p.c_; d_ = p.d_; return *this;
    }

operator==()

template<class T>

bool HepGeom::Plane3D< T >::operator== ( const Plane3D< T > &  p ) const

inline

Test for equality.

Definition at line 122 of file Plane3D.h.

                                                  {
      return a() == p.a() && b() == p.b() && c() == p.c() && d() == p.d();
    }

point() [1/2]

template<class T>

Point3D<T> HepGeom::Plane3D< T >::point ( const Point3D< T > &  p ) const

inline

Returns projection of the point to the plane.

Definition at line 108 of file Plane3D.h.

                                                 {
      T k = distance(p)/(a()*a()+b()*b()+c()*c());
      return Point3D<T>(p.x()-a()*k, p.y()-b()*k, p.z()-c()*k);
    }

Here is the caller graph for this function:

point() [2/2]

template<class T>

Point3D<T> HepGeom::Plane3D< T >::point ( ) const

inline

Returns projection of the origin to the plane.

Definition at line 115 of file Plane3D.h.

                             {
      T k = -d()/(a()*a()+b()*b()+c()*c());
      return Point3D<T>(a()*k, b()*k, c()*k);
    }

Here is the caller graph for this function:

transform()

template<class T>

Plane3D<T>& HepGeom::Plane3D< T >::transform ( const Transform3D &  m )

inline

Transformation by Transform3D.

Definition at line 134 of file Plane3D.h.

                                                  {
      Normal3D<T> n = normal();
      n.transform(m);
      d_ = -n*point().transform(m); a_ = n.x(); b_ = n.y(); c_ = n.z();
      return *this;
    }

Friends And Related Function Documentation

operator<<() [1/2]

template<class T>

std::ostream & operator<< ( std::ostream &  os, const Plane3D< float > &  p  )

related

Output to the stream.

Definition at line 22 of file Plane3D.cc.

                                                        {
    return os
      << '(' << p.a() << ',' << p.b() << ',' << p.c() << ',' << p.d() << ')';
  }

operator<<() [2/2]

template<class T>

std::ostream & operator<< ( std::ostream &  os, const Plane3D< double > &  p  )

related

Output to the stream.

Definition at line 29 of file Plane3D.cc.

                                                         {
    return os
      << '(' << p.a() << ',' << p.b() << ',' << p.c() << ',' << p.d() << ')';
  }

Member Data Documentation

a_

template<class T>

T HepGeom::Plane3D< T >::a_

protected

Definition at line 31 of file Plane3D.h.

b_

template<class T>

T HepGeom::Plane3D< T >::b_

protected

Definition at line 31 of file Plane3D.h.

c_

template<class T>

T HepGeom::Plane3D< T >::c_

protected

Definition at line 31 of file Plane3D.h.

d_

template<class T>

T HepGeom::Plane3D< T >::d_

protected

Definition at line 31 of file Plane3D.h.

---

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

• Plane3D.h