User Manual, Developers Guide and API Documentation

wns::geometry::Vector Class Reference

A 3D position offset (deltaX,deltaY,deltaZ).

#include <geometry/Vector.hpp>

Collaboration diagram for wns::geometry::Vector:

Collaboration graph
[legend]

List of all members.

Public Member Functions

double abs () const
Vector cross (const Vector &other) const
double dot (const Vector &other) const
const std::valarray< double > & get () const
double getAzimuth () const
double getDeltaX () const
double getDeltaY () const
double getDeltaZ () const
double getElevation () const
double getPhi () const
 forwards to getAzimuth
double getR () const
double getTheta () const
 forwards to getElevation
bool operator!= (const Vector &other) const
Vector operator* (const double scale) const
Vector operator* (const int scale) const
Vector operator+ (const Vector &other) const
Point operator+ (const Point &point) const
void operator= (const Vector &other)
bool operator== (const Vector &other) const
void set (const std::valarray< double > &posOffset)
void set (double dx, double dy=0.0, double dz=0.0)
void setAzimuth (double phi)
void setDeltaX (double dx)
void setDeltaY (double dy)
void setDeltaZ (double dz)
void setElevation (double theta)
void setPolar (double r, double phi, double theta)
void setR (double r)
 Vector (const Point &p1, const Point &p2)
 Vector between p1 and p2.
 Vector (const std::valarray< double > &other)
 Vector (double dx, double dy, double dz)
 Vector ()
virtual ~Vector ()

Private Attributes

std::valarray< doublevec


Detailed Description

Definition at line 38 of file Vector.hpp.


Constructor & Destructor Documentation

Vector::Vector (  ) 

Definition at line 35 of file Vector.cpp.

Vector::Vector ( double  dx,
double  dy,
double  dz 
)

Definition at line 40 of file Vector.cpp.

wns::geometry::Vector::Vector ( const std::valarray< double > &  other  )  [explicit]

wns::geometry::Vector::Vector ( const Point p1,
const Point p2 
) [inline]

The resulting Vector will point from p1 to p2.

Definition at line 53 of file Vector.hpp.

Vector::~Vector (  )  [virtual]

Definition at line 53 of file Vector.cpp.


Member Function Documentation

double Vector::abs (  )  const

Definition at line 194 of file Vector.cpp.

Vector Vector::cross ( const Vector other  )  const

Definition at line 179 of file Vector.cpp.

double Vector::dot ( const Vector other  )  const

Definition at line 188 of file Vector.cpp.

const std::valarray< double > & Vector::get (  )  const

Definition at line 133 of file Vector.cpp.

double Vector::getAzimuth (  )  const

Definition at line 121 of file Vector.cpp.

double Vector::getDeltaX (  )  const

Definition at line 80 of file Vector.cpp.

double Vector::getDeltaY (  )  const

Definition at line 86 of file Vector.cpp.

double Vector::getDeltaZ (  )  const

Definition at line 92 of file Vector.cpp.

double Vector::getElevation (  )  const

Definition at line 127 of file Vector.cpp.

double Vector::getPhi (  )  const

Deprecated:
pls use getAzimuth

Definition at line 167 of file Vector.cpp.

double Vector::getR (  )  const

Definition at line 115 of file Vector.cpp.

double Vector::getTheta (  )  const

Deprecated:
pls use getElevation

Definition at line 173 of file Vector.cpp.

bool Vector::operator!= ( const Vector other  )  const

Definition at line 243 of file Vector.cpp.

Vector Vector::operator* ( const double  scale  )  const

Definition at line 218 of file Vector.cpp.

Vector Vector::operator* ( const int  scale  )  const

Definition at line 212 of file Vector.cpp.

Vector Vector::operator+ ( const Vector other  )  const

Definition at line 206 of file Vector.cpp.

Point Vector::operator+ ( const Point point  )  const

Definition at line 200 of file Vector.cpp.

void Vector::operator= ( const Vector other  ) 

Definition at line 228 of file Vector.cpp.

bool Vector::operator== ( const Vector other  )  const

Definition at line 234 of file Vector.cpp.

void wns::geometry::Vector::set ( const std::valarray< double > &  posOffset  ) 

void Vector::set ( double  dx,
double  dy = 0.0,
double  dz = 0.0 
)

Definition at line 58 of file Vector.cpp.

void Vector::setAzimuth ( double  phi  ) 

Definition at line 148 of file Vector.cpp.

void Vector::setDeltaX ( double  dx  ) 

Definition at line 98 of file Vector.cpp.

void Vector::setDeltaY ( double  dy  ) 

Definition at line 103 of file Vector.cpp.

void Vector::setDeltaZ ( double  dz  ) 

Definition at line 109 of file Vector.cpp.

void Vector::setElevation ( double  theta  ) 

Definition at line 157 of file Vector.cpp.

void Vector::setPolar ( double  r,
double  phi,
double  theta 
)

Definition at line 66 of file Vector.cpp.

void Vector::setR ( double  r  ) 

Definition at line 139 of file Vector.cpp.


Member Data Documentation

std::valarray<double> wns::geometry::Vector::vec [private]

Definition at line 157 of file Vector.hpp.


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

Generated on Sat May 26 03:32:54 2012 for openWNS by  doxygen 1.5.5