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

SbVec3ub Class Reference
[Base classes]

The SbVec3ub class is a 3 dimensional vector with unsigned 8-bit integer coordinates. More...

#include <Inventor/SbVec3ub.h>

List of all members.

Public Member Functions

 SbVec3ub (void)
 SbVec3ub (const uint8_t v[3])
 SbVec3ub (uint8_t x, uint8_t y, uint8_t z)
 SbVec3ub (const SbVec3b &v)
 SbVec3ub (const SbVec3us &v)
 SbVec3ub (const SbVec3ui32 &v)
SbVec3ubsetValue (const uint8_t v[3])
SbVec3ubsetValue (uint8_t x, uint8_t y, uint8_t z)
SbVec3ubsetValue (const SbVec3b &v)
SbVec3ubsetValue (const SbVec3us &v)
SbVec3ubsetValue (const SbVec3ui32 &v)
const uint8_t * getValue (void) const
void getValue (uint8_t &x, uint8_t &y, uint8_t &z) const
uint8_t & operator[] (int i)
const uint8_t & operator[] (int i) const
int32_t dot (SbVec3ub v) const
void negate (void)
SbVec3uboperator*= (int d)
SbVec3uboperator*= (double d)
SbVec3uboperator/= (int d)
SbVec3uboperator/= (double d)
SbVec3uboperator+= (SbVec3ub v)
SbVec3uboperator-= (SbVec3ub v)
SbVec3ub operator- (void) const

Protected Attributes

uint8_t vec [3]


Detailed Description

The SbVec3ub class is a 3 dimensional vector with unsigned 8-bit integer coordinates.

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

See also:
SbVec2ub, SbVec4ub, SbVec3b, SbVec3s, SbVec3us, SbVec3i32, SbVec3ui32
Since:
Coin-2.5

Constructor & Destructor Documentation

SbVec3ub::SbVec3ub ( void   )  [inline]

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

SbVec3ub::SbVec3ub ( const uint8_t  v[3]  )  [inline]

Constructs an SbVec3ub instance with initial values from v.

SbVec3ub::SbVec3ub ( uint8_t  x,
uint8_t  y,
uint8_t  z 
) [inline]

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

SbVec3ub::SbVec3ub ( const SbVec3b v  )  [inline, explicit]

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

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

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

SbVec3ub::SbVec3ub ( const SbVec3ui32 v  )  [inline, explicit]

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


Member Function Documentation

SbVec3ub & SbVec3ub::setValue ( const uint8_t  v[3]  )  [inline]

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

See also:
getValue()

SbVec3ub & SbVec3ub::setValue ( uint8_t  x,
uint8_t  y,
uint8_t  z 
) [inline]

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

See also:
getValue()

SbVec3ub & SbVec3ub::setValue ( const SbVec3b v  ) 

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

SbVec3ub & SbVec3ub::setValue ( const SbVec3us v  ) 

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

SbVec3ub & SbVec3ub::setValue ( const SbVec3ui32 v  ) 

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

const uint8_t * SbVec3ub::getValue ( void   )  const [inline]

Returns a pointer to an array of three unsigned 8-bit integers containing the x and y coordinates of the vector.

See also:
setValue()

void SbVec3ub::getValue ( uint8_t &  x,
uint8_t &  y,
uint8_t &  z 
) const [inline]

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

See also:
setValue()

uint8_t & SbVec3ub::operator[] ( int  i  )  [inline]

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

See also:
getValue() and setValue()

const uint8_t & SbVec3ub::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 SbVec3ub::dot ( SbVec3ub  v  )  const [inline]

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

void SbVec3ub::negate ( void   ) 

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

Referenced by operator-().

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

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

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

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

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

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

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

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

SbVec3ub & SbVec3ub::operator+= ( SbVec3ub  v  )  [inline]

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

SbVec3ub & SbVec3ub::operator-= ( SbVec3ub  v  )  [inline]

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

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

Non-destructive negation operator. Returns a new SbVec3ub 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 Mon Feb 23 16:33:42 2009 for Coin by Doxygen. 1.5.8