sbvec3us(3)

NAME

SbVec3us

SYNOPSIS

#include <Inventor/SbVec3us.h>

Detailed Description

The SbVec3us class is a 3 dimensional vector with unsigned short integer coordinates.

This vector provides storage for a vector in 2 dimensions as well as
simple integer arithmetic operations.

See also:

SbVec2us, SbVec4us, SbVec3b, SbVec3ub, SbVec3s, SbVec3i32, SbVec3ui32

Since:

Coin-2.5

Public Member Functions

SbVec3us (void)
SbVec3us (const unsigned short v[3])
SbVec3us (unsigned short x, unsigned short y, unsigned short z) SbVec3us (const SbVec3s &v)
SbVec3us (const SbVec3ub &v)
SbVec3us (const SbVec3ui32 &v)
SbVec3us & setValue (const unsigned short v[3]) SbVec3us & setValue (unsigned short x, unsigned short y, unsigned short

z)

SbVec3us & setValue (const SbVec3s &v) SbVec3us & setValue (const SbVec3ub &v) SbVec3us & setValue (const SbVec3ui32 &v) const unsigned short * getValue (void) const
void getValue (unsigned short &x, unsigned short &y, unsigned short &z)

const

unsigned short & operator[] (int i)
const unsigned short & operator[] (int i) const
int32_t dot (const SbVec3us &v) const
void negate (void)
SbVec3us & operator*= (int d)
SbVec3us & operator*= (double d)
SbVec3us & operator/= (int d)
SbVec3us & operator/= (double d)
SbVec3us & operator+= (const SbVec3us &v) SbVec3us & operator-= (const SbVec3us &v) SbVec3us operator- (void) const

Protected Attributes

unsigned short vec [3]

Constructor & Destructor Documentation

SbVec3us::SbVec3us (void) [inline]

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

SbVec3us::SbVec3us (const unsigned short v[3]) [inline]

Constructs an SbVec3us instance with initial values from v.

SbVec3us::SbVec3us (unsigned short x, unsigned short y, unsigned short x)

[inline]
Constructs an SbVec3us instance with the initial vector endpoint set to <x, y, z>.

SbVec3us::SbVec3us (const SbVec3s & v) [inline, explicit]

Constructs an SbVec3us instance with initial values from the short integer precision vector v.

SbVec3us::SbVec3us (const SbVec3ub & v) [inline, explicit]

Constructs an SbVec3us instance with initial values from the unsigned 8-bit vector v.

SbVec3us::SbVec3us (const SbVec3ui32 & v) [inline, explicit]

Constructs an SbVec3us instance with initial values from the unsigned 32-bit integer precision vector v.

Member Function Documentation

SbVec3us & SbVec3us::setValue (const unsigned short v[3]) [inline]

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

See also:

getValue()

SbVec3us & SbVec3us::setValue (unsigned short x, unsigned short y, unsigned

short z) [inline]
Set new coordinates for the vector. Returns reference to self.

See also:

getValue()

SbVec3us & SbVec3us::setValue (const SbVec3s & v)

Sets this vector to the short integer precision vector v, converting the vector to an unsigned short integer precision vector.

SbVec3us & SbVec3us::setValue (const SbVec3ub & v)

Sets this vector to the unsigned 8-bit integer precision vector v,
converting the vector to an unsigned short integer precision vector.

SbVec3us & SbVec3us::setValue (const SbVec3ui32 & v)

Sets this vector to the unsigned 32-bit integer precision vector v,
converting the vector to an unsigned short integer precision vector.

const unsigned short * SbVec3us::getValue (void) const [inline]

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

See also:

setValue()

void SbVec3us::getValue (unsigned short & x, unsigned short & y, unsigned

short & z) const [inline]
Returns the x, y and z coordinates of the vector.

See also:

setValue()

unsigned short & SbVec3us::operator[] (int i) [inline]

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

See also:

getValue() and setValue()

const unsigned short & SbVec3us::operator[] (int i) const [inline]

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

See also:

getValue() and setValue()

int32_t SbVec3us::dot (const SbVec3us & v) const [inline]

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

void SbVec3us::negate (void)

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

Referenced by operator-().

SbVec3us & SbVec3us::operator*= (int d) [inline]

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

SbVec3us & SbVec3us::operator*= (double d)

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

SbVec3us & SbVec3us::operator/= (int d) [inline]

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

SbVec3us & SbVec3us::operator/= (double d) [inline]

Divides components of vector with double precision floating point value d. Returns reference to self.

SbVec3us & SbVec3us::operator+= (const SbVec3us & v) [inline]

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

SbVec3us & SbVec3us::operator-= (const SbVec3us & v) [inline]

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

SbVec3us SbVec3us::operator- (void) const [inline]

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

See also:

negate()

References negate().

Author

Generated automatically by Doxygen for Coin from the source code.

Version 2.5.0 28 Jun 2008 SbVec3us(3)