osg::Vec3us Class Reference

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

Public Member Functions
	Vec3us ()
	Constructor that sets all components of the vector to zero. More...
	Vec3us (value_type r, value_type g, value_type b)
bool	operator== (const Vec3us &v) const
bool	operator!= (const Vec3us &v) const
bool	operator< (const Vec3us &v) const
value_type *	ptr ()
const value_type *	ptr () const
void	set (value_type r, value_type g, value_type b)
void	set (const Vec3us &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
Vec3us	operator* (value_type rhs) const
	Multiply by scalar. More...
Vec3us &	operator*= (value_type rhs)
	Unary multiply by scalar. More...
Vec3us	operator/ (value_type rhs) const
	Divide by scalar. More...
Vec3us &	operator/= (value_type rhs)
	Unary divide by scalar. More...
Vec3us	operator* (const Vec3us &rhs) const
	Binary vector multiply. More...
Vec3us	operator+ (const Vec3us &rhs) const
	Binary vector add. More...
Vec3us &	operator+= (const Vec3us &rhs)
	Unary vector add. More...
Vec3us	operator- (const Vec3us &rhs) const
	Binary vector subtract. More...
Vec3us &	operator-= (const Vec3us &rhs)
	Unary vector subtract. More...

Public Attributes
value_type	_v [3]

Member Typedef Documentation

value_type

typedef unsigned short osg::Vec3us::value_type

Data type of vector components.

Member Enumeration Documentation

anonymous enum

anonymous enum

Number of vector components.

Enumerator
num_components

Constructor & Destructor Documentation

Vec3us() [1/2]

osg::Vec3us::Vec3us ( )

inline

Constructor that sets all components of the vector to zero.

Referenced by osg::componentDivide(), osg::componentMultiply(), operator*(), operator+(), operator-(), and operator/().

Vec3us() [2/2]

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

inline

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

Member Function Documentation

b() [1/2]

value_type& osg::Vec3us::b ( )

inline

Referenced by set(), and Vec3us().

b() [2/2]

value_type osg::Vec3us::b ( ) const

inline

g() [1/2]

value_type& osg::Vec3us::g ( )

inline

Referenced by set(), and Vec3us().

g() [2/2]

value_type osg::Vec3us::g ( ) const

inline

operator!=()

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

inline

References _v.

operator*() [1/2]

Vec3us osg::Vec3us::operator* ( value_type  rhs ) const

inline

Multiply by scalar.

References Vec3us().

operator*() [2/2]

Vec3us osg::Vec3us::operator* ( const Vec3us &  rhs ) const

inline

Binary vector multiply.

References _v, and Vec3us().

operator*=()

Vec3us& osg::Vec3us::operator*= ( value_type  rhs )

inline

Unary multiply by scalar.

operator+()

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

inline

Binary vector add.

References _v, and Vec3us().

operator+=()

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

inline

Unary vector add.

Slightly more efficient because no temporary intermediate object.

References _v.

operator-()

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

inline

Binary vector subtract.

References _v, and Vec3us().

operator-=()

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

inline

Unary vector subtract.

References _v.

operator/()

Vec3us osg::Vec3us::operator/ ( value_type  rhs ) const

inline

Divide by scalar.

References Vec3us().

operator/=()

Vec3us& osg::Vec3us::operator/= ( value_type  rhs )

inline

Unary divide by scalar.

operator<()

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

inline

References _v.

operator==()

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

inline

References _v.

operator[]() [1/2]

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

inline

operator[]() [2/2]

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

inline

ptr() [1/2]

value_type* osg::Vec3us::ptr ( )

inline

References _v.

ptr() [2/2]

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

inline

References _v.

r() [1/2]

value_type& osg::Vec3us::r ( )

inline

Referenced by set(), and Vec3us().

r() [2/2]

value_type osg::Vec3us::r ( ) const

inline

set() [1/2]

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

inline

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

set() [2/2]

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

inline

x() [1/2]

value_type& osg::Vec3us::x ( )

inline

x() [2/2]

value_type osg::Vec3us::x ( ) const

inline

y() [1/2]

value_type& osg::Vec3us::y ( )

inline

y() [2/2]

value_type osg::Vec3us::y ( ) const

inline

z() [1/2]

value_type& osg::Vec3us::z ( )

inline

z() [2/2]

value_type osg::Vec3us::z ( ) const

inline

Member Data Documentation

_v

value_type osg::Vec3us::_v[3]

Referenced by operator!=(), operator*(), operator+(), operator+=(), operator-(), operator-=(), operator<(), operator==(), and ptr().

---

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

• osg/Vec3us