JGEOMETRY2D::JAngle2D Class Reference

Data structure for angle in two dimensions. More...

#include <JAngle2D.hh>

Inheritance diagram for JGEOMETRY2D::JAngle2D:

Public Member Functions
	JAngle2D ()
	Default constructor. More...
	JAngle2D (const double phi)
	Constructor. More...
	JAngle2D (const double x, const double y)
	Constructor. More...
double	getPhi () const
	Get phi angle. More...
double	getDX () const
	Get x direction. More...
double	getDY () const
	Get y direction. More...
JAngle2D &	negate ()
	Negate angle. More...
JAngle2D &	add (const JAngle2D &angle)
	Add angle. More...
JAngle2D &	sub (const JAngle2D &angle)
	Subtract angle. More...
JAngle2D &	mul (const double factor)
	Scale angle. More...
JAngle2D &	div (const double factor)
	Scale angle. More...
bool	equals (const JAngle2D &angle) const
	Check equality. More...
double	getDot (const JAngle2D &angle) const
	Get dot product. More...
JAngle2D &	normalise ()
	Normalise angle. More...
JAngle2D &	mul (const JNullType &object)
	Multiply with object. More...

Protected Attributes
double	__phi

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

Detailed Description

Data structure for angle in two dimensions.

This class serves as input to the rotation matrix JRotation2D.

Definition at line 30 of file JAngle2D.hh.

Constructor & Destructor Documentation

JGEOMETRY2D::JAngle2D::JAngle2D ( )

inline

Default constructor.

Definition at line 37 of file JAngle2D.hh.

               :
      __phi(0.0)
    {}

JGEOMETRY2D::JAngle2D::JAngle2D ( const double  phi )

inline

Constructor.

Parameters

phi	phi angle [rad]

Definition at line 47 of file JAngle2D.hh.

                               :
      __phi(phi)
    {}

JGEOMETRY2D::JAngle2D::JAngle2D ( const double  x, const double  y  )

inline

Constructor.

Parameters

x	x value
y	y value

Definition at line 58 of file JAngle2D.hh.

                             :
      __phi(atan2(y,x))
    {}

Member Function Documentation

double JGEOMETRY2D::JAngle2D::getPhi ( ) const

inline

Get phi angle.

Returns

phi angle

Definition at line 69 of file JAngle2D.hh.

    { 
      return __phi;
    }

double JGEOMETRY2D::JAngle2D::getDX ( ) const

inline

Get x direction.

Returns

x direction

Definition at line 80 of file JAngle2D.hh.

    { 
      return cos(__phi);
    }

double JGEOMETRY2D::JAngle2D::getDY ( ) const

inline

Get y direction.

Returns

y direction

Definition at line 91 of file JAngle2D.hh.

    { 
      return sin(__phi);
    }

JAngle2D& JGEOMETRY2D::JAngle2D::negate ( )

inline

Negate angle.

Returns

this angle

Definition at line 102 of file JAngle2D.hh.

    {
      __phi = -__phi;

      return *this;
    }

JAngle2D& JGEOMETRY2D::JAngle2D::add ( const JAngle2D &  angle )

inline

Add angle.

Parameters

angle

angle

Returns

this angle

Definition at line 116 of file JAngle2D.hh.

    {
      __phi += angle.getPhi();

      return *this;
    }

JAngle2D& JGEOMETRY2D::JAngle2D::sub ( const JAngle2D &  angle )

inline

Subtract angle.

Parameters

angle

angle

Returns

this angle

Definition at line 130 of file JAngle2D.hh.

    {
      __phi -= angle.getPhi();

      return *this;
    }

JAngle2D& JGEOMETRY2D::JAngle2D::mul ( const double  factor )

inline

Scale angle.

Parameters

factor

multiplication factor

Returns

this angle

Definition at line 144 of file JAngle2D.hh.

    {
      __phi *= factor;

      return *this;
    }

JAngle2D& JGEOMETRY2D::JAngle2D::div ( const double  factor )

inline

Scale angle.

Parameters

factor

division factor

Returns

this angle

Definition at line 158 of file JAngle2D.hh.

    {
      __phi /= factor;

      return *this;
    }

bool JGEOMETRY2D::JAngle2D::equals ( const JAngle2D &  angle ) const

inline

Check equality.

Parameters

angle

angle

Returns

true if angles are equal; else false

Definition at line 172 of file JAngle2D.hh.

    {
      return getPhi() == angle.getPhi();
    }

double JGEOMETRY2D::JAngle2D::getDot ( const JAngle2D &  angle ) const

inline

Get dot product.

Parameters

angle

angle

Returns

dot product

Definition at line 184 of file JAngle2D.hh.

    {
      return cos(getPhi() - angle.getPhi());
    }

JAngle2D& JGEOMETRY2D::JAngle2D::normalise ( )

inline

Normalise angle.

• phi angle will be between 0 and 2π

Returns

this angle

Definition at line 197 of file JAngle2D.hh.

    {
      using JTOOLS::PI;

      if (__phi > 2*PI) { do { __phi -= 2*PI; } while (__phi > 2*PI); }
      if (__phi < 0.0)  { do { __phi += 2*PI; } while (__phi < 0.0); }

      return *this;
    }

JAngle2D & JMATH::JMath< JAngle2D , 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, JAngle2D &  angle  )

friend

Read angle from input.

Parameters

in	input stream
angle	angle

Returns

input stream

Definition at line 215 of file JAngle2D.hh.

    {
      return in >> angle.__phi;
    }

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

friend

Write angle to output.

Parameters

out	output stream
angle	angle

Returns

output stream

Definition at line 228 of file JAngle2D.hh.

    {
      return out << angle.getPhi();
    }

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

friend

Read angle from input.

Parameters

in	reader
angle	angle

Returns

reader

Definition at line 241 of file JAngle2D.hh.

    {
      return in >> angle.__phi;
    }

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

friend

Write angle to output.

Parameters

out	writer
angle	angle

Returns

writer

Definition at line 254 of file JAngle2D.hh.

    {
      return out << angle.__phi;
    }

Member Data Documentation

double JGEOMETRY2D::JAngle2D::__phi

protected

Definition at line 260 of file JAngle2D.hh.

---

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

• JAngle2D.hh