man SbVec4f (Fonctions bibliothèques) -

NAME

SbVec4f -

SYNOPSIS

#include <Inventor/SbLinear.h>

Detailed Description

The SbVec4f class is a 4 dimensional vector with floating point coordinates.

This vector class is used by many other classes in Coin. It provides storage for a 3 dimensional homogeneoues vector (with the 4 components usually referred to as <x, y, z, w>) aswell as simple floating point arithmetic operations.

See also: SbVec2f, SbVec2s, SbVec3f, SbVec3s.

Public Member Functions

SbVec4f (void)

SbVec4f (const float v[4])

SbVec4f (const float x, const float y, const float z, const float w)

float dot (const SbVec4f &v) const

SbBool equals (const SbVec4f &v, const float tolerance) const

void getReal (SbVec3f &v) const

const float * getValue (void) const

void getValue (float &x, float &y, float &z, float &w) const

float length (void) const

void negate (void)

float normalize (void)

SbVec4f & setValue (const float v[4])

SbVec4f & setValue (const float x, const float y, const float z, const float w)

float & operator[] (const int i)

const float & operator[] (const int i) const

SbVec4f & operator *= (const float d)

SbVec4f & operator/= (const float d)

SbVec4f & operator+= (const SbVec4f &u)

SbVec4f & operator-= (const SbVec4f &u)

SbVec4f operator- (void) const

void print (FILE *fp) const

Friends

SbVec4f operator * (const SbVec4f &v, const float d)

SbVec4f operator * (const float d, const SbVec4f &v)

SbVec4f operator/ (const SbVec4f &v, const float d)

SbVec4f operator+ (const SbVec4f &v1, const SbVec4f &v2)

SbVec4f operator- (const SbVec4f &v1, const SbVec4f &v2)

int operator== (const SbVec4f &v1, const SbVec4f &v2)

int operator!= (const SbVec4f &v1, const SbVec4f &v2)

Constructor & Destructor Documentation

SbVec4f::SbVec4f (void)

The default constructor does nothing. The vector coordinates will be uninitialized until a call the setValue().

SbVec4f::SbVec4f (const float v[4])

Constructs an SbVec4f instance with initial values from v.

SbVec4f::SbVec4f (const float x, const float y, const float z, const float w)

Constructs an SbVec4f instance with the initial homogeneous vector set to <x,y,z,w>.

Member Function Documentation

float SbVec4f::dot (const SbVec4f & v) const

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

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

The comparison is done in 4D-space, i.e. the w component of the vector is not used to make x, y and z into Cartesian coordinates first.

void SbVec4f::getReal (SbVec3f & v) const

Returns the vector as a Cartesian 3D vector in v. This means that the 3 first components x, y and z will be divided by the fourth, w.

const float * SbVec4f::getValue (void) const

Returns a pointer to an array of four floats containing the x, y, z and w coordinates of the vector.

See also: setValue().

void SbVec4f::getValue (float & x, float & y, float & z, float & w) const

Returns the x, y, z and w coordinates of the vector.

See also: setValue().

float SbVec4f::length (void) const

Return the length of the vector in 4D space.

void SbVec4f::negate (void)

Negate the vector.

float SbVec4f::normalize (void)

Normalize the vector to unit length. Return value is the original length of the vector before normalization.

SbVec4f & SbVec4f::setValue (const float v[4])

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

See also: getValue().

SbVec4f & SbVec4f::setValue (const float x, const float y, const float z, const float w)

Set new coordinates for the vector. Returns reference to self.

See also: getValue().

float & SbVec4f::operator[] (const int i)

Index operator. Returns modifiable x, y, z or w component of vector.

See also: getValue() and setValue().

const float & SbVec4f::operator[] (const int i) const

Index operator. Returns x, y, z or w component of vector.

See also: getValue() and setValue().

SbVec4f & SbVec4f::operator *= (const float d)

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

SbVec4f & SbVec4f::operator/= (const float d)

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

SbVec4f & SbVec4f::operator+= (const SbVec4f & u)

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

SbVec4f & SbVec4f::operator-= (const SbVec4f & u)

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

SbVec4f SbVec4f::operator- (void) const

Non-destructive negation operator. Returns a new SbVec4f instance which has all components negated.

See also: negate().

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

SbVec4f operator * (const SbVec4f & v, const float d) [friend]

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

SbVec4f operator * (const float d, const SbVec4f & v) [friend]