openscenegraph
Public Types | Public Member Functions | Public Attributes | List of all members
osg::Vec2f Class Reference

#include <Vec2f>

Public Types

enum  { num_components = 2 }
 
typedef float value_type
 

Public Member Functions

 Vec2f ()
 
 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_typeptr ()
 
const value_typeptr () const
 
void set (value_type x, value_type y)
 
void set (const Vec2f &rhs)
 
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
 
bool isNaN () const
 
value_type operator* (const Vec2f &rhs) const
 
const Vec2f operator* (value_type rhs) const
 
Vec2foperator*= (value_type rhs)
 
const Vec2f operator/ (value_type rhs) const
 
Vec2foperator/= (value_type rhs)
 
const Vec2f operator+ (const Vec2f &rhs) const
 
Vec2foperator+= (const Vec2f &rhs)
 
const Vec2f operator- (const Vec2f &rhs) const
 
Vec2foperator-= (const Vec2f &rhs)
 
const Vec2f operator- () const
 
value_type length () const
 
value_type length2 (void) const
 
value_type normalize ()
 

Public Attributes

value_type _v [2]
 

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

◆ Vec2f() [2/2]

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

Member Function Documentation

◆ isNaN()

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

Returns true if at least one component has value NaN.

◆ length()

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

Length of the vector = sqrt( vec . vec )

◆ 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.

◆ operator!=()

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

◆ operator*() [1/2]

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

Dot product.

◆ operator*() [2/2]

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

Multiply by scalar.

◆ 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.

◆ operator+=()

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

Unary vector add. Slightly more efficient because no temporary intermediate object.

◆ operator-() [1/2]

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

Negation operator. Returns the negative of the Vec2f.

◆ operator-() [2/2]

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

Binary vector subtract.

◆ operator-=()

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

Unary vector subtract.

◆ operator/()

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

Divide by scalar.

◆ operator/=()

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

Unary divide by scalar.

◆ operator<()

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

◆ operator==()

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

◆ 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

◆ ptr() [2/2]

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

◆ set() [1/2]

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

◆ set() [2/2]

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

◆ valid()

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

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

◆ x() [1/2]

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

◆ x() [2/2]

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

◆ y() [1/2]

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

◆ y() [2/2]

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

Member Data Documentation

◆ _v

value_type osg::Vec2f::_v[2]

Vec member variable.


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