sbvec4ub(3)
NAME
SbVec4ub
SYNOPSIS
#include <Inventor/SbVec4ub.h>
Detailed Description
The SbVec4ub class is a 4 dimensional vector with unsigned 8-bit
integer coordinates.
This vector class provides storage for a 3 dimensional homogeneoues
vector (with the 4 components usually referred to as <x, y, z, w>)
aswell as simple integer precision arithmetic operations.
- See also:
- SbVec2ub, SbVec3ub, SbVec4b, SbVec4s, SbVec4us, SbVec4i32, SbVec4ui32
- Since:
- Coin-2.5
- Public Member Functions
- SbVec4ub (void)
SbVec4ub (const uint8_t v[4])
SbVec4ub (uint8_t x, uint8_t y, uint8_t z, uint8_t w)
SbVec4ub (const SbVec4b &v)
SbVec4ub (const SbVec4us &v)
SbVec4ub (const SbVec4ui32 &v)
SbVec4ub & setValue (const uint8_t v[4]) SbVec4ub & setValue (uint8_t x, uint8_t y, uint8_t z, uint8_t w) SbVec4ub & setValue (const SbVec4b &v) SbVec4ub & setValue (const SbVec4us &v) SbVec4ub & setValue (const SbVec4ui32 &v) const uint8_t * getValue (void) const
void getValue (uint8_t &x, uint8_t &y, uint8_t &z, uint8_t &w) const uint8_t & operator[] (int i)
const uint8_t & operator[] (int i) const
int32_t dot (SbVec4ub v) const
void negate (void)
SbVec4ub & operator*= (int d)
SbVec4ub & operator*= (double d)
SbVec4ub & operator/= (int d)
SbVec4ub & operator/= (double d)
SbVec4ub & operator+= (SbVec4ub v) SbVec4ub & operator-= (SbVec4ub v) SbVec4ub operator- (void) const - Protected Attributes
- uint8_t vec [4]
Constructor & Destructor Documentation
- SbVec4ub::SbVec4ub (void) [inline]
- The default constructor does nothing. The vector coordinates will be
uninitialized until a call the setValue(). - SbVec4ub::SbVec4ub (const uint8_t v[4]) [inline]
- Constructs an SbVec4ub instance with initial values from v.
- SbVec4ub::SbVec4ub (uint8_t x, uint8_t y, uint8_t z, uint8_t w) [inline]
- Constructs an SbVec4ub instance with the initial homogeneous vector set to <x,y,z,w>.
- SbVec4ub::SbVec4ub (const SbVec4b & v) [inline, explicit]
- Constructs an SbVec4ub instance with initial values from the 8-bit integer precision vector v.
- SbVec4ub::SbVec4ub (const SbVec4us & v) [inline, explicit]
- Constructs an SbVec4ub instance with initial values from the unsigned short integer precision vector v.
- SbVec4ub::SbVec4ub (const SbVec4ui32 & v) [inline, explicit]
- Constructs an SbVec4ub instance with initial values from the unsigned 32-bit integer precision vector v.
Member Function Documentation
- SbVec4ub & SbVec4ub::setValue (const uint8_t v[4]) [inline]
- Set new coordinates for the vector from v. Returns reference to self.
- See also:
getValue()
- SbVec4ub & SbVec4ub::setValue (uint8_t x, uint8_t y, uint8_t z, uint8_t w)
- [inline]
Set new coordinates for the vector. Returns reference to self. - See also:
getValue()
- SbVec4ub & SbVec4ub::setValue (const SbVec4b & v)
- Sets this vector to the 8-bit integer precision vector v, converting the vector to a unsigned 8-bit integer precision vector.
- SbVec4ub & SbVec4ub::setValue (const SbVec4us & v)
- Sets this vector to the unsigned short integer precision vector v,
converting the vector to a unsigned 8-bit integer precision vector. - SbVec4ub & SbVec4ub::setValue (const SbVec4ui32 & v)
- Sets this vector to the unsigned 32-bit integer precision vector v,
converting the vector to a unsigned 8-bit integer precision vector. - const uint8_t * SbVec4ub::getValue (void) const [inline]
- Returns a pointer to an array of four uint8_t integers containing the
x, y, z and w coordinates of the vector. - See also:
setValue()
- void SbVec4ub::getValue (uint8_t & x, uint8_t & y, uint8_t & z, uint8_t &
- w) const [inline]
Returns the x, y, z and w coordinates of the vector. - uint8_t & SbVec4ub::operator[] (int i) [inline]
- Index operator. Returns modifiable x, y, z or w coordinate of the
vector. - const uint8_t & SbVec4ub::operator[] (int i) const [inline]
- Index operator. Returns non-modifiable x, y, z or w coordinate of the
vector. - int32_t SbVec4ub::dot (SbVec4ub v) const [inline]
- Calculates and returns the result of taking the dot product of this
vector and v. - void SbVec4ub::negate (void)
- Negate the vector (i.e. point it in the opposite direction)
- Referenced by operator-().
- SbVec4ub & SbVec4ub::operator*= (int d) [inline]
- Multiply components of vector with scalar value d. Returns reference to self.
- SbVec4ub & SbVec4ub::operator*= (double d)
- Multiply components of vector with value d. Returns reference to self.
- SbVec4ub & SbVec4ub::operator/= (int d) [inline]
- Divides components of vector with scalar value d. Returns reference to self.
- SbVec4ub & SbVec4ub::operator/= (double d) [inline]
- Divides components of vector with scalar value d. Returns reference to self.
- SbVec4ub & SbVec4ub::operator+= (SbVec4ub v) [inline]
- Adds this vector and vector u. Returns reference to self.
- SbVec4ub & SbVec4ub::operator-= (SbVec4ub v) [inline]
- Subtracts v from this vector. Returns reference to self.
- SbVec4ub SbVec4ub::operator- (void) const [inline]
- Non-destructive negation operator. Returns a new SbVec4ub 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.