2D version of Vector More...

#include <frames.hpp>

Public Member Functions
	Vector2 ()
	Does not initialise to Zero().
	Vector2 (double x, double y)
	Vector2 (const Vector2 &arg)
	Vector2 (double *xyz)
	Vector2 (float *xyz)
Vector2 &	operator= (const Vector2 &arg)
double	operator() (int index) const
	Access to elements, range checked when NDEBUG is not set, from 0..1.
double &	operator() (int index)
	Access to elements, range checked when NDEBUG is not set, from 0..1.
void	GetValue (double *xy) const
	store vector components in array
void	ReverseSign ()
Vector2 &	operator-= (const Vector2 &arg)
Vector2 &	operator+= (const Vector2 &arg)
double	Normalize (double eps=epsilon)
double	Norm () const
void	Set3DXY (const Vector &v)
	projects v in its XY plane, and sets *this to these values
void	Set3DYZ (const Vector &v)
	projects v in its YZ plane, and sets *this to these values
void	Set3DZX (const Vector &v)
	projects v in its ZX plane, and sets *this to these values
void	Set3DPlane (const Frame &F_someframe_XY, const Vector &v_someframe)
	projects v_someframe in the XY plane of F_someframe_XY, and sets *this to these values expressed wrt someframe.

Static Public Member Functions
static Vector2	Zero ()

Friends
class	Rotation2
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, double rhs)
Vector2	operator+ (const Vector2 &lhs, const Vector2 &rhs)
Vector2	operator- (const Vector2 &lhs, const Vector2 &rhs)
Vector2	operator- (const Vector2 &arg)
void	SetToZero (Vector2 &v)
bool	Equal (const Vector2 &a, const Vector2 &b, double eps=epsilon)
	do not use operator == because the definition of Equal(.,.) is slightly different. It compares whether the 2 arguments are equal in an eps-interval

Detailed Description

2D version of Vector

Definition at line 915 of file frames.hpp.

Constructor & Destructor Documentation

◆ Vector2() [1/5]

KDL::Vector2::Vector2 ( )

inline

Does not initialise to Zero().

Definition at line 920 of file frames.hpp.

Referenced by KDL::Rotation2::Inverse().

◆ Vector2() [2/5]

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

inline

Definition at line 765 of file frames.hpp.

◆ Vector2() [3/5]

IMETHOD Vector2::Vector2 ( const Vector2 & arg )

inline

Definition at line 759 of file frames.hpp.

◆ Vector2() [4/5]

IMETHOD KDL::Vector2::Vector2 ( double * xyz )

inline

Definition at line 770 of file frames.hpp.

◆ Vector2() [5/5]

IMETHOD KDL::Vector2::Vector2 ( float * xyz )

inline

Definition at line 775 of file frames.hpp.

Member Function Documentation

◆ GetValue()

IMETHOD void Vector2::GetValue ( double * xy ) const

inline

store vector components in array

Definition at line 787 of file frames.hpp.

◆ Norm()

double KDL::Vector2::Norm ( ) const

inline

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 102 of file frames.cpp.

◆ operator()() [1/2]

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

inline

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

Definition at line 840 of file frames.hpp.

◆ operator()() [2/2]

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

inline

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

Definition at line 835 of file frames.hpp.

◆ operator+=()

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

inline

Definition at line 817 of file frames.hpp.

◆ operator-=()

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

inline

Definition at line 824 of file frames.hpp.

◆ operator=()

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

inline

Definition at line 780 of file frames.hpp.

◆ ReverseSign()

IMETHOD void Vector2::ReverseSign ( )

inline

Definition at line 845 of file frames.hpp.

◆ Set3DPlane()

IMETHOD void 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 877 of file frames.hpp.

◆ Set3DXY()

IMETHOD void Vector2::Set3DXY ( const Vector & v )

inline

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

Definition at line 858 of file frames.hpp.

◆ Set3DYZ()

IMETHOD void Vector2::Set3DYZ ( const Vector & v )

inline

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

Definition at line 864 of file frames.hpp.

◆ Set3DZX()

IMETHOD void Vector2::Set3DZX ( const Vector & v )

inline

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

Definition at line 870 of file frames.hpp.

◆ Zero()

IMETHOD Vector2 Vector2::Zero ( )

inlinestatic

Returns: a zero 2D vector.

Definition at line 831 of file frames.hpp.

◆ 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 1091 of file frames.hpp.

◆ operator* [1/3]

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

friend

◆ operator* [2/3]

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

friend

Definition at line 802 of file frames.hpp.

◆ operator* [3/3]

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

friend

Definition at line 807 of file frames.hpp.

◆ operator+

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

friend

Definition at line 792 of file frames.hpp.

◆ operator- [1/2]

Vector2 operator- ( const Vector2 & arg )

friend

Definition at line 852 of file frames.hpp.

◆ operator- [2/2]

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

friend

Definition at line 797 of file frames.hpp.

◆ operator/

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

friend

Definition at line 812 of file frames.hpp.

◆ Rotation2

friend class Rotation2

friend

Definition at line 983 of file frames.hpp.

◆ SetToZero

void SetToZero ( Vector2 & v )

friend

Definition at line 1117 of file frames.hpp.

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

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Vector2() [1/5]

◆ Vector2() [2/5]

◆ Vector2() [3/5]

◆ Vector2() [4/5]

◆ Vector2() [5/5]

Member Function Documentation

◆ GetValue()

◆ Norm()

◆ Normalize()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator+=()

◆ operator-=()

◆ operator=()

◆ ReverseSign()

◆ Set3DPlane()

◆ Set3DXY()

◆ Set3DYZ()

◆ Set3DZX()

◆ Zero()

Friends And Related Symbol Documentation

◆ Equal

◆ operator* [1/3]

◆ operator* [2/3]

◆ operator* [3/3]

◆ operator+

◆ operator- [1/2]

◆ operator- [2/2]

◆ operator/

◆ Rotation2

◆ SetToZero