osg::Vec2ub Class Reference

General purpose unsigned byte pair. More...

List of all members.

Public Types
enum	{ num_components = 2 }
	Number of vector components. More...
typedef unsigned char	value_type
	Data type of vector components.
Public Member Functions
	Vec2ub ()
	Constructor that sets all components of the vector to zero.
	Vec2ub (value_type r, value_type g)
bool	operator== (const Vec2ub &v) const
bool	operator!= (const Vec2ub &v) const
bool	operator< (const Vec2ub &v) const
value_type *	ptr ()
const value_type *	ptr () const
void	set (value_type x, value_type y)
void	set (const Vec2ub &rhs)
value_type &	operator[] (int i)
value_type	operator[] (int i) const
value_type &	x ()
value_type &	y ()
value_type	x () const
value_type	y () const
value_type &	r ()
value_type &	g ()
value_type	r () const
value_type	g () const
Vec2ub	operator* (float rhs) const
	Multiply by scalar.
Vec2ub &	operator*= (float rhs)
	Unary multiply by scalar.
Vec2ub	operator/ (float rhs) const
	Divide by scalar.
Vec2ub &	operator/= (float rhs)
	Unary divide by scalar.
Vec2ub	operator+ (const Vec2ub &rhs) const
	Binary vector add.
Vec2ub &	operator+= (const Vec2ub &rhs)
	Unary vector add.
Vec2ub	operator- (const Vec2ub &rhs) const
	Binary vector subtract.
Vec2ub &	operator-= (const Vec2ub &rhs)
	Unary vector subtract.
Public Attributes
value_type	_v [2]
	Vec member variable.

---

Detailed Description

General purpose unsigned byte pair.

---

Member Typedef Documentation

typedef unsigned char osg::Vec2ub::value_type

Data type of vector components.

---

Member Enumeration Documentation

anonymous enum

Number of vector components.

Enumerator:

num_components

---

Constructor & Destructor Documentation

osg::Vec2ub::Vec2ub

(

)

[inline]

Constructor that sets all components of the vector to zero.

References _v.

Referenced by operator+(), and operator-().

osg::Vec2ub::Vec2ub	(	value_type	r,
		value_type	g
	)		[inline]

References _v, g(), and r().

---

Member Function Documentation

value_type& osg::Vec2ub::g

(

)

[inline]

References _v.

Referenced by Vec2ub().

value_type osg::Vec2ub::g

(

)

const [inline]

References _v.

bool osg::Vec2ub::operator!=

(

const Vec2ub &

v

)

const [inline]

References _v.

Vec2ub osg::Vec2ub::operator*

(

float

rhs

)

const [inline]

Multiply by scalar.

Vec2ub& osg::Vec2ub::operator*=

(

float

rhs

)

[inline]

Unary multiply by scalar.

References _v.

Vec2ub osg::Vec2ub::operator+

(

const Vec2ub &

rhs

)

const [inline]

Binary vector add.

References _v, and Vec2ub().

Vec2ub& osg::Vec2ub::operator+=

(

const Vec2ub &

rhs

)

[inline]

Unary vector add.

Slightly more efficient because no temporary intermediate object.

References _v.

Vec2ub osg::Vec2ub::operator-

(

const Vec2ub &

rhs

)

const [inline]

Binary vector subtract.

References _v, and Vec2ub().

Vec2ub& osg::Vec2ub::operator-=

(

const Vec2ub &

rhs

)

[inline]

Unary vector subtract.

References _v.

Vec2ub osg::Vec2ub::operator/

(

float

rhs

)

const [inline]

Divide by scalar.

Vec2ub& osg::Vec2ub::operator/=

(

float

rhs

)

[inline]

Unary divide by scalar.

bool osg::Vec2ub::operator<

(

const Vec2ub &

v

)

const [inline]

References _v.

bool osg::Vec2ub::operator==

(

const Vec2ub &

v

)

const [inline]

References _v.

value_type& osg::Vec2ub::operator[]

(

int

i

)

[inline]

References _v.

value_type osg::Vec2ub::operator[]

(

int

i

)

const [inline]

References _v.

value_type* osg::Vec2ub::ptr

(

)

[inline]

References _v.

const value_type* osg::Vec2ub::ptr

(

)

const [inline]

References _v.

value_type& osg::Vec2ub::r

(

)

[inline]

References _v.

Referenced by Vec2ub().

value_type osg::Vec2ub::r

(

)

const [inline]

References _v.

void osg::Vec2ub::set	(	value_type	x,
		value_type	y
	)		[inline]

References _v, x(), and y().

void osg::Vec2ub::set

(

const Vec2ub &

rhs

)

[inline]

References _v.

value_type& osg::Vec2ub::x

(

)

[inline]

References _v.

Referenced by set().

value_type osg::Vec2ub::x

(

)

const [inline]

References _v.

value_type& osg::Vec2ub::y

(

)

[inline]

References _v.

Referenced by set().

value_type osg::Vec2ub::y

(

)

const [inline]

References _v.

---

Member Data Documentation

value_type osg::Vec2ub::_v[2]

Vec member variable.

Referenced by g(), operator!=(), operator*=(), operator+(), operator+=(), operator-(), operator-=(), operator<(), operator==(), operator[](), ptr(), r(), set(), Vec2ub(), x(), and y().

---

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

• osg/Vec2ub