SbVec2f.3coin2

Langue: en

Version: 380171 (fedora - 01/12/10)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

SbVec2f -

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

SYNOPSIS


#include <Inventor/SbLinear.h>

Public Member Functions


SbVec2f (void)

SbVec2f (const float v[2])

SbVec2f (const float x, const 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 (const float x, const float y)

SbVec2f & setValue (const SbVec2d &v)

SbVec2f & setValue (const SbVec2b &v)

SbVec2f & setValue (const SbVec2s &v)

SbVec2f & setValue (const SbVec2i32 &v)

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

float sqrLength (void) const

void negate (void)

float normalize (void)

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)

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:

SbVec2d, SbVec3f, SbVec3d, SbVec4f, SbVec4d

Constructor & Destructor Documentation

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

Referenced by operator-().

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.

SbVec2f::SbVec2f (const SbVec2d & v) [inline, explicit]Constructs an SbVec2f instance with initial values from the vector v.

Since:

Coin-2.5

SbVec2f::SbVec2f (const SbVec2b & v) [inline, explicit]Constructs an SbVec3f instance with initial values from the vector v.

Since:

Coin-2.5

SbVec2f::SbVec2f (const SbVec2s & v) [inline, explicit]Constructs an SbVec3f instance with initial values from the vector v.

Since:

Coin-2.5

SbVec2f::SbVec2f (const SbVec2i32 & v) [inline, explicit]Constructs an SbVec3f instance with initial values from the vector v.

Since:

Coin-2.5

Member Function Documentation

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().

Referenced by SbBox2f::extendBy(), SbBox2f::makeEmpty(), SbBox2f::setBounds(), SbViewportRegion::setViewport(), and SbViewportRegion::setViewportPixels().

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().

SbVec2f & SbVec2f::setValue (const SbVec2d & v)Set new 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

float SbVec2f::dot (const SbVec2f & v) constCalculates and returns the result of taking the dot product of this vector and v.

SbBool SbVec2f::equals (const SbVec2f & v, const float tolerance) constCompares 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 float * SbVec2f::getValue (void) constReturns a pointer to an array of two floats containing the x and y coordinates of the vector.

See also:

setValue().

Referenced by SbBox2f::getBounds().

void SbVec2f::getValue (float & x, float & y) constReturns the x and y coordinates of the vector.

See also:

setValue().

float SbVec2f::length (void) constReturn length of vector.

Referenced by normalize().

float SbVec2f::sqrLength (void) constReturns the square of the length of the vector.

Since:

Coin-2.5

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.

References length(), operator/=(), and SoDebugError::postWarning().

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

See also:

getValue() and setValue().

References SoDebugError::postWarning().

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

See also:

getValue().

References SoDebugError::postWarning().

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.

References SoDebugError::postWarning().

Referenced by normalize().

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) constNon-destructive negation operator. Returns a new SbVec2f instance which points in the opposite direction of this vector.

See also:

negate().

References SbVec2f().

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

Referenced by SbViewportRegion::print().

Author

Generated automatically by Doxygen for Coin from the source code.