SbVec2f(3)

NAME
SbVec2f - The SbVec2f class is a 2 dimensional vector with floating point coordinates.

SYNOPSIS

#include <Inventor/SbVec2f.h>

  Public Member Functions
SbVec2f (void)
SbVec2f (const float v[2])
SbVec2f (float x, float y)
SbVec2f (const SbVec2d &v)
SbVec2f (const SbVec2b &v)
SbVec2f (const SbVec2s &v)
SbVec2f (const SbVec2i32 &v)
SbVec2f & setValue (const float v[2])
SbVec2f & setValue (float x, float y)
SbVec2f & setValue (const SbVec2d &v)
SbVec2f & setValue (const SbVec2b &v)
SbVec2f & setValue (const SbVec2s &v)
SbVec2f & setValue (const SbVec2i32 &v)
const float * getValue (void) const
void getValue (float &x, float &y) const
float & operator[] (int i)
const float & operator[] (int i) const
float dot (const SbVec2f &v) const
SbBool equals (const SbVec2f &v, float tolerance) const
float length (void) const
float sqrLength (void) const
void negate (void)
float normalize (void)
SbVec2f & operator*= (float d)
SbVec2f & operator/= (float d)
SbVec2f & operator+= (const SbVec2f &v)
SbVec2f & operator-= (const SbVec2f &v)
SbVec2f operator- (void) const
SbString toString () const
SbBool fromString (const SbString &str)
void print (FILE *fp) const

  Protected Attributes
float vec [2]

  Related Symbols
(Note that these are not member symbols.)
SbVec2f operator* (const SbVec2f &v, float d)
SbVec2f operator* (float d, const SbVec2f &v)
SbVec2f operator/ (const SbVec2f &v, float d)
SbVec2f operator+ (const SbVec2f &v1, const SbVec2f &v2)
SbVec2f operator- (const SbVec2f &v1, const SbVec2f &v2)
int operator== (const SbVec2f &v1, const SbVec2f &v2)
int operator!= (const SbVec2f &v1, const SbVec2f &v2)

Detailed Description

The SbVec2f class is a 2 dimensional vector with floating point coordinates. This vector class is used by many other classes in Coin. It provides storage for a vector in 2 dimensions as well as simple floating point arithmetic operations on this vector.

See also
    SbVec2s, SbVec2d, SbVec3s, SbVec3f, SbVec3d, SbVec4f, SbVec4d.

Constructor & Destructor Documentation

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

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

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

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

Since
    Coin 2.5

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

Since
    Coin 2.5

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

Since
    Coin 2.5

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

Since
    Coin 2.5

Member Function Documentation

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

See also
    getValue().

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

See also
    getValue().

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

Since
    Coin 2.5

  SbVec2f & SbVec2f::setValue (const SbVec2b & v)
Sets the value from an SbVec2b instance.

Since
    Coin 2.5

  SbVec2f & SbVec2f::setValue (const SbVec2s & v)
Sets the value from an SbVec2s instance.

Since
    Coin 2.5

  SbVec2f & SbVec2f::setValue (const SbVec2i32 & v)
Sets the value from an SbVec2i32 instance.

Since
    Coin 2.5

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

See also
    setValue().

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

See also
    setValue().

  float & SbVec2f::operator[] (int i) [inline]
Index operator. Returns modifiable x or y coordinate.

See also
    getValue() and setValue().

  const float & SbVec2f::operator[] (int i) const [inline]
Index operator. Returns x or y coordinate.

See also
    getValue().

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

  SbBool SbVec2f::equals (const SbVec2f & v, float 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.

  float SbVec2f::length (void ) const
Return length of vector.

  float SbVec2f::sqrLength (void ) const [inline]
Returns the square of the length of the vector.

Since
    Coin 2.5

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

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

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

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

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

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

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

See also
    negate().

  SbString SbVec2f::toString () const
Return a string representation of this object

  SbBool SbVec2f::fromString (const SbString & str)
Convert from a string representation, return whether this is a valid conversion

  void SbVec2f::print (FILE * fp) const
Dump the state of this object to the fp file stream. Only works in debug version of library, method does nothing in an optimized build.

Friends And Related Symbol Documentation

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

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

  SbVec2f operator/ (const SbVec2f & v, float d) [related]
Returns an SbVec2f instance which is the components of vector v divided on the scalar factor d.

  SbVec2f operator+ (const SbVec2f & v1, const SbVec2f & v2) [related]
Returns an SbVec2f instance which is the sum of vectors v1 and v2.

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

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

See also
    equals().

  int operator!= (const SbVec2f & v1, const SbVec2f & 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.