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

General purpose double triple for use as vertices, vectors and normals. More...

Public Types

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

Public Member Functions

 Vec3d ()
 Constructor that sets all components of the vector to zero. More...
 
 Vec3d (const Vec3f &vec)
 
 operator Vec3f () const
 
 Vec3d (value_type x, value_type y, value_type z)
 
 Vec3d (const Vec2d &v2, value_type zz)
 
bool operator== (const Vec3d &v) const
 
bool operator!= (const Vec3d &v) const
 
bool operator< (const Vec3d &v) const
 
value_typeptr ()
 
const value_typeptr () const
 
void set (value_type x, value_type y, value_type z)
 
void set (const Vec3d &rhs)
 
value_typeoperator[] (int i)
 
value_type operator[] (int i) const
 
value_typex ()
 
value_typey ()
 
value_typez ()
 
value_type x () const
 
value_type y () const
 
value_type z () 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 Vec3d &rhs) const
 Dot product. More...
 
const Vec3d operator^ (const Vec3d &rhs) const
 Cross product. More...
 
const Vec3d operator* (value_type rhs) const
 Multiply by scalar. More...
 
Vec3doperator*= (value_type rhs)
 Unary multiply by scalar. More...
 
const Vec3d operator/ (value_type rhs) const
 Divide by scalar. More...
 
Vec3doperator/= (value_type rhs)
 Unary divide by scalar. More...
 
const Vec3d operator+ (const Vec3d &rhs) const
 Binary vector add. More...
 
Vec3doperator+= (const Vec3d &rhs)
 Unary vector add. More...
 
const Vec3d operator- (const Vec3d &rhs) const
 Binary vector subtract. More...
 
Vec3doperator-= (const Vec3d &rhs)
 Unary vector subtract. More...
 
const Vec3d operator- () const
 Negation operator. More...
 
value_type length () const
 Length of the vector = sqrt( vec . More...
 
value_type length2 () 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 [3]
 

Detailed Description

General purpose double triple for use as vertices, vectors and normals.

Provides general math operations from addition through to cross products. No support yet added for double * Vec3d - is it necessary? Need to define a non-member non-friend operator* etc. Vec3d * double is okay

Member Typedef Documentation

§ value_type

typedef double osg::Vec3d::value_type

Data type of vector components.

Member Enumeration Documentation

§ anonymous enum

anonymous enum

Number of vector components.

Enumerator
num_components 

Constructor & Destructor Documentation

§ Vec3d() [1/4]

osg::Vec3d::Vec3d ( )
inline

Constructor that sets all components of the vector to zero.

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

§ Vec3d() [2/4]

osg::Vec3d::Vec3d ( const Vec3f vec)
inline

References osg::Vec3f::_v.

§ Vec3d() [3/4]

osg::Vec3d::Vec3d ( value_type  x,
value_type  y,
value_type  z 
)
inline

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

§ Vec3d() [4/4]

osg::Vec3d::Vec3d ( const Vec2d v2,
value_type  zz 
)
inline

Member Function Documentation

§ isNaN()

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

Returns true if at least one component has value NaN.

References osg::isNaN().

Referenced by valid().

§ length()

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

Length of the vector = sqrt( vec .

vec )

Referenced by osg::Matrixd::getScale(), osg::Matrixf::getScale(), normalize(), and osg::Plane::set().

§ length2()

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

Length squared of the vector = vec .

vec

§ normalize()

value_type osg::Vec3d::normalize ( )
inline

Normalize the vector so that it has length unity.

Returns the previous length of the vector. If the vector is zero length, it is left unchanged and zero is returned.

References length().

§ operator Vec3f()

osg::Vec3d::operator Vec3f ( ) const
inline

§ operator!=()

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

References _v.

§ operator*() [1/2]

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

Dot product.

References _v.

§ operator*() [2/2]

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

Multiply by scalar.

References Vec3d().

§ operator*=()

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

Unary multiply by scalar.

§ operator+()

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

Binary vector add.

References _v, and Vec3d().

§ operator+=()

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

Unary vector add.

Slightly more efficient because no temporary intermediate object.

References _v.

§ operator-() [1/2]

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

Binary vector subtract.

References _v, and Vec3d().

§ operator-() [2/2]

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

Negation operator.

Returns the negative of the Vec3d.

References Vec3d().

§ operator-=()

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

Unary vector subtract.

References _v.

§ operator/()

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

Divide by scalar.

References Vec3d().

§ operator/=()

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

Unary divide by scalar.

§ operator<()

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

References _v.

§ operator==()

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

References _v.

§ operator[]() [1/2]

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

§ operator[]() [2/2]

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

§ operator^()

const Vec3d osg::Vec3d::operator^ ( const Vec3d rhs) const
inline

Cross product.

References _v, and Vec3d().

§ ptr() [1/2]

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

References _v.

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

§ ptr() [2/2]

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

References _v.

§ set() [1/2]

void osg::Vec3d::set ( value_type  x,
value_type  y,
value_type  z 
)
inline

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

Referenced by osg::Plane::set().

§ set() [2/2]

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

§ valid()

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

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

References isNaN().

§ x() [1/2]

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

§ x() [2/2]

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

§ y() [1/2]

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

§ y() [2/2]

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

§ z() [1/2]

value_type& osg::Vec3d::z ( )
inline

§ z() [2/2]

value_type osg::Vec3d::z ( ) const
inline

Member Data Documentation

§ _v

value_type osg::Vec3d::_v[3]

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