found::Vec3 Class Reference

#include <attitude-utils.hpp>

Public Member Functions
	Vec3 (decimal de, decimal ra)
	Vec3 (decimal x, decimal y, decimal z)
	Vec3 ()
decimal	Magnitude () const
decimal	MagnitudeSq () const
Vec3	Normalize () const
decimal	getRightAscension () const
decimal	getDeclination () const
decimal	operator* (const Vec3 &) const
	Dot product (Scalar product)
Vec3	operator* (const decimal &) const
	Vector-Scalar Multiplication.
Vec3	operator* (const Mat3 &) const
Vec3	operator- (const Vec3 &) const
	Vector Subtraction.
Vec3	CrossProduct (const Vec3 &) const
Mat3	OuterProduct (const Vec3 &) const

Public Attributes
decimal	x
	The x coordinate.
decimal	y
	The y coordinate.
decimal	z
	The z coordinate.

Detailed Description

A Vec3 is a mutable object that represents a 3D Vector

Constructor & Destructor Documentation

Vec3() [1/3]

found::Vec3::Vec3	(	decimal	de,
		decimal	ra
	)

Construction of orientation vector, which should be a unit vector

Parameters

de	The declination of the vector to create
ra	The right ascension of the vector to create

Vec3() [2/3]

found::Vec3::Vec3 ( decimal  x, decimal  y, decimal  z  )

inline

Construction of vector with x, y, and z components

Parameters

x	The scalar value in the x direction of the vector to make
y	The scalar value in the y direction of the vector to make
z	The scalar value in the z direction of the vector to make

Vec3() [3/3]

found::Vec3::Vec3 ( )

inline

Default construction of the Vector

Member Function Documentation

CrossProduct()

Vec3 found::Vec3::CrossProduct

(

const Vec3 &

other

)

const

Computes the cross (vector) product between this and another vector

Parameters

other

The vector to cross with this

Returns

A vector that is the cross product between this and other

getDeclination()

decimal found::Vec3::getDeclination

(

)

const

Obtains the Declination of this vector

Returns

The DE of this

Precondition

this is relative to the celestial coordinate system

getRightAscension()

decimal found::Vec3::getRightAscension

(

)

const

Obtains the Right Ascension of this vector

Returns

The RA of this

Precondition

this is relative to the celestial coordinate system

Magnitude()

decimal found::Vec3::Magnitude

(

)

const

Provides the magnitude of this Vec3

Returns

The magnitude of this

MagnitudeSq()

decimal found::Vec3::MagnitudeSq

(

)

const

Provides the square of the magnitude of this Vec3

Returns

The square of the magnitude of this

Normalize()

Vec3 found::Vec3::Normalize

(

)

const

Provides the magnitude of this Vec2

Returns

The magnitude of this

operator*()

Vec3 found::Vec3::operator*

(

const Mat3 &

other

)

const

Computes the product of a 3x3 matrix and a 3x1 vector (this)

Parameters

other

The matrix to multiply this with

Returns

The 3x1 vector resulting from the multiplication of other and this

OuterProduct()

Mat3 found::Vec3::OuterProduct

(

const Vec3 &

other

)

const

Computes the outer product between this and another vector

Parameters

other

The other vector in this operation

Returns

A matrix that is the outer product between this and other

---

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

• src/spatial/attitude-utils.hpp
• src/spatial/attitude-utils.cpp