osg::Vec3ub Class Reference

General purpose float triple. More...

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

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

Public Attributes
value_type	_v [3]

Detailed Description

General purpose float triple.

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

Member Typedef Documentation

typedef unsigned char osg::Vec3ub::value_type

Data type of vector components.

Member Enumeration Documentation

anonymous enum

Number of vector components.

Enumerator
num_components

Constructor & Destructor Documentation

osg::Vec3ub::Vec3ub ( )

inline

Constructor that sets all components of the vector to zero.

osg::Vec3ub::Vec3ub ( value_type  r, value_type  g, value_type  b  )

inline

Member Function Documentation

value_type& osg::Vec3ub::b ( )

inline

value_type osg::Vec3ub::b ( ) const

inline

value_type& osg::Vec3ub::g ( )

inline

value_type osg::Vec3ub::g ( ) const

inline

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

inline

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

inline

Multiply by scalar.

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

inline

Unary multiply by scalar.

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

inline

Binary vector add.

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

inline

Unary vector add.

Slightly more efficient because no temporary intermediate object.

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

inline

Binary vector subtract.

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

inline

Unary vector subtract.

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

inline

Divide by scalar.

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

inline

Unary divide by scalar.

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

inline

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

inline

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

inline

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

inline

value_type* osg::Vec3ub::ptr ( )

inline

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

inline

value_type& osg::Vec3ub::r ( )

inline

value_type osg::Vec3ub::r ( ) const

inline

void osg::Vec3ub::set ( value_type  r, value_type  g, value_type  b  )

inline

void osg::Vec3ub::set ( const Vec3ub &  rhs )

inline

value_type& osg::Vec3ub::x ( )

inline

value_type osg::Vec3ub::x ( ) const

inline

value_type& osg::Vec3ub::y ( )

inline

value_type osg::Vec3ub::y ( ) const

inline

value_type& osg::Vec3ub::z ( )

inline

value_type osg::Vec3ub::z ( ) const

inline

Member Data Documentation

value_type osg::Vec3ub::_v[3]

---

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

• osg/Vec3ub