Direction Class Reference

Description

A direction in three-dimensional space.

Definition at line 24 of file Direction.h.

Public Member Functions
	Direction ()
	Direction (double alpha, double phi)
double	alpha () const
double	phi () const
R3	vector () const
	Returns Cartesian 3D vector. More...
Direction	zReflected () const

Private Attributes
double	m_alpha
double	m_phi

Constructor & Destructor Documentation

Direction() [1/2]

Direction::Direction ( double  alpha, double  phi  )

inline

Definition at line 26 of file Direction.h.

        : m_alpha(alpha)
        , m_phi(phi)
    {
    }

Direction() [2/2]

Direction::Direction ( )

inline

Definition at line 31 of file Direction.h.

        : Direction(0, 0)
    {
    } // needed by Swig

Member Function Documentation

alpha()

double Direction::alpha ( ) const

inline

Definition at line 36 of file Direction.h.

{ return m_alpha; }

References m_alpha.

Referenced by DepthProbeSimulation::generateElements(), ISimulation2D::generateElements(), RectangularDetector::indexOfSpecular(), SphericalDetector::indexOfSpecular(), RectangularDetector::setDetectorNormal(), and Beam::setDirection().

phi()

double Direction::phi ( ) const

inline

Definition at line 37 of file Direction.h.

{ return m_phi; }

References m_phi.

Referenced by ISimulation2D::generateElements(), RectangularDetector::indexOfSpecular(), SphericalDetector::indexOfSpecular(), and Beam::setDirection().

vector()

R3 Direction::vector

(

)

const

Returns Cartesian 3D vector.

Definition at line 24 of file Direction.cpp.

{
    return {std::cos(m_alpha) * std::cos(m_phi), -std::cos(m_alpha) * std::sin(m_phi),
            std::sin(m_alpha)};
}

References m_alpha, and m_phi.

Referenced by RectangularDetector::setDetectorNormal(), and vecOfLambdaAlphaPhi().

zReflected()

Direction Direction::zReflected ( ) const

inline

Definition at line 42 of file Direction.h.

{ return {-m_alpha, m_phi}; }

References m_alpha, and m_phi.

Member Data Documentation

m_alpha

double Direction::m_alpha

private

Definition at line 45 of file Direction.h.

Referenced by alpha(), vector(), and zReflected().

m_phi

double Direction::m_phi

private

Definition at line 46 of file Direction.h.

Referenced by phi(), vector(), and zReflected().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Base/Vector/Direction.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Base/Vector/Direction.cpp