Data structure for angle in two dimensions.
More...
#include <JAngle2D.hh>
Data structure for angle in two dimensions.
This class serves as input to the rotation matrix JRotation2D.
Definition at line 31 of file JAngle2D.hh.
◆ JAngle2D() [1/3]
JGEOMETRY2D::JAngle2D::JAngle2D |
( |
| ) |
|
|
inline |
◆ JAngle2D() [2/3]
JGEOMETRY2D::JAngle2D::JAngle2D |
( |
const double |
phi | ) |
|
|
inline |
Constructor.
- Parameters
-
Definition at line 48 of file JAngle2D.hh.
◆ JAngle2D() [3/3]
JGEOMETRY2D::JAngle2D::JAngle2D |
( |
const double |
x, |
|
|
const double |
y |
|
) |
| |
|
inline |
Constructor.
- Parameters
-
Definition at line 59 of file JAngle2D.hh.
◆ getPhi()
double JGEOMETRY2D::JAngle2D::getPhi |
( |
| ) |
const |
|
inline |
Get phi angle.
- Returns
- phi angle
Definition at line 70 of file JAngle2D.hh.
◆ getDX()
double JGEOMETRY2D::JAngle2D::getDX |
( |
| ) |
const |
|
inline |
Get x direction.
- Returns
- x direction
Definition at line 81 of file JAngle2D.hh.
◆ getDY()
double JGEOMETRY2D::JAngle2D::getDY |
( |
| ) |
const |
|
inline |
Get y direction.
- Returns
- y direction
Definition at line 92 of file JAngle2D.hh.
◆ negate()
JAngle2D& JGEOMETRY2D::JAngle2D::negate |
( |
| ) |
|
|
inline |
Negate angle.
- Returns
- this angle
Definition at line 103 of file JAngle2D.hh.
◆ add()
Add angle.
- Parameters
-
- Returns
- this angle
Definition at line 117 of file JAngle2D.hh.
◆ sub()
Subtract angle.
- Parameters
-
- Returns
- this angle
Definition at line 131 of file JAngle2D.hh.
◆ mul() [1/2]
JAngle2D& JGEOMETRY2D::JAngle2D::mul |
( |
const double |
factor | ) |
|
|
inline |
Scale angle.
- Parameters
-
factor | multiplication factor |
- Returns
- this angle
Definition at line 145 of file JAngle2D.hh.
◆ div()
JAngle2D& JGEOMETRY2D::JAngle2D::div |
( |
const double |
factor | ) |
|
|
inline |
Scale angle.
- Parameters
-
- Returns
- this angle
Definition at line 159 of file JAngle2D.hh.
◆ equals()
bool JGEOMETRY2D::JAngle2D::equals |
( |
const JAngle2D & |
angle, |
|
|
const double |
precision = std::numeric_limits<double>::min() |
|
) |
| const |
|
inline |
Check equality.
- Parameters
-
- Returns
- true if angles are equal; else false
Definition at line 173 of file JAngle2D.hh.
◆ getDot()
double JGEOMETRY2D::JAngle2D::getDot |
( |
const JAngle2D & |
angle | ) |
const |
|
inline |
Get dot product.
- Parameters
-
- Returns
- dot product
Definition at line 186 of file JAngle2D.hh.
◆ normalise()
JAngle2D& JGEOMETRY2D::JAngle2D::normalise |
( |
| ) |
|
|
inline |
Normalise angle.
- phi angle will be between 0 and 2π
- Returns
- this angle
Definition at line 199 of file JAngle2D.hh.
◆ mul() [2/2]
Multiply with object.
- Parameters
-
- Returns
- result object
Definition at line 273 of file JMath.hh.
◆ operator>> [1/2]
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 217 of file JAngle2D.hh.
219 return in >> angle.
__phi;
◆ operator<< [1/2]
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 230 of file JAngle2D.hh.
232 return out << angle.
getPhi();
◆ operator>> [2/2]
Read angle from input.
- Parameters
-
- Returns
- reader
Definition at line 243 of file JAngle2D.hh.
245 return in >> angle.
__phi;
◆ operator<< [2/2]
Write angle to output.
- Parameters
-
- Returns
- writer
Definition at line 256 of file JAngle2D.hh.
258 return out << angle.
__phi;
◆ __phi
double JGEOMETRY2D::JAngle2D::__phi |
|
protected |
The documentation for this class was generated from the following file: