osg::Vec2f Class Reference

General purpose float pair. More...

Public Types
enum	{ num_components = 2 }
	Number of vector components. More...
typedef float	value_type
	Data type of vector components. More...

Public Member Functions
	Vec2f ()
	Constructor that sets all components of the vector to zero. More...
	Vec2f (value_type x, value_type y)
bool	operator== (const Vec2f &v) const
bool	operator!= (const Vec2f &v) const
bool	operator< (const Vec2f &v) const
value_type *	ptr ()
const value_type *	ptr () const
void	set (value_type x, value_type y)
void	set (const Vec2f &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
bool	valid () const
	Returns true if all components have values that are not NaN. More...
bool	isNaN () const
	Returns true if at least one component has value NaN. More...
value_type	operator* (const Vec2f &rhs) const
	Dot product. More...
const Vec2f	operator* (value_type rhs) const
	Multiply by scalar. More...
Vec2f &	operator*= (value_type rhs)
	Unary multiply by scalar. More...
const Vec2f	operator/ (value_type rhs) const
	Divide by scalar. More...
Vec2f &	operator/= (value_type rhs)
	Unary divide by scalar. More...
const Vec2f	operator+ (const Vec2f &rhs) const
	Binary vector add. More...
Vec2f &	operator+= (const Vec2f &rhs)
	Unary vector add. More...
const Vec2f	operator- (const Vec2f &rhs) const
	Binary vector subtract. More...
Vec2f &	operator-= (const Vec2f &rhs)
	Unary vector subtract. More...
const Vec2f	operator- () const
	Negation operator. More...
value_type	length () const
	Length of the vector = sqrt( vec . More...
value_type	length2 (void) const
	Length squared of the vector = vec . More...
value_type	normalize ()
	Normalize the vector so that it has length unity. More...

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

Detailed Description

General purpose float pair.

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

Member Typedef Documentation

value_type

typedef float osg::Vec2f::value_type

Data type of vector components.

Member Enumeration Documentation

anonymous enum

anonymous enum

Number of vector components.

Enumerator
num_components

Constructor & Destructor Documentation

Vec2f() [1/2]

osg::Vec2f::Vec2f ( )

inline

Constructor that sets all components of the vector to zero.

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

Vec2f() [2/2]

osg::Vec2f::Vec2f ( value_type  x, value_type  y  )

inline

References x(), and y().

Member Function Documentation

isNaN()

bool osg::Vec2f::isNaN ( ) const

inline

Returns true if at least one component has value NaN.

References osg::isNaN().

Referenced by valid().

length()

value_type osg::Vec2f::length ( ) const

inline

Length of the vector = sqrt( vec .

vec )

Referenced by normalize().

length2()

value_type osg::Vec2f::length2 ( void  ) const

inline

Length squared of the vector = vec .

vec

normalize()

value_type osg::Vec2f::normalize ( )

inline

Normalize the vector so that it has length unity.

Returns the previous length of the vector.

References length().

operator!=()

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

inline

References _v.

operator*() [1/2]

value_type osg::Vec2f::operator* ( const Vec2f &  rhs ) const

inline

Dot product.

References _v.

operator*() [2/2]

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

inline

Multiply by scalar.

References Vec2f().

operator*=()

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

inline

Unary multiply by scalar.

operator+()

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

inline

Binary vector add.

References _v, and Vec2f().

operator+=()

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

inline

Unary vector add.

Slightly more efficient because no temporary intermediate object.

References _v.

operator-() [1/2]

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

inline

Binary vector subtract.

References _v, and Vec2f().

operator-() [2/2]

const Vec2f osg::Vec2f::operator- ( ) const

inline

Negation operator.

Returns the negative of the Vec2f.

References Vec2f().

operator-=()

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

inline

Unary vector subtract.

References _v.

operator/()

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

inline

Divide by scalar.

References Vec2f().

operator/=()

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

inline

Unary divide by scalar.

operator<()

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

inline

References _v.

operator==()

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

inline

References _v.

operator[]() [1/2]

value_type& osg::Vec2f::operator[] ( int  i )

inline

operator[]() [2/2]

value_type osg::Vec2f::operator[] ( int  i ) const

inline

ptr() [1/2]

value_type* osg::Vec2f::ptr ( )

inline

References _v.

Referenced by osg::GLExtensions::glUniform().

ptr() [2/2]

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

inline

References _v.

set() [1/2]

void osg::Vec2f::set ( value_type  x, value_type  y  )

inline

References x(), and y().

Referenced by osgText::TextBase::getCoord().

set() [2/2]

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

inline

valid()

bool osg::Vec2f::valid ( ) const

inline

Returns true if all components have values that are not NaN.

References isNaN().

x() [1/2]

value_type& osg::Vec2f::x ( )

inline

Referenced by osgText::TextBase::addCoord(), osgWidget::Widget::addOrigin(), osgWidget::Widget::addSize(), osg::Image::getColor(), osgWidget::Widget::getImageColorAtXY(), osgParticle::Interpolator::interpolate(), osgWidget::Window::isPointerXYWithinVisible(), osgTerrain::ValidDataOperator::operator()(), set(), osgWidget::Widget::setMinimumSize(), osgWidget::Widget::setOrigin(), osgWidget::Window::setOrigin(), osgWidget::Widget::setSize(), osgWidget::Widget::setTexCoord(), osgWidget::Widget::setTexCoordRegion(), and Vec2f().

x() [2/2]

value_type osg::Vec2f::x ( ) const

inline

y() [1/2]

value_type& osg::Vec2f::y ( )

inline

Referenced by osgText::TextBase::addCoord(), osgWidget::Widget::addOrigin(), osgWidget::Widget::addSize(), osg::Image::getColor(), osgWidget::Widget::getImageColorAtXY(), osgParticle::Interpolator::interpolate(), osgWidget::Window::isPointerXYWithinVisible(), osgTerrain::ValidDataOperator::operator()(), set(), osgWidget::Widget::setMinimumSize(), osgWidget::Widget::setOrigin(), osgWidget::Window::setOrigin(), osgWidget::Widget::setSize(), osgWidget::Widget::setTexCoord(), osgWidget::Widget::setTexCoordRegion(), and Vec2f().

y() [2/2]

value_type osg::Vec2f::y ( ) const

inline

Member Data Documentation

_v

value_type osg::Vec2f::_v[2]

Vec member variable.

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

---

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

• osg/Vec2f