Data structure for direction in three dimensions. More...

#include <JDirection3D.hh>

Inheritance diagram for JGEOMETRY3D::JDirection3D:

Public Member Functions
	JDirection3D ()
	Default constructor. More...

	JDirection3D (const JVersor3D &dir)
	Constructor. More...

	JDirection3D (const JAngle3D &angle)
	Constructor. More...

	JDirection3D (const JVector3D &pos)
	Constructor. More...

	JDirection3D (const JVersor3Z &dir)
	Constructor. More...

	JDirection3D (const double dx, const double dy, const double dz)
	Constructor. More...

const JDirection3D &	getDirection () const
	Get direction. More...

JDirection3D &	getDirection ()
	Get direction. More...

void	setDirection (const JDirection3D &dir)
	Set direction. More...

	operator JAngle3D () const
	Type conversion operator. More...

	operator JVector3D () const
	Type conversion operator. More...

JDirection3D &	transform (const JMatrix3D &T)
	Transform. More...

JDirection3D &	rotate (const JRotation3D &R)
	Rotate. More...

JDirection3D &	rotate_back (const JRotation3D &R)
	Rotate back. More...

JDirection3D &	rotate (const JRotation3X &R)
	Rotate around X-axis. More...

JDirection3D &	rotate_back (const JRotation3X &R)
	Rotate back around X-axis. More...

JDirection3D &	rotate (const JRotation3Y &R)
	Rotate around Y-axis. More...

JDirection3D &	rotate_back (const JRotation3Y &R)
	Rotate back around Y-axis. More...

JDirection3D &	rotate (const JRotation3Z &R)
	Rotate around Z-axis. More...

JDirection3D &	rotate_back (const JRotation3Z &R)
	Rotate back around Z-axis. More...

JDirection3D &	rotate (const JQuaternion3D &Q)
	Rotate. More...

JDirection3D &	rotate_back (const JQuaternion3D &Q)
	Rotate back. More...

double	getDot (const JAngle3D &angle) const
	Get dot product. More...

double	getDot (const JVector3D &pos) const
	Get dot product. More...

double	getDot (const JVersor3Z &dir) const
	Get dot product. More...

double	getDot (const JVersor3D &versor) const
	Get dot product. More...

JVersor3D &	negate ()
	Negate versor. More...

bool	equals (const JVersor3D &versor, const double precision=std::numeric_limits< double >::min()) const
	Check equality. More...

double	getDX () const
	Get x direction. More...

double	getDY () const
	Get y direction. More...

double	getDZ () const
	Get z direction. More...

double	getTheta () const
	Get theta angle. More...

double	getPhi () const
	Get phi angle. More...

double	getDot (const JVersor3D &versor) const
	Get dot product. More...

JVersor3D &	getCross (const JVersor3D &first, const JVersor3D &second)
	Get cross product. More...

JVersor3D &	normalise ()
	Normalise versor. More...

JFirst_t &	mul (const JSecond_t &object)
	Multiply with object. More...

Protected Attributes
double	__dx

double	__dy

double	__dz

Friends
std::istream &	operator>> (std::istream &in, JDirection3D &direction)
	Read direction from input. More...

std::ostream &	operator<< (std::ostream &out, const JDirection3D &direction)
	Write direction to output. More...

JReader &	operator>> (JReader &in, JDirection3D &direction)
	Read direction from input. More...

JWriter &	operator<< (JWriter &out, const JDirection3D &direction)
	Write direction to output. More...

Detailed Description

Data structure for direction in three dimensions.

Definition at line 33 of file JDirection3D.hh.

Constructor & Destructor Documentation

◆ JDirection3D() [1/6]

JGEOMETRY3D::JDirection3D::JDirection3D ( )

inline

Default constructor.

Definition at line 43 of file JDirection3D.hh.

                    :
       JVersor3D()
     {}

◆ JDirection3D() [2/6]

JGEOMETRY3D::JDirection3D::JDirection3D ( const JVersor3D & dir )

inline

Constructor.

Parameters

dir direction

Definition at line 53 of file JDirection3D.hh.

                                        :
       JVersor3D(dir)
     {}

◆ JDirection3D() [3/6]

JGEOMETRY3D::JDirection3D::JDirection3D ( const JAngle3D & angle )

inline

Constructor.

Parameters

angle angle

Definition at line 63 of file JDirection3D.hh.

                                         :
       JVersor3D(angle.getDX(), angle.getDY(), angle.getDZ())
     {}

◆ JDirection3D() [4/6]

JGEOMETRY3D::JDirection3D::JDirection3D ( const JVector3D & pos )

inline

Constructor.

Parameters

pos position

Definition at line 73 of file JDirection3D.hh.

                                        :
       JVersor3D(pos.getX(), pos.getY(), pos.getZ())
     {}

◆ JDirection3D() [5/6]

JGEOMETRY3D::JDirection3D::JDirection3D ( const JVersor3Z & dir )

inline

Constructor.

Parameters

dir direction

Definition at line 83 of file JDirection3D.hh.

                                        :
       JVersor3D(dir.getDX(), dir.getDY(), dir.getDZ())
     {}

◆ JDirection3D() [6/6]

JGEOMETRY3D::JDirection3D::JDirection3D	(	const double	dx,
		const double	dy,
		const double	dz
	)

inline

Constructor.

Parameters

dx	dx value
dy	dy value
dz	dz value

Definition at line 95 of file JDirection3D.hh.

                                   :
       JVersor3D(dx, dy, dz)
     {}

Member Function Documentation

◆ getDirection() [1/2]

const JDirection3D& JGEOMETRY3D::JDirection3D::getDirection ( ) const

inline

Get direction.

Returns: direction

Definition at line 107 of file JDirection3D.hh.

     {
       return static_cast<const JDirection3D&>(*this);
     }

◆ getDirection() [2/2]

JDirection3D& JGEOMETRY3D::JDirection3D::getDirection ( )

inline

Get direction.

Returns: direction

Definition at line 118 of file JDirection3D.hh.

     {
       return static_cast<JDirection3D&>(*this);
     }

◆ setDirection()

void JGEOMETRY3D::JDirection3D::setDirection ( const JDirection3D & dir )

inline

Set direction.

Parameters

dir direction

Definition at line 129 of file JDirection3D.hh.

     {
       static_cast<JDirection3D&>(*this) = dir;
     }

◆ operator JAngle3D()

JGEOMETRY3D::JDirection3D::operator JAngle3D ( ) const

inline

Type conversion operator.

Returns: angle

Definition at line 140 of file JDirection3D.hh.

     {
       return JAngle3D(getDX(), getDY(), getDZ());
     }

◆ operator JVector3D()

JGEOMETRY3D::JDirection3D::operator JVector3D ( ) const

inline

Type conversion operator.

Returns: position

Definition at line 151 of file JDirection3D.hh.

     {
       return JVector3D(getDX(), getDY(), getDZ());
     }

◆ transform()

JDirection3D& JGEOMETRY3D::JDirection3D::transform ( const JMatrix3D & T )

inline

Transform.

Parameters

T matrix

Returns: this direction

Definition at line 163 of file JDirection3D.hh.

     {
       T.transform(__dx, __dy, __dz);
  
       normalise();
  
       return *this;
     }

◆ rotate() [1/5]

JDirection3D& JGEOMETRY3D::JDirection3D::rotate ( const JRotation3D & R )

inline

Rotate.

Parameters

R	rotation matrix

Returns: this direction

Definition at line 179 of file JDirection3D.hh.

     {
       R.rotate(__dx, __dy, __dz);
  
       normalise();
  
       return *this;
     }

◆ rotate_back() [1/5]

JDirection3D& JGEOMETRY3D::JDirection3D::rotate_back ( const JRotation3D & R )

inline

Rotate back.

Parameters

R	rotation matrix

Returns: this direction

Definition at line 195 of file JDirection3D.hh.

     {
       R.rotate_back(__dx, __dy, __dz);
  
       normalise();
  
       return *this;
     }

◆ rotate() [2/5]

JDirection3D& JGEOMETRY3D::JDirection3D::rotate ( const JRotation3X & R )

inline

Rotate around X-axis.

Parameters

R	rotation matrix

Returns: this direction

Definition at line 211 of file JDirection3D.hh.

     {
       R.rotate(__dy, __dz);
  
       normalise();
  
       return *this;
     }

◆ rotate_back() [2/5]

JDirection3D& JGEOMETRY3D::JDirection3D::rotate_back ( const JRotation3X & R )

inline

Rotate back around X-axis.

Parameters

R	rotation matrix

Returns: this direction

Definition at line 227 of file JDirection3D.hh.

     {
       R.rotate_back(__dy, __dz);
  
       normalise();
  
       return *this;
     }

◆ rotate() [3/5]

JDirection3D& JGEOMETRY3D::JDirection3D::rotate ( const JRotation3Y & R )

inline

Rotate around Y-axis.

Parameters

R	rotation matrix

Returns: this direction

Definition at line 243 of file JDirection3D.hh.

     {
       R.rotate(__dx, __dz);
  
       normalise();
  
       return *this;
     }

◆ rotate_back() [3/5]

JDirection3D& JGEOMETRY3D::JDirection3D::rotate_back ( const JRotation3Y & R )

inline

Rotate back around Y-axis.

Parameters

R	rotation matrix

Returns: this direction

Definition at line 259 of file JDirection3D.hh.

     {
       R.rotate_back(__dx, __dz);
  
       normalise();
  
       return *this;
     }

◆ rotate() [4/5]

JDirection3D& JGEOMETRY3D::JDirection3D::rotate ( const JRotation3Z & R )

inline

Rotate around Z-axis.

Parameters

R	rotation matrix

Returns: this direction

Definition at line 275 of file JDirection3D.hh.

     {
       R.rotate(__dx, __dy);
  
       normalise();
  
       return *this;
     }

◆ rotate_back() [4/5]

JDirection3D& JGEOMETRY3D::JDirection3D::rotate_back ( const JRotation3Z & R )

inline

Rotate back around Z-axis.

Parameters

R	rotation matrix

Returns: this direction

Definition at line 291 of file JDirection3D.hh.

     {
       R.rotate_back(__dx, __dy);
  
       normalise();
  
       return *this;
     }

◆ rotate() [5/5]

JDirection3D& JGEOMETRY3D::JDirection3D::rotate ( const JQuaternion3D & Q )

inline

Rotate.

Parameters

Q	quaternion

Returns: this position

Definition at line 307 of file JDirection3D.hh.

     {
       Q.rotate(__dx, __dy, __dz);
  
       return *this;
     }

◆ rotate_back() [5/5]

JDirection3D& JGEOMETRY3D::JDirection3D::rotate_back ( const JQuaternion3D & Q )

inline

Rotate back.

Parameters

Q	quaternion

Returns: this position

Definition at line 321 of file JDirection3D.hh.

     {
       Q.rotate_back(__dx, __dy, __dz);
  
       return *this;
     }

◆ getDot() [1/5]

double JGEOMETRY3D::JDirection3D::getDot ( const JAngle3D & angle ) const

inline

Get dot product.

Parameters

angle angle

Returns: dot product

Definition at line 335 of file JDirection3D.hh.

     {
       return
         getDX() * angle.getDX() +
         getDY() * angle.getDY() +
         getDZ() * angle.getDZ();
     }

◆ getDot() [2/5]

double JGEOMETRY3D::JDirection3D::getDot ( const JVector3D & pos ) const

inline

Get dot product.

Parameters

pos position

Returns: dot product

Definition at line 350 of file JDirection3D.hh.

     {
       return
         getDX() * pos.getX() +
         getDY() * pos.getY() +
         getDZ() * pos.getZ();
     }

◆ getDot() [3/5]

double JGEOMETRY3D::JDirection3D::getDot ( const JVersor3Z & dir ) const

inline

Get dot product.

Parameters

dir direction

Returns: dot product

Definition at line 365 of file JDirection3D.hh.

     {
       return
         getDX() * dir.getDX() +
         getDY() * dir.getDY() +
         getDZ() * dir.getDZ();
     }

◆ getDot() [4/5]

double JGEOMETRY3D::JVersor3D::getDot

inline

Get dot product.

Parameters

versor versor

Returns: dot product

Definition at line 156 of file JVersor3D.hh.

     {
       return
         getDX() * versor.getDX() + 
         getDY() * versor.getDY() +
         getDZ() * versor.getDZ();
     }

◆ negate()

JVersor3D& JGEOMETRY3D::JVersor3D::negate ( )

inlineinherited

Negate versor.

Returns: this versor

Definition at line 64 of file JVersor3D.hh.

     {
       __dx = -__dx;
       __dy = -__dy;
       __dz = -__dz;
  
       return *this;
     }

◆ equals()

bool JGEOMETRY3D::JVersor3D::equals	(	const JVersor3D &	versor,
		const double	precision = `std::numeric_limits<double>::min()`
	)		const

inlineinherited

Check equality.

Parameters

versor	versor
precision	precision

Returns: true if versors are equal; else false

Definition at line 81 of file JVersor3D.hh.

     {
       return (fabs(getDX() - versor.getDX()) <= precision &&
               fabs(getDY() - versor.getDY()) <= precision &&
               fabs(getDZ() - versor.getDZ()) <= precision);
     }

◆ getDX()

double JGEOMETRY3D::JVersor3D::getDX ( ) const

inlineinherited

Get x direction.

Returns: x direction

Definition at line 95 of file JVersor3D.hh.

     {
       return __dx;
     }

◆ getDY()

double JGEOMETRY3D::JVersor3D::getDY ( ) const

inlineinherited

Get y direction.

Returns: y direction

Definition at line 106 of file JVersor3D.hh.

     {
       return __dy;
     }

◆ getDZ()

double JGEOMETRY3D::JVersor3D::getDZ ( ) const

inlineinherited

Get z direction.

Returns: z direction

Definition at line 117 of file JVersor3D.hh.

     {
       return __dz;
     }

◆ getTheta()

double JGEOMETRY3D::JVersor3D::getTheta ( ) const

inlineinherited

Get theta angle.

Returns: theta angle [rad]

Definition at line 128 of file JVersor3D.hh.

     {
       if      (__dz > +1.0)
         return 0.0;
       else if (__dz < -1.0)
         return JMATH::PI;
       else
         return acos(__dz);
     }

◆ getPhi()

double JGEOMETRY3D::JVersor3D::getPhi ( ) const

inlineinherited

Get phi angle.

Returns: phi angle [rad]

Definition at line 144 of file JVersor3D.hh.

     { 
       return atan2(__dy, __dx);
     }

◆ getDot() [5/5]

double JGEOMETRY3D::JVersor3D::getDot ( const JVersor3D & versor ) const

inlineinherited

Get dot product.

Parameters

versor versor

Returns: dot product

Definition at line 156 of file JVersor3D.hh.

     {
       return
         getDX() * versor.getDX() + 
         getDY() * versor.getDY() +
         getDZ() * versor.getDZ();
     }

◆ getCross()

JVersor3D& JGEOMETRY3D::JVersor3D::getCross	(	const JVersor3D &	first,
		const JVersor3D &	second
	)

inlineinherited

Get cross product.

Note that this versor should not overlap with the first or second versor,

Parameters

first	first versor
second	second versor

Returns: this versor

Definition at line 173 of file JVersor3D.hh.

     {
       __dx = first .getDY() * second.getDZ()  -  second.getDY() * first .getDZ();
       __dy = second.getDX() * first .getDZ()  -  first .getDX() * second.getDZ();
       __dz = first .getDX() * second.getDY()  -  second.getDX() * first .getDY();
  
       normalise();
  
       return *this;
     }

◆ normalise()

JVersor3D& JGEOMETRY3D::JVersor3D::normalise ( )

inlineinherited

Normalise versor.

This operation may set the result to the unit z-vector.

Returns: this versor

Definition at line 192 of file JVersor3D.hh.

     {
       const double v = sqrt(getDX()*getDX() + getDY()*getDY() + getDZ()*getDZ());
  
       if (v != 0.0) {
         __dx /= v;
         __dy /= v;
         __dz /= v;
       }
  
       return *this;
     }

◆ mul()

template<class JFirst_t , class JSecond_t >

JFirst_t& JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t & object )

inlineinherited

Multiply with object.

Parameters

object object

Returns: result object

Definition at line 354 of file JMath.hh.

     {
       return static_cast<JFirst_t&>(*this) = JFirst_t().mul(static_cast<const JFirst_t&>(*this), object);
     }

Friends And Related Function Documentation

◆ operator>> [1/2]

std::istream& operator>>	(	std::istream &	in,
		JDirection3D &	direction
	)

friend

Read direction from input.

Parameters

in	input stream
direction	direction

Returns: input stream

Definition at line 381 of file JDirection3D.hh.

     {
       in >> direction.__dx >> direction.__dy >> direction.__dz;
  
       direction.normalise();
  
       return in;
     }

◆ operator<< [1/2]

std::ostream& operator<<	(	std::ostream &	out,
		const JDirection3D &	direction
	)

friend

Write direction to output.

Parameters

out	output stream
direction	direction

Returns: output stream

Definition at line 398 of file JDirection3D.hh.

     {
       const JFormat format(out, getFormat<JDirection3D>(JFormat_t(9, 6, std::ios::fixed | std::ios::showpos)));
       
       out << format << direction.getDX() << ' '
           << format << direction.getDY() << ' '
           << format << direction.getDZ();
  
       return out;
     }

◆ operator>> [2/2]

JReader& operator>>	(	JReader &	in,
		JDirection3D &	direction
	)

friend

Read direction from input.

Parameters

in	reader
direction	direction

Returns: reader

Definition at line 417 of file JDirection3D.hh.

     {
       return in >> direction.__dx >> direction.__dy >> direction.__dz;
     }

◆ operator<< [2/2]

JWriter& operator<<	(	JWriter &	out,
		const JDirection3D &	direction
	)

friend

Write direction to output.

Parameters

out	writer
direction	direction

Returns: writer

Definition at line 430 of file JDirection3D.hh.

     {
       return out << direction.__dx << direction.__dy << direction.__dz;
     }

Member Data Documentation

◆ __dx

double JGEOMETRY3D::JVersor3D::__dx

protectedinherited

Definition at line 206 of file JVersor3D.hh.

◆ __dy

double JGEOMETRY3D::JVersor3D::__dy

protectedinherited

Definition at line 207 of file JVersor3D.hh.

◆ __dz

double JGEOMETRY3D::JVersor3D::__dz

protectedinherited

Definition at line 208 of file JVersor3D.hh.

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

JDirection3D.hh

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ JDirection3D() [1/6]

◆ JDirection3D() [2/6]

◆ JDirection3D() [3/6]

◆ JDirection3D() [4/6]

◆ JDirection3D() [5/6]

◆ JDirection3D() [6/6]

Member Function Documentation

◆ getDirection() [1/2]

◆ getDirection() [2/2]

◆ setDirection()

◆ operator JAngle3D()

◆ operator JVector3D()

◆ transform()

◆ rotate() [1/5]

◆ rotate_back() [1/5]

◆ rotate() [2/5]

◆ rotate_back() [2/5]

◆ rotate() [3/5]

◆ rotate_back() [3/5]

◆ rotate() [4/5]

◆ rotate_back() [4/5]

◆ rotate() [5/5]

◆ rotate_back() [5/5]

◆ getDot() [1/5]

◆ getDot() [2/5]

◆ getDot() [3/5]

◆ getDot() [4/5]

◆ negate()

◆ equals()

◆ getDX()

◆ getDY()

◆ getDZ()

◆ getTheta()

◆ getPhi()

◆ getDot() [5/5]

◆ getCross()

◆ normalise()

◆ mul()

Friends And Related Function Documentation

◆ operator>> [1/2]

◆ operator<< [1/2]

◆ operator>> [2/2]

◆ operator<< [2/2]

Member Data Documentation

◆ __dx

◆ __dy

◆ __dz