# SbVec2f Class Reference
[Base classes]

`#include <Inventor/SbLinear.h>`

List of all members.

## 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 aswell as simple floating point arithmetic operations on this vector.

See also:
  SbVec2s, SbVec3s, SbVec3f, SbVec4f

## Public Member Functions

| SbVec2f (void)
| SbVec2f (const float v[2])
| SbVec2f (const float x, const float y)
float | dot (const SbVec2f &v) const
SbBool | equals (const SbVec2f &v, const float tolerance) const
const float * | getValue (void) const
void | getValue (float &x, float &y) const
float | length (void) const
void | negate (void)
float | normalize (void)
SbVec2f & | setValue (const float v[2])
SbVec2f & | setValue (const float x, const float y)
float & | operator[] (const int i)
const float & | operator[] (const int i) const
SbVec2f & | operator *= (const float d)
SbVec2f & | operator/= (const float d)
SbVec2f & | operator+= (const SbVec2f &u)
SbVec2f & | operator-= (const SbVec2f &u)
SbVec2f | operator- (void) const
void | print (FILE *fp) const

## Friends

SbVec2f | operator * (const SbVec2f &v, const float d)
SbVec2f | operator * (const float d, const SbVec2f &v)
SbVec2f | operator/ (const SbVec2f &v, const 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)

## Constructor & Destructor Documentation

SbVec2f::SbVec2f | ( | void |  | ) |

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

SbVec2f::SbVec2f | ( | const float | v[2] | ) |

| Constructs an SbVec2f instance with initial values from v.

SbVec2f::SbVec2f | ( | const float | x,
|  | const float | y
| ) |

| Constructs an SbVec2f instance with the initial vector endpoints from x and y.

## Member Function Documentation

float SbVec2f::dot | ( | const SbVec2f & | v | ) | const

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

SbBool SbVec2f::equals | ( | const SbVec2f & | v,
|  | const float | tolerance
| ) | const

| Compares the vector with v and returns TRUE if the largest distance between the vectors are larger than the square root of the given tolerance value.

const float * SbVec2f::getValue | ( | void |  | ) | const

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

Returns the x and y coordinates of the vector.

See also:
  setValue().

float SbVec2f::length | ( | void |  | ) | const

| Return length of vector.

void SbVec2f::negate | ( | void |  | ) |

| 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::setValue | ( | const float | v[2] | ) |

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

See also:
  getValue().

SbVec2f & SbVec2f::setValue | ( | const float | x,
|  | const float | y
| ) |

Set new x and y coordinates for the vector. Returns reference to self.

See also:
  getValue().

float & SbVec2f::operator[] | ( | const int | i | ) |

Index operator. Returns modifiable x or y coordinate.

See also:
  getValue() and setValue().

const float & SbVec2f::operator[] | ( | const int | i | ) | const

Index operator. Returns x or y coordinate.

See also:
  getValue().

SbVec2f & SbVec2f::operator *= | ( | const float | d | ) |

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

SbVec2f & SbVec2f::operator/= | ( | const float | d | ) |

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

SbVec2f & SbVec2f::operator+= | ( | const SbVec2f & | u | ) |

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

SbVec2f & SbVec2f::operator-= | ( | const SbVec2f & | u | ) |

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

SbVec2f SbVec2f::operator- | ( | void |  | ) | const

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

See also:
  negate().

void SbVec2f::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

SbVec2f operator * | ( | const SbVec2f & | v,
|  | const float | d
| ) | `[friend]`

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

SbVec2f operator * | ( | const float | d,
|  | const SbVec2f & | v
| ) | `[friend]`

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

SbVec2f operator/ | ( | const SbVec2f & | v,
|  | const float | d
| ) | `[friend]`

| 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
| ) | `[friend]`

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

SbVec2f operator- | ( | const SbVec2f & | v1,
|  | const SbVec2f & | v2
| ) | `[friend]`

| Returns an SbVec2f instance which is vector v2 subtracted from vector v1.

int operator== | ( | const SbVec2f & | v1,
|  | const SbVec2f & | v2
| ) | `[friend]`

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

See also:
  equals().

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

- SbVec2f.h
- SbVec2f.cpp