SYNOPSIS

Public Member Functions

SbVec3d (void)

SbVec3d (const double v[3])

SbVec3d (double x, double y, double z)

SbVec3d (const SbVec3f &v)

SbVec3d (const SbVec3b &v)

SbVec3d (const SbVec3s &v)

SbVec3d (const SbVec3i32 &v)

SbVec3d (const SbDPPlane &p0, const SbDPPlane &p1, const SbDPPlane &p2)

SbVec3d & setValue (const double v[3])

SbVec3d & setValue (double x, double y, double z)

SbVec3d & setValue (const SbVec3d &barycentric, const SbVec3d &v0, const SbVec3d &v1, const SbVec3d &v2)

SbVec3d & setValue (const SbVec3f &v)

SbVec3d & setValue (const SbVec3b &v)

SbVec3d & setValue (const SbVec3s &v)

SbVec3d & setValue (const SbVec3i32 &v)

const double * getValue (void) const

void getValue (double &x, double &y, double &z) const

double & operator[] (const int i)

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

SbVec3d cross (const SbVec3d &v) const

double dot (const SbVec3d &v) const

SbBool equals (const SbVec3d &v, double tolerance) const

SbVec3d getClosestAxis (void) const

double length (void) const

double sqrLength (void) const

void negate (void)

double normalize (void)

SbVec3d & operator*= (double d)

SbVec3d & operator/= (double d)

SbVec3d & operator+= (const SbVec3d &v)

SbVec3d & operator-= (const SbVec3d &v)

SbVec3d operator- (void) const

SbString toString () const

SbBool fromString (const SbString &str)

void print (FILE *fp) const

Related Functions

(Note that these are not member functions.) SbVec3d operator* (const SbVec3d &v, double d)

SbVec3d operator* (double d, const SbVec3d &v)

SbVec3d operator/ (const SbVec3d &v, double d)

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

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

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

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

Detailed Description

The SbVec3d class is a 3 dimensional vector with double precision floating point coordinates.

This vector class provides storage for a 3 dimensional double precision floating point vector aswell as simple floating point arithmetic operations.

See also:

SbVec2s, SbVec2f, SbVec2d, SbVec3s, SbVec3f, SbVec4f, SbVec4d.

Since:

Coin 2.0

TGS Inventor 2.6

Constructor & Destructor Documentation

SbVec3d::SbVec3d (void)\fC [inline]\fP

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

SbVec3d::SbVec3d (const doublev[3])\fC [inline]\fP

Constructs an SbVec3d instance with initial values from v.

SbVec3d::SbVec3d (doublex, doubley, doublez)\fC [inline]\fP

Constructs an SbVec3d instance with the initial vector endpoint set to <x,y,z>.

SbVec3d::SbVec3d (const \fBSbVec3f\fP &v)\fC [inline]\fP, \fC [explicit]\fP

Constructs an SbVec3d instance from an SbVec3f instance.

SbVec3d::SbVec3d (const \fBSbVec3b\fP &v)\fC [inline]\fP, \fC [explicit]\fP

Constructs an SbVec3d instance from an SbVec3b instance.

2.5

SbVec3d::SbVec3d (const \fBSbVec3s\fP &v)\fC [inline]\fP, \fC [explicit]\fP

Constructs an SbVec3d instance from an SbVec3s instance.

2.5

SbVec3d::SbVec3d (const \fBSbVec3i32\fP &v)\fC [inline]\fP, \fC [explicit]\fP

Constructs an SbVec3d instance from an SbVec3i32 instance.

2.5

SbVec3d::SbVec3d (const \fBSbDPPlane\fP &p0, const \fBSbDPPlane\fP &p1, const \fBSbDPPlane\fP &p2)

Constructs an SbVec3d instance by combining the three given planes. None of the planes should be parallel to any of the other two, otherwise a divide by zero error will occur.

Member Function Documentation

\fBSbVec3d\fP & SbVec3d::setValue (const doublev[3])\fC [inline]\fP

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

See also:

getValue().

\fBSbVec3d\fP & SbVec3d::setValue (doublex, doubley, doublez)\fC [inline]\fP

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

See also:

getValue().

\fBSbVec3d\fP & SbVec3d::setValue (const \fBSbVec3d\fP &barycentric, const \fBSbVec3d\fP &v0, const \fBSbVec3d\fP &v1, const \fBSbVec3d\fP &v2)

Set this vector to be the average of v0, v1 and v2. The vector components are weighted by the barycentric vector.

See also:

getValue().

\fBSbVec3d\fP & SbVec3d::setValue (const \fBSbVec3f\fP &v)

Sets this vector to the single precision vector v, converting the vector to a double precision vector.

\fBSbVec3d\fP & SbVec3d::setValue (const \fBSbVec3b\fP &v)

Sets this vector to the vector v.

2.5

\fBSbVec3d\fP & SbVec3d::setValue (const \fBSbVec3s\fP &v)

Sets this vector to the vector v.

2.5

\fBSbVec3d\fP & SbVec3d::setValue (const \fBSbVec3i32\fP &v)

Sets this vector to the vector v.

2.5

const double * SbVec3d::getValue (void) const\fC [inline]\fP

Returns a pointer to an array of three doubles containing the x, y and z coordinates of the vector.

See also:

setValue().

void SbVec3d::getValue (double &x, double &y, double &z) const\fC [inline]\fP

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

See also:

setValue().

double & SbVec3d::operator[] (const inti)\fC [inline]\fP

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

See also:

getValue() and setValue().

double SbVec3d::operator[] (const inti) const\fC [inline]\fP

Index operator. Returns x, y or z coordinate of vector.

See also:

getValue() and setValue().

\fBSbVec3d\fP SbVec3d::cross (const \fBSbVec3d\fP &v) const

Returns the result of taking the cross product of this vector and v.

double SbVec3d::dot (const \fBSbVec3d\fP &v) const\fC [inline]\fP

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

SbBool SbVec3d::equals (const \fBSbVec3d\fP &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.

\fBSbVec3d\fP SbVec3d::getClosestAxis (void) const

Return the vector representing the principal axis closest to this vector.

double SbVec3d::length (void) const

Return length of vector.

double SbVec3d::sqrLength (void) const\fC [inline]\fP

Returns the squared length of the vector.

void SbVec3d::negate (void)\fC [inline]\fP

Negate the vector (i.e. point it in the opposite direction).

double SbVec3d::normalize (void)

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

If the vector is the null vector, no attempt at normalization will be done.

\fBSbVec3d\fP & SbVec3d::operator*= (doubled)\fC [inline]\fP

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

\fBSbVec3d\fP & SbVec3d::operator/= (doubled)\fC [inline]\fP

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

\fBSbVec3d\fP & SbVec3d::operator+= (const \fBSbVec3d\fP &v)\fC [inline]\fP

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

\fBSbVec3d\fP & SbVec3d::operator-= (const \fBSbVec3d\fP &v)\fC [inline]\fP

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

\fBSbVec3d\fP SbVec3d::operator- (void) const\fC [inline]\fP

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

See also:

negate().

\fBSbString\fP SbVec3d::toString () const

Return a string representation of this object

SbBool SbVec3d::fromString (const \fBSbString\fP &str)

Convert from a string representation, return wether this is a valid conversion

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

\fBSbVec3d\fP operator* (const \fBSbVec3d\fP &v, doubled)\fC [related]\fP

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

\fBSbVec3d\fP operator* (doubled, const \fBSbVec3d\fP &v)\fC [related]\fP

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

\fBSbVec3d\fP operator/ (const \fBSbVec3d\fP &v, doubled)\fC [related]\fP

Returns an SbVec3d instance which is the components of vector v divided on the scalar factor d.

\fBSbVec3d\fP operator+ (const \fBSbVec3d\fP &v1, const \fBSbVec3d\fP &v2)\fC [related]\fP

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

\fBSbVec3d\fP operator- (const \fBSbVec3d\fP &v1, const \fBSbVec3d\fP &v2)\fC [related]\fP

Returns an SbVec3d instance which is vector v2 subtracted from vector v1.

int operator== (const \fBSbVec3d\fP &v1, const \fBSbVec3d\fP &v2)\fC [related]\fP

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

See also:

equals().

int operator!= (const \fBSbVec3d\fP &v1, const \fBSbVec3d\fP &v2)\fC [related]\fP

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.