INDI::AlignmentSubsystem::TelescopeDirectionVector Struct Reference

Holds a nomalised direction vector (direction cosines) More...

#include <Common.h>

Collaboration diagram for INDI::AlignmentSubsystem::TelescopeDirectionVector:

Public Member Functions
	TelescopeDirectionVector ()
	Default constructor. More...
	TelescopeDirectionVector (double X, double Y, double Z)
	Copy constructor. More...
const TelescopeDirectionVector	operator* (const TelescopeDirectionVector &RHS) const
	Override the * operator to return a cross product. More...
const TelescopeDirectionVector	operator* (const double &RHS) const
	Override the * operator to return a scalar product. More...
const TelescopeDirectionVector &	operator*= (const double &RHS)
	Override the *= operator to return a unary scalar product. More...
const TelescopeDirectionVector	operator- (const TelescopeDirectionVector &RHS) const
	Override the - operator to return a binary vector subtract. More...
double	operator^ (const TelescopeDirectionVector &RHS) const
	Override the ^ operator to return a dot product. More...
double	Length () const
	Return the length of the vector. More...
void	Normalise ()
	Normalise the vector. More...
void	RotateAroundY (double Angle)
	Rotate the reference frame around the Y axis. More...

Public Attributes
double	x
double	y
double	z

Detailed Description

Holds a nomalised direction vector (direction cosines)

The x y,z fields of this class should normally represent a normalised (unit length) vector in a right handed rectangular coordinate space. However, for convenience a number a number of standard 3d vector methods are also supported.

Constructor & Destructor Documentation

TelescopeDirectionVector() [1/2]

INDI::AlignmentSubsystem::TelescopeDirectionVector::TelescopeDirectionVector ( )

inline

Default constructor.

TelescopeDirectionVector() [2/2]

INDI::AlignmentSubsystem::TelescopeDirectionVector::TelescopeDirectionVector ( double  X, double  Y, double  Z  )

inline

Copy constructor.

Member Function Documentation

Length()

double INDI::AlignmentSubsystem::TelescopeDirectionVector::Length ( ) const

inline

Return the length of the vector.

Returns

Length of the vector

Normalise()

void INDI::AlignmentSubsystem::TelescopeDirectionVector::Normalise ( )

inline

Normalise the vector.

operator*() [1/2]

const TelescopeDirectionVector INDI::AlignmentSubsystem::TelescopeDirectionVector::operator* ( const TelescopeDirectionVector &  RHS ) const

inline

Override the * operator to return a cross product.

operator*() [2/2]

const TelescopeDirectionVector INDI::AlignmentSubsystem::TelescopeDirectionVector::operator* ( const double &  RHS ) const

inline

Override the * operator to return a scalar product.

operator*=()

const TelescopeDirectionVector& INDI::AlignmentSubsystem::TelescopeDirectionVector::operator*= ( const double &  RHS )

inline

Override the *= operator to return a unary scalar product.

operator-()

const TelescopeDirectionVector INDI::AlignmentSubsystem::TelescopeDirectionVector::operator- ( const TelescopeDirectionVector &  RHS ) const

inline

Override the - operator to return a binary vector subtract.

operator^()

double INDI::AlignmentSubsystem::TelescopeDirectionVector::operator^ ( const TelescopeDirectionVector &  RHS ) const

inline

Override the ^ operator to return a dot product.

RotateAroundY()

void INDI::AlignmentSubsystem::TelescopeDirectionVector::RotateAroundY

(

double

Angle

)

Rotate the reference frame around the Y axis.

This has the affect of rotating the vector itself in the opposite direction

Parameters

[in]

Angle

The angle to rotate the reference frame by. Positive values give an anti-clockwise rotation from the perspective of looking down the positive axis towards the origin.

Member Data Documentation

x

double INDI::AlignmentSubsystem::TelescopeDirectionVector::x

y

double INDI::AlignmentSubsystem::TelescopeDirectionVector::y

z

double INDI::AlignmentSubsystem::TelescopeDirectionVector::z

---

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

• ln/3rdparty/src/indilib/indi-1.7.4/libindi/libs/indibase/alignment/Common.h
• ln/3rdparty/src/indilib/indi-1.7.4/libindi/libs/indibase/alignment/Common.cpp