Coin Logo http://www.sim.no
http://www.coin3d.org

Public Member Functions | Protected Attributes | List of all members
SbVec3us Class Reference

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

#include <Inventor/SbVec3us.h>

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)
 
SbVec3ussetValue (const unsigned short v[3])
 
SbVec3ussetValue (unsigned short x, unsigned short y, unsigned short z)
 
SbVec3ussetValue (const SbVec3s &v)
 
SbVec3ussetValue (const SbVec3ub &v)
 
SbVec3ussetValue (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)
 
SbVec3usoperator*= (int d)
 
SbVec3usoperator*= (double d)
 
SbVec3usoperator/= (int d)
 
SbVec3usoperator/= (double d)
 
SbVec3usoperator+= (const SbVec3us &v)
 
SbVec3usoperator-= (const SbVec3us &v)
 
SbVec3us operator- (void) const
 

Protected Attributes

unsigned short vec [3]
 

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

Constructor & Destructor Documentation

◆ SbVec3us() [1/6]

SbVec3us::SbVec3us ( void  )
inline

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

◆ SbVec3us() [2/6]

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

Constructs an SbVec3us instance with initial values from v.

◆ SbVec3us() [3/6]

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() [4/6]

SbVec3us::SbVec3us ( const SbVec3s v)
inlineexplicit

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

◆ SbVec3us() [5/6]

SbVec3us::SbVec3us ( const SbVec3ub v)
inlineexplicit

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

◆ SbVec3us() [6/6]

SbVec3us::SbVec3us ( const SbVec3ui32 v)
inlineexplicit

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

Member Function Documentation

◆ setValue() [1/5]

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

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

See also
getValue()

◆ setValue() [2/5]

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

◆ setValue() [3/5]

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.

◆ setValue() [4/5]

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.

◆ setValue() [5/5]

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.

◆ getValue() [1/2]

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

◆ getValue() [2/2]

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

◆ operator[]() [1/2]

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

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

See also
getValue() and setValue()

◆ operator[]() [2/2]

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

◆ dot()

int32_t SbVec3us::dot ( const SbVec3us v) const
inline

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

◆ negate()

void SbVec3us::negate ( void  )

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

Referenced by operator-().

◆ operator*=() [1/2]

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

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

◆ operator*=() [2/2]

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

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

◆ operator/=() [1/2]

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

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

◆ operator/=() [2/2]

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

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

◆ operator+=()

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

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

◆ operator-=()

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

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

◆ operator-()

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


The documentation for this class was generated from the following files:

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Fri Jul 20 2018 for Coin by Doxygen. 1.8.14