Coin Logo http://www.sim.no
http://www.coin3d.org

SbVec3d Class Reference
[Base classes]

#include <Inventor/SbLinear.h>

List of all members.


Detailed Description

The SbVec3d class is a 3 dimensional vector with double precision floating point coordinates.

This vector class provides storage for a 3 dimensional double precision floating point vector aswell as simple floating point arithmetic operations.

See also:
SbVec2s, SbVec2f, SbVec2d, SbVec3s, SbVec3f, SbVec4f, SbVec4d.
Since:
Coin 2.0

TGS Inventor 2.6


Public Member Functions

 SbVec3d (void)
 SbVec3d (const double v[3])
 SbVec3d (const double x, const double y, const double z)
 SbVec3d (const SbVec3f &v)
SbVec3d cross (const SbVec3d &v) const
double dot (const SbVec3d &v) const
SbBool equals (const SbVec3d &v, const double tolerance) const
SbVec3d getClosestAxis (void) const
const double * getValue (void) const
void getValue (double &x, double &y, double &z) const
double length (void) const
double sqrLength () const
void negate (void)
double normalize (void)
SbVec3dsetValue (const double v[3])
SbVec3dsetValue (const double x, const double y, const double z)
SbVec3dsetValue (const SbVec3d &barycentric, const SbVec3d &v0, const SbVec3d &v1, const SbVec3d &v2)
SbVec3dsetValue (const SbVec3f &v)
double & operator[] (const int i)
const double & operator[] (const int i) const
SbVec3doperator *= (const double d)
SbVec3doperator/= (const double d)
SbVec3doperator+= (const SbVec3d &u)
SbVec3doperator-= (const SbVec3d &u)
SbVec3d operator- (void) const
void print (FILE *fp) const

Friends

SbVec3d operator * (const SbVec3d &v, const double d)
SbVec3d operator * (const double d, const SbVec3d &v)
SbVec3d operator/ (const SbVec3d &v, const double d)
SbVec3d operator+ (const SbVec3d &v1, const SbVec3d &v2)
SbVec3d operator- (const SbVec3d &v1, const SbVec3d &v2)
int operator== (const SbVec3d &v1, const SbVec3d &v2)
int operator!= (const SbVec3d &v1, const SbVec3d &v2)

Constructor & Destructor Documentation

SbVec3d::SbVec3d ( void   )  [inline]

The default constructor does nothing. The vector coordinates will be uninitialized until you do a setValue() call.

SbVec3d::SbVec3d ( const double  v[3]  ) 

Constructs an SbVec3d instance with initial values from v.

SbVec3d::SbVec3d ( const double  x,
const double  y,
const double  z 
)

Constructs an SbVec3d instance with the initial vector endpoint set to <x,y,z>.

SbVec3d::SbVec3d ( const SbVec3f v  ) 

Constructs an SbVec3d instance with initial values from the single precision vector v.

DEPRECATED for Coin 3.0 -- don't use this.


Member Function Documentation

SbVec3d SbVec3d::cross ( const SbVec3d v  )  const

Returns the result of taking the cross product of this vector and v.

double SbVec3d::dot ( const SbVec3d v  )  const

Calculates and returns the result of taking the dot product of this vector and v.

SbBool SbVec3d::equals ( const SbVec3d v,
const double  tolerance 
) const

Compares the vector with v and returns TRUE if the distance between the vectors is smaller or equal to the square root of tolerance.

SbVec3d SbVec3d::getClosestAxis ( void   )  const

Return the vector representing the principal axis closest to this vector.

const double * SbVec3d::getValue ( void   )  const

Returns a pointer to an array of three doubles containing the x, y and z coordinates of the vector.

See also:
setValue().

void SbVec3d::getValue ( double &  x,
double &  y,
double &  z 
) const

Returns the x, y and z coordinates of the vector.

See also:
setValue().

double SbVec3d::length ( void   )  const

Return length of vector.

double SbVec3d::sqrLength ( void   )  const

Returns the squared length of the vector.

void SbVec3d::negate ( void   ) 

Negate the vector (i.e. point it in the opposite direction).

double SbVec3d::normalize ( void   ) 

Normalize the vector to unit length. Return value is the original length of the vector before normalization.

If the vector is the null vector, no attempt at normalization will be done.

SbVec3d & SbVec3d::setValue ( const double  v[3]  ) 

Set new coordinates for the vector from v. Returns reference to self.

See also:
getValue().

SbVec3d & SbVec3d::setValue ( const double  x,
const double  y,
const double  z 
)

Set new coordinates for the vector. Returns reference to self.

See also:
getValue().

SbVec3d & SbVec3d::setValue ( const SbVec3d barycentric,
const SbVec3d v0,
const SbVec3d v1,
const SbVec3d v2 
)

Set this vector to be the average of v0, v1 and v2. The vector components are weighted by the barycentric vector.

See also:
getValue().

SbVec3d & SbVec3d::setValue ( const SbVec3f v  ) 

Sets this vector to the single precision vector v, converting the vector to a double precision vector.

double & SbVec3d::operator[] ( const int  i  )  [inline]

Index operator. Returns modifiable x, y or z coordinate of vector.

See also:
getValue() and setValue().

double SbVec3d::operator[] ( const int  i  )  const [inline]

Index operator. Returns x, y or z coordinate of vector.

See also:
getValue() and setValue().

SbVec3d & SbVec3d::operator *= ( const double  d  ) 

Multiply components of vector with value d. Returns reference to self.

SbVec3d & SbVec3d::operator/= ( const double  d  ) 

Divides components of vector with value d. Returns reference to self.

SbVec3d & SbVec3d::operator+= ( const SbVec3d u  ) 

Adds this vector and vector u. Returns reference to self.

SbVec3d & SbVec3d::operator-= ( const SbVec3d u  ) 

Subtracts vector u from this vector. Returns reference to self.

SbVec3d SbVec3d::operator- ( void   )  const

Non-destructive negation operator. Returns a new SbVec3d instance which points in the opposite direction of this vector.

See also:
negate().

void SbVec3d::print ( FILE *  fp  )  const

Dump the state of this object to the file stream. Only works in debug version of library, method does nothing in an optimized compile.


Friends And Related Function Documentation

SbVec3d operator * ( const SbVec3d v,
const double  d 
) [friend]

Returns an SbVec3d instance which is the components of vector v multiplied with d.

SbVec3d operator * ( const double  d,
const SbVec3d v 
) [friend]

Returns an SbVec3d instance which is the components of vector v multiplied with d.

SbVec3d operator/ ( const SbVec3d v,
const double  d 
) [friend]

Returns an SbVec3d instance which is the components of vector v divided on the scalar factor d.

SbVec3d operator+ ( const SbVec3d v1,
const SbVec3d v2 
) [friend]

Returns an SbVec3d instance which is the sum of vectors v1 and v2.

SbVec3d operator- ( const SbVec3d v1,
const SbVec3d v2 
) [friend]

Returns an SbVec3d instance which is vector v2 subtracted from vector v1.

int operator== ( const SbVec3d v1,
const SbVec3d v2 
) [friend]

Returns 1 if v1 and v2 are exactly equal, 0 otherwise.

See also:
equals().

int operator!= ( const SbVec3d v1,
const SbVec3d v2 
) [friend]

Returns 1 if v1 and v2 are not equal, 0 if they are equal.

See also:
equals().


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

Copyright © 1998-2005 by Systems in Motion AS. All rights reserved.

Generated on Wed Aug 15 07:37:41 2007 for Coin by Doxygen. 1.5.3