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

#include <JEulerAngle3D.hh>

Inheritance diagram for JGEOMETRY3D::JEulerAngle3D:

Public Member Functions
	JEulerAngle3D ()
	Default constructor.

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

	JEulerAngle3D (const JAngle3D &angle)
	Constructor.

	JEulerAngle3D (const JVersor3D &versor)
	Constructor.

const JEulerAngle3D &	getEulerAngle () const
	Get Euler angle.

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

JEulerAngle3D &	negate ()
	Negate angle.

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

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

JEulerAngle3D &	mul (const double factor)
	Scale angle.

JEulerAngle3D &	div (const double factor)
	Scale angle.

double	getAlpha () const
	Get alpha angle.

double	getBeta () const
	Get beta angle.

double	getGamma () const
	Get gamma angle.

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

Protected Attributes
double	__alpha

double	__beta

double	__gamma

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

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

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

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

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

◆ JEulerAngle3D() [1/4]

JGEOMETRY3D::JEulerAngle3D::JEulerAngle3D ( )

inline

Default constructor.

Definition at line 43 of file JEulerAngle3D.hh.

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

◆ JEulerAngle3D() [2/4]

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)
    {}

◆ JEulerAngle3D() [3/4]

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)
    {}

◆ JEulerAngle3D() [4/4]

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

◆ getEulerAngle()

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);
    }

◆ setEulerAngle()

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;
    }

◆ negate()

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;
    }

◆ add()

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;
    }

◆ sub()

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;
    }

◆ mul() [1/2]

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;
    }

◆ div()

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;
    }

◆ getAlpha()

double JGEOMETRY3D::JEulerAngle3D::getAlpha ( ) const

inline

Get alpha angle.

Returns: alpha angle

Definition at line 196 of file JEulerAngle3D.hh.

    { 
      return __alpha;
    }

◆ getBeta()

double JGEOMETRY3D::JEulerAngle3D::getBeta ( ) const

inline

Get beta angle.

Returns: beta angle

Definition at line 207 of file JEulerAngle3D.hh.

    { 
      return __beta;
    }

◆ getGamma()

double JGEOMETRY3D::JEulerAngle3D::getGamma ( ) const

inline

Get gamma angle.

Returns: gamma angle

Definition at line 218 of file JEulerAngle3D.hh.

    { 
      return __gamma;
    }

◆ mul() [2/2]

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 Symbol Documentation

◆ operator>> [1/2]

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;
    }

◆ operator<< [1/2]

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;
    }

◆ operator>> [2/2]

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;
    }

◆ operator<< [2/2]

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

◆ __alpha

double JGEOMETRY3D::JEulerAngle3D::__alpha

protected

Definition at line 293 of file JEulerAngle3D.hh.

◆ __beta

double JGEOMETRY3D::JEulerAngle3D::__beta

protected

Definition at line 294 of file JEulerAngle3D.hh.

◆ __gamma

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

◆ JEulerAngle3D() [1/4]

◆ JEulerAngle3D() [2/4]

◆ JEulerAngle3D() [3/4]

◆ JEulerAngle3D() [4/4]

Member Function Documentation

◆ getEulerAngle()

◆ setEulerAngle()

◆ negate()

◆ add()

◆ sub()

◆ mul() [1/2]

◆ div()

◆ getAlpha()

◆ getBeta()

◆ getGamma()

◆ mul() [2/2]

Friends And Related Symbol Documentation

◆ operator>> [1/2]

◆ operator<< [1/2]

◆ operator>> [2/2]

◆ operator<< [2/2]

Member Data Documentation

◆ __alpha

◆ __beta

◆ __gamma