Open Inventor Reference
Public Member Functions | Protected Attributes | Friends | List of all members
SbVec2f Class Reference
Basics

2D vector class. More...

#include <Inventor/SbLinear.h>

Public Member Functions

 SbVec2f ()
 Default constructor.
 
 SbVec2f (const float v[2])
 Constructor given vector components.
 
 SbVec2f (float x, float y)
 Constructor given vector components.
 
float dot (const SbVec2f &v) const
 Returns dot (inner) product of vector and another vector.
 
const float * getValue () const
 Returns vector components.
 
void getValue (float &x, float &y) const
 Returns vector components.
 
float length () const
 Returns geometric length of vector.
 
void negate ()
 Negates each component of vector in place.
 
float normalize ()
 Changes vector to be unit length.
 
SbVec2f & setValue (const float v[2])
 Sets the vector components.
 
SbVec2f & setValue (float x, float y)
 Sets the vector components.
 
float & operator[] (int i)
 Accesses indexed component of vector.
 
const float & operator[] (int i) const
 
SbVec2f & operator*= (float d)
 Component-wise scalar multiplication and division operators.
 
SbVec2f & operator/= (float d)
 Component-wise scalar multiplication and division operators.
 
SbVec2f & operator+= (const SbVec2f &u)
 Component-wise vector addition and subtraction operators.
 
SbVec2f & operator-= (const SbVec2f &u)
 Component-wise vector addition and subtraction operators.
 
SbVec2f operator- () const
 Nondestructive unary negation - returns a new vector.
 
bool equals (const SbVec2f v, float tolerance) const
 Equality comparison within given tolerance em the square of the length of the maximum distance between the two vectors.
 

Protected Attributes

float vec [2]
 Storage for vector components.
 

Friends

INVENTOR_API SbVec2f operator* (const SbVec2f &v, float d)
 Component-wise binary scalar multiplication and division operators.
 
INVENTOR_API SbVec2f operator* (float d, const SbVec2f &v)
 
INVENTOR_API SbVec2f operator/ (const SbVec2f &v, float d)
 
INVENTOR_API SbVec2f operator+ (const SbVec2f &v1, const SbVec2f &v2)
 Component-wise binary vector addition and subtraction operators.
 
INVENTOR_API SbVec2f operator- (const SbVec2f &v1, const SbVec2f &v2)
 
INVENTOR_API bool operator== (const SbVec2f &v1, const SbVec2f &v2)
 Equality comparison operator.
 
INVENTOR_API bool operator!= (const SbVec2f &v1, const SbVec2f &v2)
 

Detailed Description

2D vector class used to store 2D vectors and points. This class is used throughout Inventor for arguments and return values. {}

See Also
SbVec3f, SbVec4f, SbVec2s, SbRotation

Definition at line 246 of file SbLinear.h.

Constructor & Destructor Documentation

◆ SbVec2f() [1/3]

SbVec2f::SbVec2f ( )
inline

Definition at line 250 of file SbLinear.h.

References vec.

Referenced by dot(), equals(), operator!=, operator*, operator*, operator*=(), operator+, operator+=(), operator-(), operator-, operator-=(), operator/, operator/=(), operator==, setValue(), and setValue().

◆ SbVec2f() [2/3]

SbVec2f::SbVec2f ( const float v[2])
inline

Definition at line 253 of file SbLinear.h.

References setValue().

◆ SbVec2f() [3/3]

SbVec2f::SbVec2f ( float x,
float y )
inline

Definition at line 256 of file SbLinear.h.

References setValue().

Member Function Documentation

◆ dot()

float SbVec2f::dot ( const SbVec2f & v) const

References SbVec2f().

◆ equals()

bool SbVec2f::equals ( const SbVec2f v,
float tolerance ) const

References SbVec2f().

◆ getValue() [1/2]

const float * SbVec2f::getValue ( ) const
inline

Definition at line 262 of file SbLinear.h.

References vec.

◆ getValue() [2/2]

void SbVec2f::getValue ( float & x,
float & y ) const

◆ length()

float SbVec2f::length ( ) const

◆ negate()

void SbVec2f::negate ( )

◆ normalize()

float SbVec2f::normalize ( )

◆ operator*=()

SbVec2f & SbVec2f::operator*= ( float d)

References SbVec2f().

◆ operator+=()

SbVec2f & SbVec2f::operator+= ( const SbVec2f & u)

References SbVec2f().

◆ operator-()

SbVec2f SbVec2f::operator- ( ) const

References SbVec2f().

◆ operator-=()

SbVec2f & SbVec2f::operator-= ( const SbVec2f & u)

References SbVec2f().

◆ operator/=()

SbVec2f & SbVec2f::operator/= ( float d)
inline

Definition at line 290 of file SbLinear.h.

References SbVec2f().

◆ operator[]() [1/2]

float & SbVec2f::operator[] ( int i)
inline

Definition at line 283 of file SbLinear.h.

References vec.

◆ operator[]() [2/2]

const float & SbVec2f::operator[] ( int i) const
inline

Definition at line 284 of file SbLinear.h.

References vec.

◆ setValue() [1/2]

SbVec2f & SbVec2f::setValue ( const float v[2])

References SbVec2f().

Referenced by SbVec2f(), and SbVec2f().

◆ setValue() [2/2]

SbVec2f & SbVec2f::setValue ( float x,
float y )

References SbVec2f().

Friends And Related Symbol Documentation

◆ operator!=

INVENTOR_API bool operator!= ( const SbVec2f & v1,
const SbVec2f & v2 )
friend

Definition at line 334 of file SbLinear.h.

References INVENTOR_API, and SbVec2f().

◆ operator* [1/2]

INVENTOR_API SbVec2f operator* ( const SbVec2f & v,
float d )
friend

References INVENTOR_API, and SbVec2f().

◆ operator* [2/2]

INVENTOR_API SbVec2f operator* ( float d,
const SbVec2f & v )
friend

Definition at line 324 of file SbLinear.h.

References INVENTOR_API, and SbVec2f().

◆ operator+

INVENTOR_API SbVec2f operator+ ( const SbVec2f & v1,
const SbVec2f & v2 )
friend

References INVENTOR_API, and SbVec2f().

◆ operator-

INVENTOR_API SbVec2f operator- ( const SbVec2f & v1,
const SbVec2f & v2 )
friend

References INVENTOR_API, and SbVec2f().

◆ operator/

INVENTOR_API SbVec2f operator/ ( const SbVec2f & v,
float d )
friend

Definition at line 326 of file SbLinear.h.

References INVENTOR_API, and SbVec2f().

◆ operator==

INVENTOR_API bool operator== ( const SbVec2f & v1,
const SbVec2f & v2 )
friend

References INVENTOR_API, and SbVec2f().

Member Data Documentation

◆ vec

float SbVec2f::vec[2]
protected

Definition at line 320 of file SbLinear.h.

Referenced by getValue(), operator[](), operator[](), and SbVec2f().

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