synfig::Vector Class Reference

#include <vector.h>

List of all members.

Public Types
typedef Real	value_type
Public Member Functions
	Vector ()
	Vector (const value_type &x, const value_type &y)
bool	is_valid () const
value_type &	operator[] (const int &i)
const value_type &	operator[] (const int &i) const
const Vector &	operator+= (const Vector &rhs)
const Vector &	operator-= (const Vector &rhs)
const Vector &	operator *= (const value_type &rhs)
const Vector &	operator/= (const value_type &rhs)
Vector	operator+ (const Vector &rhs) const
Vector	operator- (const Vector &rhs) const
Vector	operator * (const value_type &rhs) const
Vector	operator/ (const value_type &rhs) const
Vector	operator- () const
value_type	operator * (const Vector &rhs) const
bool	operator== (const Vector &rhs) const
bool	operator!= (const Vector &rhs) const
value_type	mag_squared () const
	Returns the squared magnitude of the vector.
value_type	mag () const
	Returns the magnitude of the vector.
value_type	inv_mag () const
	Returns the reciprocal of the magnitude of the vector.
Vector	norm () const
	Returns a normalized version of the vector.
Vector	perp () const
	Returns a perpendicular version of the vector.
bool	is_equal_to (const Vector &rhs) const
Static Public Member Functions
static const Vector	zero ()

---

Detailed Description

Todo:

writeme

---

Member Typedef Documentation

typedef Real synfig::Vector::value_type

---

Constructor & Destructor Documentation

synfig::Vector::Vector

(

)

[inline]

synfig::Vector::Vector	(	const value_type &	x,
		const value_type &	y
	)			[inline]

---

Member Function Documentation

bool synfig::Vector::is_valid

(

)

const [inline]

value_type& synfig::Vector::operator[]

(

const int &

i

)

[inline]

const value_type& synfig::Vector::operator[]

(

const int &

i

)

const [inline]

const Vector& synfig::Vector::operator+=

(

const Vector &

rhs

)

[inline]

const Vector& synfig::Vector::operator-=

(

const Vector &

rhs

)

[inline]

const Vector& synfig::Vector::operator *=

(

const value_type &

rhs

)

[inline]

const Vector& synfig::Vector::operator/=

(

const value_type &

rhs

)

[inline]

Vector synfig::Vector::operator+

(

const Vector &

rhs

)

const [inline]

Vector synfig::Vector::operator-

(

const Vector &

rhs

)

const [inline]

Vector synfig::Vector::operator *

(

const value_type &

rhs

)

const [inline]

Vector synfig::Vector::operator/

(

const value_type &

rhs

)

const [inline]

Vector synfig::Vector::operator-

(

)

const [inline]

value_type synfig::Vector::operator *

(

const Vector &

rhs

)

const [inline]

bool synfig::Vector::operator==

(

const Vector &

rhs

)

const [inline]

bool synfig::Vector::operator!=

(

const Vector &

rhs

)

const [inline]

value_type synfig::Vector::mag_squared

(

)

const [inline]

Returns the squared magnitude of the vector.

value_type synfig::Vector::mag

(

)

const [inline]

Returns the magnitude of the vector.

value_type synfig::Vector::inv_mag

(

)

const [inline]

Returns the reciprocal of the magnitude of the vector.

Vector synfig::Vector::norm

(

)

const [inline]

Returns a normalized version of the vector.

Vector synfig::Vector::perp

(

)

const [inline]

Returns a perpendicular version of the vector.

bool synfig::Vector::is_equal_to

(

const Vector &

rhs

)

const [inline]

static const Vector synfig::Vector::zero

(

)

[inline, static]

---

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

• vector.h

---