OpenSceneGraph  3.0.1
Public Types | Public Member Functions | Public Attributes
osg::Vec3b Class Reference

General purpose float triple. More...

List of all members.

Public Types

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

Public Member Functions

 Vec3b ()
 Constructor that sets all components of the vector to zero.
 Vec3b (value_type r, value_type g, value_type b)
bool operator== (const Vec3b &v) const
bool operator!= (const Vec3b &v) const
bool operator< (const Vec3b &v) const
value_typeptr ()
const value_typeptr () const
void set (value_type r, value_type g, value_type b)
void set (const Vec3b &rhs)
value_typeoperator[] (unsigned int i)
value_type operator[] (unsigned int i) const
value_typex ()
value_typey ()
value_typez ()
value_type x () const
value_type y () const
value_type z () const
value_typer ()
value_typeg ()
value_typeb ()
value_type r () const
value_type g () const
value_type b () const
Vec3b operator* (float rhs) const
 Multiply by scalar.
Vec3boperator*= (float rhs)
 Unary multiply by scalar.
Vec3b operator/ (float rhs) const
 Divide by scalar.
Vec3boperator/= (float rhs)
 Unary divide by scalar.
Vec3b operator+ (const Vec3b &rhs) const
 Binary vector add.
Vec3boperator+= (const Vec3b &rhs)
 Unary vector add.
Vec3b operator- (const Vec3b &rhs) const
 Binary vector subtract.
Vec3boperator-= (const Vec3b &rhs)
 Unary vector subtract.

Public Attributes

value_type _v [3]

Detailed Description

General purpose float triple.

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


Member Typedef Documentation

typedef signed char osg::Vec3b::value_type

Data type of vector components.


Member Enumeration Documentation

anonymous enum

Number of vector components.

Enumerator:
num_components 

Constructor & Destructor Documentation

osg::Vec3b::Vec3b ( ) [inline]

Constructor that sets all components of the vector to zero.

References _v.

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

osg::Vec3b::Vec3b ( value_type  r,
value_type  g,
value_type  b 
) [inline]

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


Member Function Documentation

value_type& osg::Vec3b::b ( ) [inline]

References _v.

Referenced by Vec3b(), and set().

value_type osg::Vec3b::b ( ) const [inline]

References _v.

value_type& osg::Vec3b::g ( ) [inline]

References _v.

Referenced by Vec3b(), and set().

value_type osg::Vec3b::g ( ) const [inline]

References _v.

bool osg::Vec3b::operator!= ( const Vec3b v) const [inline]

References _v.

Vec3b osg::Vec3b::operator* ( float  rhs) const [inline]

Multiply by scalar.

Vec3b& osg::Vec3b::operator*= ( float  rhs) [inline]

Unary multiply by scalar.

References _v.

Vec3b osg::Vec3b::operator+ ( const Vec3b rhs) const [inline]

Binary vector add.

References Vec3b(), and _v.

Vec3b& osg::Vec3b::operator+= ( const Vec3b rhs) [inline]

Unary vector add.

Slightly more efficient because no temporary intermediate object.

References _v.

Vec3b osg::Vec3b::operator- ( const Vec3b rhs) const [inline]

Binary vector subtract.

References Vec3b(), and _v.

Vec3b& osg::Vec3b::operator-= ( const Vec3b rhs) [inline]

Unary vector subtract.

References _v.

Vec3b osg::Vec3b::operator/ ( float  rhs) const [inline]

Divide by scalar.

Vec3b& osg::Vec3b::operator/= ( float  rhs) [inline]

Unary divide by scalar.

bool osg::Vec3b::operator< ( const Vec3b v) const [inline]

References _v.

bool osg::Vec3b::operator== ( const Vec3b v) const [inline]

References _v.

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

References _v.

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

References _v.

value_type* osg::Vec3b::ptr ( ) [inline]

References _v.

const value_type* osg::Vec3b::ptr ( ) const [inline]

References _v.

value_type& osg::Vec3b::r ( ) [inline]

References _v.

Referenced by Vec3b(), and set().

value_type osg::Vec3b::r ( ) const [inline]

References _v.

void osg::Vec3b::set ( value_type  r,
value_type  g,
value_type  b 
) [inline]

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

void osg::Vec3b::set ( const Vec3b rhs) [inline]

References _v.

value_type& osg::Vec3b::x ( ) [inline]

References _v.

value_type osg::Vec3b::x ( ) const [inline]

References _v.

value_type& osg::Vec3b::y ( ) [inline]

References _v.

value_type osg::Vec3b::y ( ) const [inline]

References _v.

value_type& osg::Vec3b::z ( ) [inline]

References _v.

value_type osg::Vec3b::z ( ) const [inline]

References _v.


Member Data Documentation


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

osg logo
Generated at Mon Oct 3 2011 12:39:45 for the OpenSceneGraph by doxygen 1.7.5.