sbvec2d(3)
NAME
SbVec2d
SYNOPSIS
#include <Inventor/SbLinear.h>
Detailed Description
The SbVec2d class is a 2 dimensional vector with double precision
floating point coordinates.
This vector class is used by many other classes in Coin. It provides
storage for a vector in 2 dimensions aswell as simple floating point
arithmetic operations on this vector.
- See also:
- SbVec2f, SbVec3f, SbVec3d, SbVec4f, SbVec4d
- Public Member Functions
- SbVec2d (void)
SbVec2d (const double v[2])
SbVec2d (const double x, const double y)
SbVec2d (const SbVec2f &v)
SbVec2d (const SbVec2b &v)
SbVec2d (const SbVec2s &v)
SbVec2d (const SbVec2i32 &v)
SbVec2d & setValue (const double v[2])
SbVec2d & setValue (const double x, const double y) SbVec2d & setValue (const SbVec2f &v) SbVec2d & setValue (const SbVec2b &v) SbVec2d & setValue (const SbVec2s &v) SbVec2d & setValue (const SbVec2i32 &v) double & operator[] (const int i)
const double & operator[] (const int i) const
double dot (const SbVec2d &v) const
SbBool equals (const SbVec2d &v, const double tolerance) const const double * getValue (void) const
void getValue (double &x, double &y) const
double length (void) const
double sqrLength (void) const
void negate (void)
double normalize (void)
SbVec2d & operator*= (const double d) SbVec2d & operator/= (const double d) SbVec2d & operator+= (const SbVec2d &u) SbVec2d & operator-= (const SbVec2d &u) SbVec2d operator- (void) const
void print (FILE *fp) const - Friends
- SbVec2d operator* (const SbVec2d &v, const double d) SbVec2d operator* (const double d, const SbVec2d &v) SbVec2d operator/ (const SbVec2d &v, const double d) SbVec2d operator+ (const SbVec2d &v1, const SbVec2d &v2) SbVec2d operator- (const SbVec2d &v1, const SbVec2d &v2) int operator== (const SbVec2d &v1, const SbVec2d &v2) int operator!= (const SbVec2d &v1, const SbVec2d &v2)
Constructor & Destructor Documentation
- SbVec2d::SbVec2d (void)
- The default constructor does nothing. The vector coordinates will be
uninitialized until you do a setValue(). - Referenced by operator-().
- SbVec2d::SbVec2d (const double v[2])
- Constructs an SbVec2d instance with initial values from v.
- SbVec2d::SbVec2d (const double x, const double y)
- Constructs an SbVec2d instance with the initial vector endpoints from x and y.
- SbVec2d::SbVec2d (const SbVec2f & v) [inline, explicit]
- Constructs an SbVec2d instance with initial values from the vector v.
- Since:
Coin-2.5
- SbVec2d::SbVec2d (const SbVec2b & v) [inline, explicit]
- Constructs an SbVec2d instance with initial values from the vector v.
- Since:
Coin-2.5
- SbVec2d::SbVec2d (const SbVec2s & v) [inline, explicit]
- Constructs an SbVec2d instance with initial values from the vector v.
- Since:
Coin-2.5
- SbVec2d::SbVec2d (const SbVec2i32 & v) [inline, explicit]
- Constructs an SbVec2d instance with initial values from the vector v.
- Since:
Coin-2.5
Member Function Documentation
- SbVec2d & SbVec2d::setValue (const double v[2])
- Set new x and y coordinates for the vector from v. Returns reference to self.
- See also:
getValue().
- Referenced by SbBox2d::extendBy(), SbBox2d::makeEmpty(), and
SbBox2d::setBounds(). - SbVec2d & SbVec2d::setValue (const double x, const double y)
- Set new x and y coordinates for the vector. Returns reference to self.
- See also:
getValue().
- SbVec2d & SbVec2d::setValue (const SbVec2f & v)
- Set new value from an SbVec2f instance. Returns reference to self.
- Since:
Coin-2.5
- See also:
getValue().
- SbVec2d & SbVec2d::setValue (const SbVec2b & v)
- Sets the value from an SbVec2b instance. Returns reference to itself.
- Since:
Coin-2.5
- SbVec2d & SbVec2d::setValue (const SbVec2s & v)
- Sets the value from an SbVec2s instance. Returns reference to itself.
- Since:
Coin-2.5
- SbVec2d & SbVec2d::setValue (const SbVec2i32 & v)
- Sets the value from an SbVec2i32 instance. Returns reference to itself.
- Since:
Coin-2.5
- double & SbVec2d::operator[] (const int i)
- Index operator. Returns modifiable x or y coordinate.
- See also:
getValue() and setValue().
- References SoDebugError::postWarning().
- const double & SbVec2d::operator[] (const int i) const
- Index operator. Returns x or y coordinate.
- See also:
getValue().
- References SoDebugError::postWarning().
- double SbVec2d::dot (const SbVec2d & v) const
- Calculates and returns the result of taking the dot product of this
vector and v. - References vec.
- SbBool SbVec2d::equals (const SbVec2d & 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.
- References SoDebugError::postWarning().
- const double * SbVec2d::getValue (void) const
- Returns a pointer to an array of two double containing the x and y
coordinates of the vector. - See also:
setValue().
- Referenced by SbBox2d::getBounds().
- void SbVec2d::getValue (double & x, double & y) const
- Returns the x and y coordinates of the vector.
- See also:
setValue().
- double SbVec2d::length (void) const
- Return length of vector.
- Referenced by normalize().
- double SbVec2d::sqrLength (void) const
- Return length of vector.
- Since:
Coin-2.5
- void SbVec2d::negate (void)
- Negate the vector (i.e. point it in the opposite direction).
- double SbVec2d::normalize (void)
- Normalize the vector to unit length. Return value is the original
length of the vector before normalization. - References length(), operator/=(), and SoDebugError::postWarning().
- SbVec2d & SbVec2d::operator*= (const double d)
- Multiply components of vector with value d. Returns reference to self.
- SbVec2d & SbVec2d::operator/= (const double d)
- Divides components of vector with value d. Returns reference to self.
- References SoDebugError::postWarning().
- Referenced by normalize().
- SbVec2d & SbVec2d::operator+= (const SbVec2d & u)
- Adds this vector and vector u. Returns reference to self.
- SbVec2d & SbVec2d::operator-= (const SbVec2d & u)
- Subtracts vector u from this vector. Returns reference to self.
- SbVec2d SbVec2d::operator- (void) const
- Non-destructive negation operator. Returns a new SbVec2d instance which points in the opposite direction of this vector.
- See also:
negate().
- References SbVec2d().
- void SbVec2d::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
- SbVec2d operator* (const SbVec2d & v, const double d) [friend]
- Returns an SbVec2d instance which is the components of vector v multiplied with d.
- SbVec2d operator* (const double d, const SbVec2d & v) [friend]
- Returns an SbVec2d instance which is the components of vector v multiplied with d.
- SbVec2d operator/ (const SbVec2d & v, const double d) [friend]
- Returns an SbVec2d instance which is the components of vector v divided on the scalar factor d.
- SbVec2d operator+ (const SbVec2d & v1, const SbVec2d & v2) [friend]
- Returns an SbVec2d instance which is the sum of vectors v1 and v2.
- SbVec2d operator- (const SbVec2d & v1, const SbVec2d & v2) [friend]
- Returns an SbVec2d instance which is vector v2 subtracted from vector v1.
- int operator== (const SbVec2d & v1, const SbVec2d & v2) [friend]
- Returns 1 if v1 and v2 are equal, 0 otherwise.
- See also:
equals().
- int operator!= (const SbVec2d & v1, const SbVec2d & v2) [friend]
- Returns 1 if v1 and v2 are not equal, 0 if they are equal.
- See also:
equals().
Author
- Generated automatically by Doxygen for Coin from the source code.