osg::Vec4ub Class Reference

General purpose float quad. More...

Public Types
enum	{ num_components = 4 }
	Number of vector components. More...
typedef unsigned char	value_type
	Data type of vector components. More...

Public Member Functions
	Vec4ub ()
	Constructor that sets all components of the vector to zero. More...
	Vec4ub (value_type x, value_type y, value_type z, value_type w)
bool	operator== (const Vec4ub &v) const
bool	operator!= (const Vec4ub &v) const
bool	operator< (const Vec4ub &v) const
value_type *	ptr ()
const value_type *	ptr () const
void	set (value_type r, value_type g, value_type b, value_type a)
value_type &	operator[] (unsigned int i)
value_type	operator[] (unsigned int i) const
value_type &	x ()
value_type &	y ()
value_type &	z ()
value_type &	w ()
value_type	x () const
value_type	y () const
value_type	z () const
value_type	w () const
value_type &	r ()
value_type &	g ()
value_type &	b ()
value_type &	a ()
value_type	r () const
value_type	g () const
value_type	b () const
value_type	a () const
Vec4ub	operator* (float rhs) const
	Multiply by scalar. More...
Vec4ub &	operator*= (float rhs)
	Unary multiply by scalar. More...
Vec4ub	operator/ (float rhs) const
	Divide by scalar. More...
Vec4ub &	operator/= (float rhs)
	Unary divide by scalar. More...
Vec4ub	operator+ (const Vec4ub &rhs) const
	Binary vector add. More...
Vec4ub &	operator+= (const Vec4ub &rhs)
	Unary vector add. More...
Vec4ub	operator- (const Vec4ub &rhs) const
	Binary vector subtract. More...
Vec4ub &	operator-= (const Vec4ub &rhs)
	Unary vector subtract. More...

Public Attributes
value_type	_v [4]
	Vec member variable. More...

Detailed Description

General purpose float quad.

Uses include representation of color coordinates. No support yet added for float * Vec4ub - is it necessary? Need to define a non-member non-friend operator* etc. Vec4ub * float is okay

Member Typedef Documentation

value_type

typedef unsigned char osg::Vec4ub::value_type

Data type of vector components.

Member Enumeration Documentation

anonymous enum

anonymous enum

Number of vector components.

Enumerator
num_components

Constructor & Destructor Documentation

Vec4ub() [1/2]

osg::Vec4ub::Vec4ub ( )

inline

Constructor that sets all components of the vector to zero.

Referenced by osg::convertToRGBA8(), operator+(), and operator-().

Vec4ub() [2/2]

osg::Vec4ub::Vec4ub ( value_type  x, value_type  y, value_type  z, value_type  w  )

inline

References w(), x(), y(), and z().

Member Function Documentation

a() [1/2]

value_type& osg::Vec4ub::a ( )

inline

Referenced by set().

a() [2/2]

value_type osg::Vec4ub::a ( ) const

inline

b() [1/2]

value_type& osg::Vec4ub::b ( )

inline

Referenced by set().

b() [2/2]

value_type osg::Vec4ub::b ( ) const

inline

g() [1/2]

value_type& osg::Vec4ub::g ( )

inline

Referenced by set().

g() [2/2]

value_type osg::Vec4ub::g ( ) const

inline

operator!=()

bool osg::Vec4ub::operator!= ( const Vec4ub &  v ) const

inline

References _v.

operator*()

Vec4ub osg::Vec4ub::operator* ( float  rhs ) const

inline

Multiply by scalar.

operator*=()

Vec4ub& osg::Vec4ub::operator*= ( float  rhs )

inline

Unary multiply by scalar.

operator+()

Vec4ub osg::Vec4ub::operator+ ( const Vec4ub &  rhs ) const

inline

Binary vector add.

References _v, and Vec4ub().

operator+=()

Vec4ub& osg::Vec4ub::operator+= ( const Vec4ub &  rhs )

inline

Unary vector add.

Slightly more efficient because no temporary intermediate object.

References _v.

operator-()

Vec4ub osg::Vec4ub::operator- ( const Vec4ub &  rhs ) const

inline

Binary vector subtract.

References _v, and Vec4ub().

operator-=()

Vec4ub& osg::Vec4ub::operator-= ( const Vec4ub &  rhs )

inline

Unary vector subtract.

References _v.

operator/()

Vec4ub osg::Vec4ub::operator/ ( float  rhs ) const

inline

Divide by scalar.

operator/=()

Vec4ub& osg::Vec4ub::operator/= ( float  rhs )

inline

Unary divide by scalar.

operator<()

bool osg::Vec4ub::operator< ( const Vec4ub &  v ) const

inline

References _v.

operator==()

bool osg::Vec4ub::operator== ( const Vec4ub &  v ) const

inline

References _v.

operator[]() [1/2]

value_type& osg::Vec4ub::operator[] ( unsigned int  i )

inline

operator[]() [2/2]

value_type osg::Vec4ub::operator[] ( unsigned int  i ) const

inline

ptr() [1/2]

value_type* osg::Vec4ub::ptr ( )

inline

References _v.

ptr() [2/2]

const value_type* osg::Vec4ub::ptr ( ) const

inline

References _v.

r() [1/2]

value_type& osg::Vec4ub::r ( )

inline

Referenced by set().

r() [2/2]

value_type osg::Vec4ub::r ( ) const

inline

set()

void osg::Vec4ub::set ( value_type  r, value_type  g, value_type  b, value_type  a  )

inline

References a(), b(), g(), and r().

w() [1/2]

value_type& osg::Vec4ub::w ( )

inline

Referenced by Vec4ub().

w() [2/2]

value_type osg::Vec4ub::w ( ) const

inline

x() [1/2]

value_type& osg::Vec4ub::x ( )

inline

Referenced by Vec4ub().

x() [2/2]

value_type osg::Vec4ub::x ( ) const

inline

y() [1/2]

value_type& osg::Vec4ub::y ( )

inline

Referenced by Vec4ub().

y() [2/2]

value_type osg::Vec4ub::y ( ) const

inline

z() [1/2]

value_type& osg::Vec4ub::z ( )

inline

Referenced by Vec4ub().

z() [2/2]

value_type osg::Vec4ub::z ( ) const

inline

Member Data Documentation

_v

value_type osg::Vec4ub::_v[4]

Vec member variable.

Referenced by operator!=(), operator+(), operator+=(), operator-(), operator-=(), operator<(), osg::operator<<(), operator==(), osg::operator>>(), and ptr().

---

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

• osg/Vec4ub