sbvec2us(3)
NAME
SbVec2us
SYNOPSIS
#include <Inventor/SbVec2us.h>
Detailed Description
The SbVec2us class is a 2 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:
- SbVec3us, SbVec4us, SbVec2b, SbVec2ub, SbVec2s, SbVec2i32, SbVec2ui32
- Since:
- Coin-2.5
- Public Member Functions
- SbVec2us (void)
SbVec2us (const unsigned short v[2])
SbVec2us (unsigned short x, unsigned short y)
SbVec2us (const SbVec2s &v)
SbVec2us (const SbVec2ub &v)
SbVec2us (const SbVec2ui32 &v)
SbVec2us & setValue (const unsigned short v[2]) SbVec2us & setValue (unsigned short x, unsigned short y) SbVec2us & setValue (const SbVec2s &v) SbVec2us & setValue (const SbVec2ub &v) SbVec2us & setValue (const SbVec2ui32 &v) const unsigned short * getValue (void) const
void getValue (unsigned short &x, unsigned short &y) const unsigned short & operator[] (int i)
const unsigned short & operator[] (int i) const
int32_t dot (SbVec2us v) const
void negate (void)
SbVec2us & operator*= (int d)
SbVec2us & operator*= (double d)
SbVec2us & operator/= (int d)
SbVec2us & operator/= (double d)
SbVec2us & operator+= (SbVec2us v) SbVec2us & operator-= (SbVec2us v) SbVec2us operator- (void) const - Protected Attributes
- unsigned short vec [2]
Constructor & Destructor Documentation
- SbVec2us::SbVec2us (void) [inline]
- The default constructor does nothing. The vector coordinates will be
uninitialized until you do a setValue(). - SbVec2us::SbVec2us (const unsigned short v[2]) [inline]
- Constructs an SbVec2us instance with initial values from v.
- SbVec2us::SbVec2us (unsigned short x, unsigned short y) [inline]
- Constructs an SbVec2us instance with the initial vector endpoint set to <x,y>.
- SbVec2us::SbVec2us (const SbVec2s & v) [inline, explicit]
- Constructs an SbVec2us instance with initial values from the short integer precision vector v.
- SbVec2us::SbVec2us (const SbVec2ub & v) [inline, explicit]
- Constructs an SbVec2us instance with initial values from the unsigned 8-bit vector v.
- SbVec2us::SbVec2us (const SbVec2ui32 & v) [inline, explicit]
- Constructs an SbVec2us instance with initial values from the unsigned 32-bit integer precision vector v.
Member Function Documentation
- SbVec2us & SbVec2us::setValue (const unsigned short v[2]) [inline]
- Set new coordinates for the vector from v. Returns reference to self.
- See also:
getValue()
- SbVec2us & SbVec2us::setValue (unsigned short x, unsigned short y) [inline]
- Set new coordinates for the vector. Returns reference to self.
- See also:
getValue()
- SbVec2us & SbVec2us::setValue (const SbVec2s & v)
- Sets this vector to the short integer precision vector v, converting the vector to an unsigned short integer precision vector.
- SbVec2us & SbVec2us::setValue (const SbVec2ub & v)
- Sets this vector to the unsigned 8-bit integer precision vector v,
converting the vector to an unsigned short integer precision vector. - SbVec2us & SbVec2us::setValue (const SbVec2ui32 & 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 * SbVec2us::getValue (void) const [inline]
- Returns a pointer to an array of two unsigned short integers containing the x and y coordinates of the vector.
- See also:
setValue()
- void SbVec2us::getValue (unsigned short & x, unsigned short & y) const
- [inline]
Returns the x and y coordinates of the vector. - See also:
setValue()
- unsigned short & SbVec2us::operator[] (int i) [inline]
- Index operator. Returns modifiable x or y coordinate of the vector.
- See also:
getValue() and setValue()
- const unsigned short & SbVec2us::operator[] (int i) const [inline]
- Index operator. Returns non-modifiable x or y coordinate of the vector.
- See also:
getValue() and setValue()
- int32_t SbVec2us::dot (SbVec2us v) const [inline]
- Calculates and returns the result of taking the dot product of this
vector and v. - void SbVec2us::negate (void)
- Negate the vector (i.e. point it in the opposite direction)
- Referenced by operator-().
- SbVec2us & SbVec2us::operator*= (int d) [inline]
- Multiply components of vector with scalar value d. Returns reference to self.
- SbVec2us & SbVec2us::operator*= (double d)
- Multiply components of vector with scalar value d. Returns reference to self.
- SbVec2us & SbVec2us::operator/= (int d) [inline]
- Divides components of vector with scalar value d. Returns reference to self.
- SbVec2us & SbVec2us::operator/= (double d) [inline]
- Divides components of vector with double precision floating point value d. Returns reference to self.
- SbVec2us & SbVec2us::operator+= (SbVec2us v) [inline]
- Adds this vector and vector u. Returns reference to self.
- SbVec2us & SbVec2us::operator-= (SbVec2us v) [inline]
- Subtracts vector u from this vector. Returns reference to self.
- SbVec2us SbVec2us::operator- (void) const [inline]
- Non-destructive negation operator. Returns a new SbVec2us 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.