Public Member Functions | Static Public Member Functions | Private Attributes | Friends | List of all members
KDL::Vector2 Class Reference

2D version of Vector More...

#include <frames.hpp>

Public Member Functions

double Norm (double eps=epsilon) const
 
double Normalize (double eps=epsilon)
 
double operator() (int index) const
 Access to elements, range checked when NDEBUG is not set, from 0..1. More...
 
double & operator() (int index)
 Access to elements, range checked when NDEBUG is not set, from 0..1. More...
 
Vector2operator+= (const Vector2 &arg)
 
Vector2operator-= (const Vector2 &arg)
 
Vector2operator= (const Vector2 &arg)
 
double operator[] (int index) const
 Equivalent to double operator()(int index) const. More...
 
double & operator[] (int index)
 Equivalent to double& operator()(int index) More...
 
void ReverseSign ()
 
void Set3DPlane (const Frame &F_someframe_XY, const Vector &v_someframe)
 
void Set3DXY (const Vector &v)
 projects v in its XY plane, and sets *this to these values More...
 
void Set3DYZ (const Vector &v)
 projects v in its YZ plane, and sets *this to these values More...
 
void Set3DZX (const Vector &v)
 projects v in its ZX plane, and sets *this to these values More...
 
 Vector2 ()
 Does not initialise to Zero(). More...
 
 Vector2 (double x, double y)
 
 Vector2 (const Vector2 &arg)
 
double x () const
 
void x (double)
 
double y () const
 
void y (double)
 

Static Public Member Functions

static Vector2 Zero ()
 

Private Attributes

double data [2]
 

Friends

bool Equal (const Vector2 &a, const Vector2 &b, double eps)
 
bool operator!= (const Vector2 &a, const Vector2 &b)
 The literal inequality operator!=(). More...
 
Vector2 operator* (const Vector2 &lhs, double rhs)
 
Vector2 operator* (double lhs, const Vector2 &rhs)
 
Vector2 operator* (const Vector2 &lhs, const Vector2 &rhs)
 
Vector2 operator+ (const Vector2 &lhs, const Vector2 &rhs)
 
Vector2 operator- (const Vector2 &lhs, const Vector2 &rhs)
 
Vector2 operator- (const Vector2 &arg)
 
Vector2 operator/ (const Vector2 &lhs, double rhs)
 
bool operator== (const Vector2 &a, const Vector2 &b)
 The literal equality operator==(), also identical. More...
 
class Rotation2
 
void SetToZero (Vector2 &v)
 

Detailed Description

2D version of Vector

Definition at line 959 of file frames.hpp.

Constructor & Destructor Documentation

◆ Vector2() [1/3]

KDL::Vector2::Vector2 ( )
inline

Does not initialise to Zero().

Definition at line 964 of file frames.hpp.

◆ Vector2() [2/3]

IMETHOD KDL::Vector2::Vector2 ( double  x,
double  y 
)
inline

Definition at line 732 of file frames.hpp.

◆ Vector2() [3/3]

IMETHOD KDL::Vector2::Vector2 ( const Vector2 arg)
inline

Definition at line 726 of file frames.hpp.

Member Function Documentation

◆ Norm()

double KDL::Vector2::Norm ( double  eps = epsilon) const
Returns
the norm of the vector

Definition at line 87 of file frames.cpp.

◆ Normalize()

double KDL::Vector2::Normalize ( double  eps = epsilon)

Normalizes this vector and returns it norm makes v a unitvector and returns the norm of v. if v is smaller than eps, Vector(1,0,0) is returned with norm 0. if this is not good, check the return value of this method.

Definition at line 104 of file frames.cpp.

◆ operator()() [1/2]

IMETHOD double KDL::Vector2::operator() ( int  index) const
inline

Access to elements, range checked when NDEBUG is not set, from 0..1.

Definition at line 789 of file frames.hpp.

◆ operator()() [2/2]

IMETHOD double & KDL::Vector2::operator() ( int  index)
inline

Access to elements, range checked when NDEBUG is not set, from 0..1.

Definition at line 794 of file frames.hpp.

◆ operator+=()

IMETHOD Vector2 & KDL::Vector2::operator+= ( const Vector2 arg)
inline

Definition at line 771 of file frames.hpp.

◆ operator-=()

IMETHOD Vector2 & KDL::Vector2::operator-= ( const Vector2 arg)
inline

Definition at line 778 of file frames.hpp.

◆ operator=()

IMETHOD Vector2 & KDL::Vector2::operator= ( const Vector2 arg)
inline

Definition at line 738 of file frames.hpp.

◆ operator[]() [1/2]

double KDL::Vector2::operator[] ( int  index) const
inline

Equivalent to double operator()(int index) const.

Definition at line 977 of file frames.hpp.

◆ operator[]() [2/2]

double& KDL::Vector2::operator[] ( int  index)
inline

Equivalent to double& operator()(int index)

Definition at line 983 of file frames.hpp.

◆ ReverseSign()

IMETHOD void KDL::Vector2::ReverseSign ( )
inline

Definition at line 807 of file frames.hpp.

◆ Set3DPlane()

IMETHOD void KDL::Vector2::Set3DPlane ( const Frame F_someframe_XY,
const Vector v_someframe 
)
inline

projects v_someframe in the XY plane of F_someframe_XY, and sets *this to these values expressed wrt someframe.

Definition at line 839 of file frames.hpp.

◆ Set3DXY()

IMETHOD void KDL::Vector2::Set3DXY ( const Vector v)
inline

projects v in its XY plane, and sets *this to these values

Definition at line 820 of file frames.hpp.

◆ Set3DYZ()

IMETHOD void KDL::Vector2::Set3DYZ ( const Vector v)
inline

projects v in its YZ plane, and sets *this to these values

Definition at line 826 of file frames.hpp.

◆ Set3DZX()

IMETHOD void KDL::Vector2::Set3DZX ( const Vector v)
inline

projects v in its ZX plane, and sets *this to these values

Definition at line 832 of file frames.hpp.

◆ x() [1/2]

IMETHOD double KDL::Vector2::x ( ) const
inline

Definition at line 800 of file frames.hpp.

◆ x() [2/2]

IMETHOD void KDL::Vector2::x ( double  _x)
inline

Definition at line 803 of file frames.hpp.

◆ y() [1/2]

IMETHOD double KDL::Vector2::y ( ) const
inline

Definition at line 801 of file frames.hpp.

◆ y() [2/2]

IMETHOD void KDL::Vector2::y ( double  _y)
inline

Definition at line 804 of file frames.hpp.

◆ Zero()

IMETHOD Vector2 KDL::Vector2::Zero ( )
inlinestatic
Returns
a zero 2D vector.

Definition at line 785 of file frames.hpp.

Friends And Related Function Documentation

◆ Equal

bool Equal ( const Vector2 a,
const Vector2 b,
double  eps = epsilon 
)
friend

do not use operator == because the definition of Equal(.,.) is slightly different. It compares whether the 2 arguments are equal in an eps-interval

Definition at line 1055 of file frames.hpp.

◆ operator!=

bool operator!= ( const Vector2 a,
const Vector2 b 
)
friend

The literal inequality operator!=().

Definition at line 1341 of file frames.hpp.

◆ operator* [1/3]

Vector2 operator* ( const Vector2 lhs,
double  rhs 
)
friend

Definition at line 756 of file frames.hpp.

◆ operator* [2/3]

Vector2 operator* ( double  lhs,
const Vector2 rhs 
)
friend

Definition at line 761 of file frames.hpp.

◆ operator* [3/3]

Vector2 operator* ( const Vector2 lhs,
const Vector2 rhs 
)
friend

◆ operator+

Vector2 operator+ ( const Vector2 lhs,
const Vector2 rhs 
)
friend

Definition at line 746 of file frames.hpp.

◆ operator- [1/2]

Vector2 operator- ( const Vector2 lhs,
const Vector2 rhs 
)
friend

Definition at line 751 of file frames.hpp.

◆ operator- [2/2]

Vector2 operator- ( const Vector2 arg)
friend

Definition at line 814 of file frames.hpp.

◆ operator/

Vector2 operator/ ( const Vector2 lhs,
double  rhs 
)
friend

Definition at line 766 of file frames.hpp.

◆ operator==

bool operator== ( const Vector2 a,
const Vector2 b 
)
friend

The literal equality operator==(), also identical.

Definition at line 1332 of file frames.hpp.

◆ Rotation2

friend class Rotation2
friend

Definition at line 1044 of file frames.hpp.

◆ SetToZero

void SetToZero ( Vector2 v)
friend

Definition at line 1081 of file frames.hpp.

Member Data Documentation

◆ data

double KDL::Vector2::data[2]
private

Definition at line 961 of file frames.hpp.


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


orocos_kdl
Author(s):
autogenerated on Tue Sep 1 2020 03:18:51