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...

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...

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

bool	equals (const JVersor3D &versor) 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 &	normalise ()
	Normalise versor. More...

JVersor3D &	mul (const JNullType &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 32 of file JDirection3D.hh.

Constructor & Destructor Documentation

JGEOMETRY3D::JDirection3D::JDirection3D ( )

inline

Default constructor.

Definition at line 42 of file JDirection3D.hh.

                    :
       JVersor3D()
     {}

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

inline

Constructor.

Parameters

dir direction

Definition at line 52 of file JDirection3D.hh.

                                        :
       JVersor3D(dir)
     {}

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

inline

Constructor.

Parameters

angle angle

Definition at line 62 of file JDirection3D.hh.

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

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

inline

Constructor.

Parameters

pos position

Definition at line 72 of file JDirection3D.hh.

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

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

inline

Constructor.

Parameters

dir direction

Definition at line 82 of file JDirection3D.hh.

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

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 94 of file JDirection3D.hh.

                                   :
       JVersor3D(dx, dy, dz)
     {}

Member Function Documentation

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

inline

Get direction.

Returns: direction

Definition at line 106 of file JDirection3D.hh.

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

JDirection3D& JGEOMETRY3D::JDirection3D::getDirection ( )

inline

Get direction.

Returns: direction

Definition at line 117 of file JDirection3D.hh.

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

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

inline

Set direction.

Parameters

dir direction

Definition at line 128 of file JDirection3D.hh.

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

JGEOMETRY3D::JDirection3D::operator JAngle3D ( ) const

inline

Type conversion operator.

Returns: angle

Definition at line 138 of file JDirection3D.hh.

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

JGEOMETRY3D::JDirection3D::operator JVector3D ( ) const

inline

Type conversion operator.

Returns: position

Definition at line 149 of file JDirection3D.hh.

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

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

inline

Transform.

Parameters

T matrix

Returns: this direction

Definition at line 161 of file JDirection3D.hh.

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

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

inline

Rotate.

Parameters

R	rotation matrix

Returns: this direction

Definition at line 177 of file JDirection3D.hh.

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

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

inline

Rotate back.

Parameters

R	rotation matrix

Returns: this direction

Definition at line 193 of file JDirection3D.hh.

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

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

inline

Rotate around X-axis.

Parameters

R	rotation matrix

Returns: this direction

Definition at line 209 of file JDirection3D.hh.

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

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

inline

Rotate back around X-axis.

Parameters

R	rotation matrix

Returns: this direction

Definition at line 225 of file JDirection3D.hh.

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

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

inline

Rotate around Y-axis.

Parameters

R	rotation matrix

Returns: this direction

Definition at line 241 of file JDirection3D.hh.

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

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

inline

Rotate back around Y-axis.

Parameters

R	rotation matrix

Returns: this direction

Definition at line 257 of file JDirection3D.hh.

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

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

inline

Rotate around Z-axis.

Parameters

R	rotation matrix

Returns: this direction

Definition at line 273 of file JDirection3D.hh.

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

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

inline

Rotate back around Z-axis.

Parameters

R	rotation matrix

Returns: this direction

Definition at line 289 of file JDirection3D.hh.

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

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

inline

Rotate.

Parameters

Q	quaternion

Returns: this position

Definition at line 305 of file JDirection3D.hh.

     {
       JQuaternion3D b(Q);
       JQuaternion3D a;
 
       a.mul(*this, b.conjugate());
 
       static_cast<JVersor3D&>(*this) = b.mul(Q,a);
       
       return *this;
     }

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

inline

Get dot product.

Parameters

angle angle

Returns: dot product

Definition at line 324 of file JDirection3D.hh.

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

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

inline

Get dot product.

Parameters

pos position

Returns: dot product

Definition at line 339 of file JDirection3D.hh.

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

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

inline

Get dot product.

Parameters

dir direction

Returns: dot product

Definition at line 354 of file JDirection3D.hh.

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

JVersor3D& JGEOMETRY3D::JVersor3D::negate ( )

inlineinherited

Negate versor.

Returns: this versor

Definition at line 61 of file JVersor3D.hh.

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

bool JGEOMETRY3D::JVersor3D::equals ( const JVersor3D & versor ) const

inlineinherited

Check equality.

Parameters

versor versor

Returns: true if versors are equal; else false

Definition at line 77 of file JVersor3D.hh.

     {
       return (getDX() == versor.getDX() && 
               getDY() == versor.getDY() &&
               getDZ() == versor.getDZ());
     }

double JGEOMETRY3D::JVersor3D::getDX ( ) const

inlineinherited

Get x direction.

Returns: x direction

Definition at line 90 of file JVersor3D.hh.

     {
       return __dx;
     }

double JGEOMETRY3D::JVersor3D::getDY ( ) const

inlineinherited

Get y direction.

Returns: y direction

Definition at line 101 of file JVersor3D.hh.

     {
       return __dy;
     }

double JGEOMETRY3D::JVersor3D::getDZ ( ) const

inlineinherited

Get z direction.

Returns: z direction

Definition at line 112 of file JVersor3D.hh.

     {
       return __dz;
     }

double JGEOMETRY3D::JVersor3D::getTheta ( ) const

inlineinherited

Get theta angle.

Returns: theta angle [rad]

Definition at line 123 of file JVersor3D.hh.

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

double JGEOMETRY3D::JVersor3D::getPhi ( ) const

inlineinherited

Get phi angle.

Returns: phi angle [rad]

Definition at line 139 of file JVersor3D.hh.

     { 
       return atan2(__dy, __dx);
     }

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

inlineinherited

Get dot product.

Parameters

versor versor

Returns: dot product

Definition at line 151 of file JVersor3D.hh.

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

JVersor3D& JGEOMETRY3D::JVersor3D::normalise ( )

inlineinherited

Normalise versor.

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

Returns: this versor

Definition at line 166 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;
     }

JVersor3D & JMATH::JMath< JVersor3D , JNullType >::mul ( const JNullType & object )

inlineinherited

Multiply with object.

Parameters

object object

Returns: result object

Definition at line 273 of file JMath.hh.

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

Friends And Related Function Documentation

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 370 of file JDirection3D.hh.

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

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 385 of file JDirection3D.hh.

     {
       out << direction.getDX() << ' ' << direction.getDY() << ' ' << direction.getDZ();
 
       return out;
     }

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

friend

Read direction from input.

Parameters

in	reader
direction	direction

Returns: reader

Definition at line 400 of file JDirection3D.hh.

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

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

friend

Write direction to output.

Parameters

out	writer
direction	direction

Returns: writer

Definition at line 413 of file JDirection3D.hh.

     {
       return out << direction.getDX() << direction.getDY() << direction.getDZ();
     }

Member Data Documentation

double JGEOMETRY3D::JVersor3D::__dx

protectedinherited

Definition at line 180 of file JVersor3D.hh.

double JGEOMETRY3D::JVersor3D::__dy

protectedinherited

Definition at line 181 of file JVersor3D.hh.

double JGEOMETRY3D::JVersor3D::__dz

protectedinherited

Definition at line 182 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

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation