Data structure for Euler angles in three dimensions. More...

#include <JEulerAngle3D.hh>

Inheritance diagram for JGEOMETRY3D::JEulerAngle3D:

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

	JEulerAngle3D (const double alpha, const double beta, const double gamma)
	Constructor. More...

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

	JEulerAngle3D (const JVersor3D &versor)
	Constructor. More...

const JEulerAngle3D &	getEulerAngle () const
	Get Euler angle. More...

void	setEulerAngle (const JEulerAngle3D &angle)
	Set Euler angle. More...

JEulerAngle3D &	negate ()
	Negate angle. More...

JEulerAngle3D &	add (const JEulerAngle3D &angle)
	Add angle. More...

JEulerAngle3D &	sub (const JEulerAngle3D &angle)
	Subtract angle. More...

JEulerAngle3D &	mul (const double factor)
	Scale angle. More...

JEulerAngle3D &	div (const double factor)
	Scale angle. More...

double	getAlpha () const
	Get alpha angle. More...

double	getBeta () const
	Get beta angle. More...

double	getGamma () const
	Get gamma angle. More...

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

Protected Attributes
double	__alpha

double	__beta

double	__gamma

Friends
std::istream &	operator>> (std::istream &in, JEulerAngle3D &angle)
	Read Euler angles from input. More...

std::ostream &	operator<< (std::ostream &out, const JEulerAngle3D &angle)
	Write Euler angles to output. More...

JReader &	operator>> (JReader &in, JEulerAngle3D &angle)
	Read Euler angles from input. More...

JWriter &	operator<< (JWriter &out, const JEulerAngle3D &angle)
	Write Euler angles to output. More...

Detailed Description

Data structure for Euler angles in three dimensions.

This class implements the JMATH::JMath interface.

Definition at line 36 of file JEulerAngle3D.hh.

Constructor & Destructor Documentation

JGEOMETRY3D::JEulerAngle3D::JEulerAngle3D ( )

inline

Default constructor.

Definition at line 43 of file JEulerAngle3D.hh.

                     :
       __alpha(0.0),
       __beta (0.0),
       __gamma(0.0)
     {}

JGEOMETRY3D::JEulerAngle3D::JEulerAngle3D	(	const double	alpha,
		const double	beta,
		const double	gamma
	)

inline

Constructor.

Parameters

alpha	alpha angle [rad]
beta	beta angle [rad]
gamma	gamma angle [rad]

Definition at line 57 of file JEulerAngle3D.hh.

                                       :
       __alpha(alpha),
       __beta (beta),
       __gamma(gamma)
     {}

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

inline

Constructor.

Parameters

angle angle

Definition at line 71 of file JEulerAngle3D.hh.

                                          :
       __alpha(PI/2),
       __beta (angle.getTheta()),
       __gamma(angle.getPhi() + PI/2)
     {}

JGEOMETRY3D::JEulerAngle3D::JEulerAngle3D ( const JVersor3D & versor )

inline

Constructor.

Parameters

versor versor

Definition at line 83 of file JEulerAngle3D.hh.

                                            :
       __alpha(PI/2),
       __beta (versor.getTheta()),
       __gamma(versor.getPhi() + PI/2)
     {}

Member Function Documentation

const JEulerAngle3D& JGEOMETRY3D::JEulerAngle3D::getEulerAngle ( ) const

inline

Get Euler angle.

Returns: this angle

Definition at line 95 of file JEulerAngle3D.hh.

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

void JGEOMETRY3D::JEulerAngle3D::setEulerAngle ( const JEulerAngle3D & angle )

inline

Set Euler angle.

Parameters

angle Euler angle

Definition at line 106 of file JEulerAngle3D.hh.

     {
       static_cast<JEulerAngle3D&>(*this) = angle;
     }

JEulerAngle3D& JGEOMETRY3D::JEulerAngle3D::negate ( )

inline

Negate angle.

Returns: this angle

Definition at line 117 of file JEulerAngle3D.hh.

     {
       __alpha = -__alpha;
       __beta  = -__beta;
       __gamma = -__gamma;
 
       return *this;
     }

JEulerAngle3D& JGEOMETRY3D::JEulerAngle3D::add ( const JEulerAngle3D & angle )

inline

Add angle.

Parameters

angle angle

Returns: this angle

Definition at line 133 of file JEulerAngle3D.hh.

     {
       __alpha += angle.getAlpha();
       __beta  += angle.getBeta();
       __gamma += angle.getGamma();
 
       return *this;
     }

JEulerAngle3D& JGEOMETRY3D::JEulerAngle3D::sub ( const JEulerAngle3D & angle )

inline

Subtract angle.

Parameters

angle angle

Returns: this angle

Definition at line 149 of file JEulerAngle3D.hh.

     {
       __alpha -= angle.getAlpha();
       __beta  -= angle.getBeta();
       __gamma -= angle.getGamma();
 
       return *this;
     }

JEulerAngle3D& JGEOMETRY3D::JEulerAngle3D::mul ( const double factor )

inline

Scale angle.

Parameters

factor multiplication factor

Returns: this angle

Definition at line 165 of file JEulerAngle3D.hh.

     {
       __alpha *= factor;
       __beta  *= factor;
       __gamma *= factor;
 
       return *this;
     }

JEulerAngle3D& JGEOMETRY3D::JEulerAngle3D::div ( const double factor )

inline

Scale angle.

Parameters

factor division factor

Returns: this angle

Definition at line 181 of file JEulerAngle3D.hh.

     {
       __alpha /= factor;
       __beta  /= factor;
       __gamma /= factor;
 
       return *this;
     }

double JGEOMETRY3D::JEulerAngle3D::getAlpha ( ) const

inline

Get alpha angle.

Returns: alpha angle

Definition at line 196 of file JEulerAngle3D.hh.

     { 
       return __alpha;
     }

double JGEOMETRY3D::JEulerAngle3D::getBeta ( ) const

inline

Get beta angle.

Returns: beta angle

Definition at line 207 of file JEulerAngle3D.hh.

     { 
       return __beta;
     }

double JGEOMETRY3D::JEulerAngle3D::getGamma ( ) const

inline

Get gamma angle.

Returns: gamma angle

Definition at line 218 of file JEulerAngle3D.hh.

     { 
       return __gamma;
     }

template<class JFirst_t, class JSecond_t = JNullType>

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 357 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,
		JEulerAngle3D &	angle
	)

friend

Read Euler angles from input.

Parameters

in	input stream
angle	Euler angles

Returns: input stream

Definition at line 231 of file JEulerAngle3D.hh.

     {
       in >> angle.__alpha  >> angle.__beta  >> angle.__gamma;
 
       return in;
     }

std::ostream& operator<<	(	std::ostream &	out,
		const JEulerAngle3D &	angle
	)

friend

Write Euler angles to output.

Parameters

out	output stream
angle	Euler angle

Returns: output stream

Definition at line 246 of file JEulerAngle3D.hh.

     {
        const JFormat format(out, getFormat<JAngle3D>(JFormat_t(9, 5, std::ios::fixed | std::ios::showpos)));
 
        out << format << angle.getAlpha() << ' ' 
            << format << angle.getBeta()  << ' ' 
            << format << angle.getGamma();
 
       return out;
     }

JReader& operator>>	(	JReader &	in,
		JEulerAngle3D &	angle
	)

friend

Read Euler angles from input.

Parameters

in	reader
angle	Euler angles

Returns: reader

Definition at line 265 of file JEulerAngle3D.hh.

     {
       in >> angle.__alpha;
       in >> angle.__beta;
       in >> angle.__gamma;
 
       return in;
     }

JWriter& operator<<	(	JWriter &	out,
		const JEulerAngle3D &	angle
	)

friend

Write Euler angles to output.

Parameters

out	writer
angle	Euler angles

Returns: writer

Definition at line 282 of file JEulerAngle3D.hh.

     {
       out << angle.__alpha;
       out << angle.__beta;
       out << angle.__gamma;
 
       return out;
     }

Member Data Documentation

double JGEOMETRY3D::JEulerAngle3D::__alpha

protected

Definition at line 293 of file JEulerAngle3D.hh.

double JGEOMETRY3D::JEulerAngle3D::__beta

protected

Definition at line 294 of file JEulerAngle3D.hh.

double JGEOMETRY3D::JEulerAngle3D::__gamma

protected

Definition at line 295 of file JEulerAngle3D.hh.

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

JEulerAngle3D.hh

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation