Geom Software - C++ Programming and Geometry Libraries
WOF Documentation pages v1.04
GEOM_WOF::Vector3 Class Reference

3D Vector

#include <Vector3.h>

Public Member Functions

 Vector3 (const double x_, const double y_, const double z_)
 Constructor. More...
 
 Vector3 ()
 Default constructor. More...
 
 Vector3 (const Vector3 &v_)
 Copy constructor. More...
 
bool isDegenerate () const
 isDegenerate More...
 
void xyz (double &x_, double &y_, double &z_) const
 Get x,y,z. More...
 
double x () const
 Get the x-value. More...
 
double y () const
 Get the y-value. More...
 
double z () const
 Get the z-value. More...
 
void set (const double x_, const double y_, const double z_)
 Set x,y,z. More...
 
void add (const Vector3 &other)
 Add a Vector3 to the present one. More...
 
void sub (const Vector3 &other)
 
void div (double div)
 
void mul (double mul)
 
double sqLength () const
 Get the squared length of the vector. More...
 
int getMaxAbsIndex () const
 Get max index. More...
 
double getMaxComponent () const
 Get max component. More...
 
double getMaxAbsComponent () const
 Get max absolute component. More...
 
double getCartesian (int i) const
 Get component i. More...
 
double length () const
 Get the length of the vector. More...
 
double operator* (const Vector3 &other) const
 Scalar product. More...
 
Vector3 operator* (double val) const
 Multiply by a scalar value. More...
 
Vector3 operator/ (double val) const
 Divide by a scalar value. More...
 
Vector3operator= (const Vector3 &other)
 Equality operator. More...
 

Protected Attributes

double valX
 
double valY
 
double valZ
 

Constructor & Destructor Documentation

◆ Vector3() [1/3]

GEOM_WOF::Vector3::Vector3 ( const double  x_,
const double  y_,
const double  z_ 
)
Parameters
x_,y_,z_Values to initialize the Vector

◆ Vector3() [2/3]

GEOM_WOF::Vector3::Vector3 ( )

The vector is initialized to (0,0,0)

◆ Vector3() [3/3]

GEOM_WOF::Vector3::Vector3 ( const Vector3 v_)

Copies v_

Member Function Documentation

◆ add()

void GEOM_WOF::Vector3::add ( const Vector3 other)
inline
Parameters
otheris added to the present Vector3

◆ getCartesian()

double GEOM_WOF::Vector3::getCartesian ( int  i) const
Returns
the i-th component

◆ getMaxAbsComponent()

double GEOM_WOF::Vector3::getMaxAbsComponent ( ) const
Returns
the maximum absolute component

◆ getMaxAbsIndex()

int GEOM_WOF::Vector3::getMaxAbsIndex ( ) const
Returns
the index of the largest absolute component (0,1 or 2)

◆ getMaxComponent()

double GEOM_WOF::Vector3::getMaxComponent ( ) const
inline
Returns
the maximum component

◆ isDegenerate()

bool GEOM_WOF::Vector3::isDegenerate ( ) const
Returns
true if the vector length is 0, false otherwise.

◆ length()

double GEOM_WOF::Vector3::length ( ) const
Returns
the length of the vector

◆ operator*() [1/2]

double GEOM_WOF::Vector3::operator* ( const Vector3 other) const
Returns
the scalar product of the present Vector3 and other

◆ operator*() [2/2]

Vector3 GEOM_WOF::Vector3::operator* ( double  val) const
Returns
the present Vector3 multiplied by val

◆ operator/()

Vector3 GEOM_WOF::Vector3::operator/ ( double  val) const
Returns
the present Vector3 divided by val

◆ operator=()

Vector3& GEOM_WOF::Vector3::operator= ( const Vector3 other)
Returns
true when the present Vector3 has the same x,y,z-values as other

◆ set()

void GEOM_WOF::Vector3::set ( const double  x_,
const double  y_,
const double  z_ 
)

Assigns values to the present Vector3

Parameters
x_,y_,z_Values to assign

◆ sqLength()

double GEOM_WOF::Vector3::sqLength ( ) const
Returns
the squared length of the Vector3

◆ x()

double GEOM_WOF::Vector3::x ( ) const
Returns
x

◆ xyz()

void GEOM_WOF::Vector3::xyz ( double &  x_,
double &  y_,
double &  z_ 
) const
inline
Parameters
x_,y_,z_[out] Used to return the x,y,z-values of the Vector

◆ y()

double GEOM_WOF::Vector3::y ( ) const
Returns
y

◆ z()

double GEOM_WOF::Vector3::z ( ) const
Returns
z

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