SbVec2ub

Langue: en

Autres versions - même langue

Version: 321944 (ubuntu - 08/07/09)

Section: 3 (Bibliothèques de fonctions)

NAME

SbVec2ub -

SYNOPSIS


#include <Inventor/SbVec2ub.h>

Detailed Description

The SbVec2ub class is a 2 dimensional vector with unsigned 8-bit integer coordinates.

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

See also:

SbVec3ub, SbVec4ub, SbVec2b, SbVec2s, SbVec2us, SbVec2i32, SbVec2ui32

Since:

Coin-2.5

Public Member Functions


SbVec2ub (void)

SbVec2ub (const uint8_t v[2])

SbVec2ub (uint8_t x, uint8_t y)

SbVec2ub (const SbVec2b &v)

SbVec2ub (const SbVec2us &v)

SbVec2ub (const SbVec2ui32 &v)

SbVec2ub & setValue (const uint8_t v[2])

SbVec2ub & setValue (uint8_t x, uint8_t y)

SbVec2ub & setValue (const SbVec2b &v)

SbVec2ub & setValue (const SbVec2us &v)

SbVec2ub & setValue (const SbVec2ui32 &v)

const uint8_t * getValue (void) const

void getValue (uint8_t &x, uint8_t &y) const

uint8_t & operator[] (int i)

const uint8_t & operator[] (int i) const

int32_t dot (SbVec2ub v) const

void negate (void)

SbVec2ub & operator*= (int d)

SbVec2ub & operator*= (double d)

SbVec2ub & operator/= (int d)

SbVec2ub & operator/= (double d)

SbVec2ub & operator+= (SbVec2ub v)

SbVec2ub & operator-= (SbVec2ub v)

SbVec2ub operator- (void) const

Protected Attributes


uint8_t vec [2]

Constructor & Destructor Documentation

SbVec2ub::SbVec2ub (void) [inline]

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

SbVec2ub::SbVec2ub (const uint8_t v[2]) [inline]

Constructs an SbVec2ub instance with initial values from v.

SbVec2ub::SbVec2ub (uint8_t x, uint8_t y) [inline]

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

SbVec2ub::SbVec2ub (const SbVec2b & v) [inline, explicit]

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

SbVec2ub::SbVec2ub (const SbVec2us & v) [inline, explicit]

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

SbVec2ub::SbVec2ub (const SbVec2ui32 & v) [inline, explicit]

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

Member Function Documentation

SbVec2ub & SbVec2ub::setValue (const uint8_t v[2]) [inline]

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

See also:

getValue()

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

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

See also:

getValue()

SbVec2ub & SbVec2ub::setValue (const SbVec2b & v)

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

SbVec2ub & SbVec2ub::setValue (const SbVec2us & v)

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

SbVec2ub & SbVec2ub::setValue (const SbVec2ui32 & 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 * SbVec2ub::getValue (void) const [inline]

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

See also:

setValue()

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

Returns the x and y coordinates of the vector.

See also:

setValue()

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

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

See also:

getValue() and setValue()

const uint8_t & SbVec2ub::operator[] (int i) const [inline]

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

See also:

getValue() and setValue()

int32_t SbVec2ub::dot (SbVec2ub v) const [inline]

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

void SbVec2ub::negate (void)

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

Referenced by operator-().

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

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

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

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

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

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

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

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

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

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

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

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

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

Non-destructive negation operator. Returns a new SbVec3f 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.