OpenSceneGraph  3.0.1
Public Types | Public Member Functions | Public Attributes | List of all members
osg::Vec2d Class Reference

General purpose double pair, uses include representation of texture coordinates. More...

Public Types

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

Public Member Functions

 Vec2d ()
 Constructor that sets all components of the vector to zero. More...
 
 Vec2d (value_type x, value_type y)
 
 Vec2d (const Vec2f &vec)
 
 operator Vec2f () const
 
bool operator== (const Vec2d &v) const
 
bool operator!= (const Vec2d &v) const
 
bool operator< (const Vec2d &v) const
 
value_typeptr ()
 
const value_typeptr () const
 
void set (value_type x, value_type y)
 
value_typeoperator[] (int i)
 
value_type operator[] (int i) const
 
value_typex ()
 
value_typey ()
 
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 Vec2d &rhs) const
 Dot product. More...
 
const Vec2d operator* (value_type rhs) const
 Multiply by scalar. More...
 
Vec2doperator*= (value_type rhs)
 Unary multiply by scalar. More...
 
const Vec2d operator/ (value_type rhs) const
 Divide by scalar. More...
 
Vec2doperator/= (value_type rhs)
 Unary divide by scalar. More...
 
const Vec2d operator+ (const Vec2d &rhs) const
 Binary vector add. More...
 
Vec2doperator+= (const Vec2d &rhs)
 Unary vector add. More...
 
const Vec2d operator- (const Vec2d &rhs) const
 Binary vector subtract. More...
 
Vec2doperator-= (const Vec2d &rhs)
 Unary vector subtract. More...
 
const Vec2d 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]
 

Detailed Description

General purpose double pair, uses include representation of texture coordinates.

No support yet added for double * Vec2d - is it necessary? Need to define a non-member non-friend operator* etc. BTW: Vec2d * double is okay

Member Typedef Documentation

typedef double osg::Vec2d::value_type

Data type of vector components.

Member Enumeration Documentation

anonymous enum

Number of vector components.

Enumerator
num_components 

Constructor & Destructor Documentation

osg::Vec2d::Vec2d ( )
inline

Constructor that sets all components of the vector to zero.

References _v.

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

osg::Vec2d::Vec2d ( value_type  x,
value_type  y 
)
inline

References _v, x(), and y().

osg::Vec2d::Vec2d ( const Vec2f vec)
inline

References _v, and osg::Vec2f::_v.

Member Function Documentation

bool osg::Vec2d::isNaN ( ) const
inline

Returns true if at least one component has value NaN.

References _v, and osg::isNaN().

Referenced by valid().

value_type osg::Vec2d::length ( ) const
inline

Length of the vector = sqrt( vec .

vec )

References _v.

Referenced by normalize().

value_type osg::Vec2d::length2 ( void  ) const
inline

Length squared of the vector = vec .

vec

References _v.

value_type osg::Vec2d::normalize ( )
inline

Normalize the vector so that it has length unity.

Returns the previous length of the vector.

References _v, and length().

osg::Vec2d::operator Vec2f ( ) const
inline

References _v.

bool osg::Vec2d::operator!= ( const Vec2d v) const
inline

References _v.

value_type osg::Vec2d::operator* ( const Vec2d rhs) const
inline

Dot product.

References _v.

const Vec2d osg::Vec2d::operator* ( value_type  rhs) const
inline

Multiply by scalar.

References _v, and Vec2d().

Vec2d& osg::Vec2d::operator*= ( value_type  rhs)
inline

Unary multiply by scalar.

References _v.

const Vec2d osg::Vec2d::operator+ ( const Vec2d rhs) const
inline

Binary vector add.

References _v, and Vec2d().

Vec2d& osg::Vec2d::operator+= ( const Vec2d rhs)
inline

Unary vector add.

Slightly more efficient because no temporary intermediate object.

References _v.

const Vec2d osg::Vec2d::operator- ( const Vec2d rhs) const
inline

Binary vector subtract.

References _v, and Vec2d().

const Vec2d osg::Vec2d::operator- ( ) const
inline

Negation operator.

Returns the negative of the Vec2d.

References _v, and Vec2d().

Vec2d& osg::Vec2d::operator-= ( const Vec2d rhs)
inline

Unary vector subtract.

References _v.

const Vec2d osg::Vec2d::operator/ ( value_type  rhs) const
inline

Divide by scalar.

References _v, and Vec2d().

Vec2d& osg::Vec2d::operator/= ( value_type  rhs)
inline

Unary divide by scalar.

References _v.

bool osg::Vec2d::operator< ( const Vec2d v) const
inline

References _v.

bool osg::Vec2d::operator== ( const Vec2d v) const
inline

References _v.

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

References _v.

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

References _v.

value_type* osg::Vec2d::ptr ( )
inline

References _v.

const value_type* osg::Vec2d::ptr ( ) const
inline

References _v.

void osg::Vec2d::set ( value_type  x,
value_type  y 
)
inline

References _v, x(), and y().

bool osg::Vec2d::valid ( ) const
inline

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

References isNaN().

value_type& osg::Vec2d::x ( )
inline

References _v.

Referenced by set(), and Vec2d().

value_type osg::Vec2d::x ( ) const
inline

References _v.

value_type& osg::Vec2d::y ( )
inline

References _v.

Referenced by set(), and Vec2d().

value_type osg::Vec2d::y ( ) const
inline

References _v.

Member Data Documentation

value_type osg::Vec2d::_v[2]

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

osg logo
Generated at Wed Feb 13 2013 17:58:55 for the OpenSceneGraph by doxygen 1.8.3.1.