OSG  3.4.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Public Attributes | List of all members
osg::Vec2f Class Reference

#include <Vec2f.h>

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

Definition at line 28 of file Vec2f.h.

Member Typedef Documentation

typedef float osg::Vec2f::value_type

Data type of vector components.

Definition at line 33 of file Vec2f.h.

Member Enumeration Documentation

anonymous enum

Number of vector components.

Enumerator
num_components 

Definition at line 36 of file Vec2f.h.

Constructor & Destructor Documentation

osg::Vec2f::Vec2f ( )
inline

Constructor that sets all components of the vector to zero

Definition at line 43 of file Vec2f.h.

Here is the caller graph for this function:

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

Definition at line 44 of file Vec2f.h.

Here is the call graph for this function:

Member Function Documentation

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

Returns true if at least one component has value NaN.

Definition at line 76 of file Vec2f.h.

Here is the call graph for this function:

Here is the caller graph for this function:

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

Length of the vector = sqrt( vec . vec )

Definition at line 149 of file Vec2f.h.

Here is the caller graph for this function:

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

Length squared of the vector = vec . vec

Definition at line 155 of file Vec2f.h.

value_type osg::Vec2f::normalize ( )
inline

Normalize the vector so that it has length unity. Returns the previous length of the vector.

Definition at line 163 of file Vec2f.h.

Here is the call graph for this function:

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

Definition at line 49 of file Vec2f.h.

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

Dot product.

Definition at line 79 of file Vec2f.h.

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

Multiply by scalar.

Definition at line 85 of file Vec2f.h.

Here is the call graph for this function:

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

Unary multiply by scalar.

Definition at line 91 of file Vec2f.h.

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

Binary vector add.

Definition at line 113 of file Vec2f.h.

Here is the call graph for this function:

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

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

Definition at line 121 of file Vec2f.h.

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

Binary vector subtract.

Definition at line 129 of file Vec2f.h.

Here is the call graph for this function:

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

Negation operator. Returns the negative of the Vec2f.

Definition at line 143 of file Vec2f.h.

Here is the call graph for this function:

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

Unary vector subtract.

Definition at line 135 of file Vec2f.h.

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

Divide by scalar.

Definition at line 99 of file Vec2f.h.

Here is the call graph for this function:

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

Unary divide by scalar.

Definition at line 105 of file Vec2f.h.

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

Definition at line 51 of file Vec2f.h.

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

Definition at line 47 of file Vec2f.h.

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

Definition at line 64 of file Vec2f.h.

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

Definition at line 65 of file Vec2f.h.

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

Definition at line 58 of file Vec2f.h.

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

Definition at line 59 of file Vec2f.h.

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

Definition at line 61 of file Vec2f.h.

Here is the call graph for this function:

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

Definition at line 62 of file Vec2f.h.

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

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

Definition at line 74 of file Vec2f.h.

Here is the call graph for this function:

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

Definition at line 67 of file Vec2f.h.

Here is the caller graph for this function:

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

Definition at line 70 of file Vec2f.h.

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

Definition at line 68 of file Vec2f.h.

Here is the caller graph for this function:

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

Definition at line 71 of file Vec2f.h.

Member Data Documentation

value_type osg::Vec2f::_v[2]

Vec member variable.

Definition at line 39 of file Vec2f.h.


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