JGEOMETRY3D::JQuaternion2D Struct Reference

This class represents a rotation. More...

#include <JQuaternion3D.hh>

Inheritance diagram for JGEOMETRY3D::JQuaternion2D:

Public Member Functions
double	getA () const
	Get a value.
JQuaternion2D &	pow (const double y)
	Raise quaternion to given power.

Protected Member Functions
	JQuaternion2D ()
	Default constructor.
	JQuaternion2D (const double theta)
	Constructor.

Protected Attributes
double	__a
double	__u

Friends
std::istream &	operator>> (std::istream &in, JQuaternion2D &quaternion)
	Write quaternion from input.
std::ostream &	operator<< (std::ostream &out, const JQuaternion2D &quaternion)
	Write quaternion to output.
JReader &	operator>> (JReader &in, JQuaternion2D &quaternion)
	Read quaternion from input.
JWriter &	operator<< (JWriter &out, const JQuaternion2D &quaternion)
	Write quaternion to output.

Detailed Description

This class represents a rotation.

Definition at line 35 of file JQuaternion3D.hh.

Constructor & Destructor Documentation

JQuaternion2D() [1/2]

JGEOMETRY3D::JQuaternion2D::JQuaternion2D ( )

inlineprotected

Default constructor.

This constructor corresponds to the identity operation.

Definition at line 41 of file JQuaternion3D.hh.

                    :
      __a(1.0),
      __u(0.0)
    {}

JQuaternion2D() [2/2]

JGEOMETRY3D::JQuaternion2D::JQuaternion2D ( const double theta )

inlineprotected

Constructor.

Parameters

theta

rotation angle [rad]

Definition at line 52 of file JQuaternion3D.hh.

                                      :
      __a(cos(0.5*theta)),
      __u(sin(0.5*theta))
    {}

Member Function Documentation

getA()

double JGEOMETRY3D::JQuaternion2D::getA ( ) const

inline

Get a value.

Returns

a value

Definition at line 64 of file JQuaternion3D.hh.

    { 
      return __a;
    }

pow()

JQuaternion2D & JGEOMETRY3D::JQuaternion2D::pow ( const double y )

inline

Raise quaternion to given power.

Parameters

y

power

Returns

this object

Definition at line 76 of file JQuaternion3D.hh.

    {
      const double theta = atan2(__u, __a) * y;
 
      __a = cos(theta);
      __u = sin(theta);
 
      return *this;
    }

Friends And Related Symbol Documentation

operator>> [1/2]

std::istream & operator>> ( std::istream & in, JQuaternion2D & quaternion )

friend

Write quaternion from input.

Parameters

in	input stream
quaternion	quaternion

Returns

input stream

Definition at line 94 of file JQuaternion3D.hh.

    {
      return in >> quaternion.__a >> quaternion.__u;
    }

operator<< [1/2]

std::ostream & operator<< ( std::ostream & out, const JQuaternion2D & quaternion )

friend

Write quaternion to output.

Parameters

out	output stream
quaternion	quaternion

Returns

output stream

Definition at line 107 of file JQuaternion3D.hh.

    {
      const JFormat format(out, getFormat<JQuaternion3D>(JFormat_t(9, 6, std::ios::fixed | std::ios::showpos)));
 
      return out << format << quaternion.__a << ' '
                 << format << quaternion.__u;
    }

operator>> [2/2]

JReader & operator>> ( JReader & in, JQuaternion2D & quaternion )

friend

Read quaternion from input.

Parameters

in	reader
quaternion	quaternion

Returns

reader

Definition at line 123 of file JQuaternion3D.hh.

    {
      return in >> quaternion.__a >> quaternion.__u;
    }

operator<< [2/2]

JWriter & operator<< ( JWriter & out, const JQuaternion2D & quaternion )

friend

Write quaternion to output.

Parameters

out	writer
quaternion	quaternion

Returns

writer

Definition at line 136 of file JQuaternion3D.hh.

    {
      return out << quaternion.__a << quaternion.__u;
    }

Member Data Documentation

__a

double JGEOMETRY3D::JQuaternion2D::__a

protected

Definition at line 143 of file JQuaternion3D.hh.

__u

double JGEOMETRY3D::JQuaternion2D::__u

protected

Definition at line 144 of file JQuaternion3D.hh.

---

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

• JQuaternion3D.hh