trusty (3) SbVec2d.3.gz

Provided by: libcoin80-doc_3.1.4~abc9f50-4ubuntu2_all bug

NAME

       SbVec2d -

       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.

SYNOPSIS

   Public Member Functions
       SbVec2d (void)
       SbVec2d (const double v[2])
       SbVec2d (double x, 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 (double x, double y)
       SbVec2d & setValue (const SbVec2f &v)
       SbVec2d & setValue (const SbVec2b &v)
       SbVec2d & setValue (const SbVec2s &v)
       SbVec2d & setValue (const SbVec2i32 &v)
       const double * getValue (void) const
       void getValue (double &x, double &y) const
       double & operator[] (int i)
       const double & operator[] (int i) const
       SbBool equals (const SbVec2d &v, double tolerance) const
       double dot (const SbVec2d &v) const
       double length (void) const
       double sqrLength (void) const
       double normalize (void)
       void negate (void)
       SbVec2d & operator*= (double d)
       SbVec2d & operator/= (double d)
       SbVec2d & operator+= (const SbVec2d &v)
       SbVec2d & operator-= (const SbVec2d &v)
       SbVec2d operator- (void) const
       void print (FILE *fp) const

   Protected Attributes
       double vec [2]

   Related Functions
       (Note that these are not member functions.)
       SbVec2d operator* (const SbVec2d &v, double d)
       SbVec2d operator* (double d, const SbVec2d &v)
       SbVec2d operator/ (const SbVec2d &v, 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)

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:
           SbVec2s, SbVec2f, SbVec3s, SbVec3f, SbVec3d, SbVec4f, SbVec4d.

Constructor & Destructor Documentation

   SbVec2d::SbVec2d (void) [inline]
       The default constructor does nothing. The vector coordinates will be uninitialized until you do a
       setValue().

   SbVec2d::SbVec2d (const doublev[2]) [inline]
       Constructs an SbVec2d instance with initial values from v.

   SbVec2d::SbVec2d (doublex, doubley) [inline]
       Constructs an SbVec2d instance with the initial vector endpoints from x and y.

   SbVec2d::SbVec2d (const SbVec2f &v) [inline],  [explicit]
       Constructs an SbVec2d instance from an SbVec2f instance.

       Since:
           Coin 2.5

   SbVec2d::SbVec2d (const SbVec2b &v) [inline],  [explicit]
       Constructs an SbVec2d instance from an SbVec2b instance.

       Since:
           Coin 2.5

   SbVec2d::SbVec2d (const SbVec2s &v) [inline],  [explicit]
       Constructs an SbVec2d instance from an SbVec2s instance.

       Since:
           Coin 2.5

   SbVec2d::SbVec2d (const SbVec2i32 &v) [inline],  [explicit]
       Constructs an SbVec2d instance from an SbVec2i32 instance.

       Since:
           Coin 2.5

Member Function Documentation

   SbVec2d & SbVec2d::setValue (const doublev[2]) [inline]
       Set new x and y coordinates for the vector from v. Returns reference to self.

       See Also:
           getValue().

   SbVec2d & SbVec2d::setValue (doublex, doubley) [inline]
       Set new x and y coordinates for the vector. Returns reference to self.

       See Also:
           getValue().

   SbVec2d & SbVec2d::setValue (const SbVec2f &v)
       Sets the value from an SbVec2f instance. Returns reference to itself.

       Since:
           Coin 2.5

   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

   const double * SbVec2d::getValue (void) const [inline]
       Returns a pointer to an array of two double containing the x and y coordinates of the vector.

       See Also:
           setValue().

   void SbVec2d::getValue (double &x, double &y) const [inline]
       Returns the x and y coordinates of the vector.

       See Also:
           setValue().

   double & SbVec2d::operator[] (inti) [inline]
       Index operator. Returns modifiable x or y coordinate.

       See Also:
           getValue() and setValue().

   const double & SbVec2d::operator[] (inti) const [inline]
       Index operator. Returns x or y coordinate.

       See Also:
           getValue().

   SbBool SbVec2d::equals (const SbVec2d &v, doubletolerance) 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.

   double SbVec2d::dot (const SbVec2d &v) const [inline]
       Calculates and returns the result of taking the dot product of this vector and v.

   double SbVec2d::length (void) const
       Return length of vector.

   double SbVec2d::normalize (void)
       Normalize the vector to unit length. Return value is the original length of the vector before
       normalization.

   void SbVec2d::negate (void) [inline]
       Negate the vector (i.e. point it in the opposite direction).

   SbVec2d & SbVec2d::operator*= (doubled) [inline]
       Multiply components of vector with value d. Returns reference to self.

   SbVec2d & SbVec2d::operator/= (doubled) [inline]
       Divides components of vector with value d. Returns reference to self.

   SbVec2d & SbVec2d::operator+= (const SbVec2d &v) [inline]
       Adds this vector and vector u. Returns reference to self.

   SbVec2d & SbVec2d::operator-= (const SbVec2d &v) [inline]
       Subtracts vector u from this vector. Returns reference to self.

   SbVec2d SbVec2d::operator- (void) const [inline]
       Non-destructive negation operator. Returns a new SbVec2d instance which points in the opposite direction
       of this vector.

       See Also:
           negate().

   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.

   SbVec2d operator* (const SbVec2d &v, doubled) [related]
       Returns an SbVec2d instance which is the components of vector v multiplied with d.

   SbVec2d operator* (doubled, const SbVec2d &v) [related]
       Returns an SbVec2d instance which is the components of vector v multiplied with d.

   SbVec2d operator/ (const SbVec2d &v, doubled) [related]
       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) [related]
       Returns an SbVec2d instance which is the sum of vectors v1 and v2.

   SbVec2d operator- (const SbVec2d &v1, const SbVec2d &v2) [related]
       Returns an SbVec2d instance which is vector v2 subtracted from vector v1.

   int operator== (const SbVec2d &v1, const SbVec2d &v2) [related]
       Returns 1 if v1 and v2 are equal, 0 otherwise.

       See Also:
           equals().

   int operator!= (const SbVec2d &v1, const SbVec2d &v2) [related]
       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.