jade::basic_vec2< TValue > Class Template Reference

A template for a class that implements rank-two vector operations. More...

#include <jade.vec2.hpp>

Inheritance diagram for jade::basic_vec2< TValue >:

Collaboration diagram for jade::basic_vec2< TValue >:

Public Types
typedef TValue	value_type
	The value type. More...

Public Member Functions
	basic_vec2 ()
	Implements a new insatnce of the class. More...
	basic_vec2 (const value_type x_, const value_type y_)
	Implements a new insatnce of the class with the specified values. More...
value_type	get_length () const
value_type	get_length_squared () const
basic_vec2 &	operator+= (const basic_vec2 &rhs)
basic_vec2 &	operator+= (const value_type &rhs)
basic_vec2 &	operator-= (const basic_vec2 &rhs)
basic_vec2 &	operator-= (const value_type &rhs)
basic_vec2 &	operator*= (const value_type &rhs)
basic_vec2 &	operator/= (const value_type &rhs)
basic_vec2	operator+ (const value_type &rhs) const
basic_vec2	operator+ (const basic_vec2 &rhs) const
basic_vec2	operator- (const value_type &rhs) const
basic_vec2	operator- (const basic_vec2 &rhs) const
basic_vec2	operator* (const value_type &rhs) const
basic_vec2	operator/ (const value_type &rhs) const

Static Public Member Functions
static value_type	cross (const basic_vec2 &lhs, const basic_vec2 &rhs)
static value_type	distance (const basic_vec2 &a, const basic_vec2 &b)
static value_type	distance_squared (const basic_vec2 &a, const basic_vec2 &b)
static basic_vec2	dot (const basic_vec2 &a, const basic_vec2 &b)
static basic_vec2	lerp (const basic_vec2 &src, const basic_vec2 &dst, const value_type percent)
static basic_vec2	max (const basic_vec2 &a, const basic_vec2 &b)
static basic_vec2	min (const basic_vec2 &a, const basic_vec2 &b)
static basic_vec2	normalize (const basic_vec2 &v)

Data Fields
value_type	x
	The X coordinate. More...
value_type	y
	The Y coordinate. More...

Detailed Description

template<typename TValue>
class jade::basic_vec2< TValue >

A template for a class that implements rank-two vector operations.

Definition at line 18 of file jade.vec2.hpp.

Member Typedef Documentation

value_type

template<typename TValue >

typedef TValue jade::basic_vec2< TValue >::value_type

The value type.

Definition at line 21 of file jade.vec2.hpp.

Constructor & Destructor Documentation

basic_vec2() [1/2]

template<typename TValue >

jade::basic_vec2< TValue >::basic_vec2 ( )

inline

Implements a new insatnce of the class.

Definition at line 29 of file jade.vec2.hpp.

            : x (0)
            , y (0)
        {
        }

Here is the caller graph for this function:

basic_vec2() [2/2]

template<typename TValue >

jade::basic_vec2< TValue >::basic_vec2 ( const value_type  x_, const value_type  y_  )

inline

Implements a new insatnce of the class with the specified values.

Parameters

x_	The initial X coordinate.
y_	The initial Y coordinate.

Definition at line 38 of file jade.vec2.hpp.

            : x (x_)
            , y (y_)
        {
        }

Member Function Documentation

cross()

template<typename TValue >

static value_type jade::basic_vec2< TValue >::cross ( const basic_vec2< TValue > &  lhs, const basic_vec2< TValue > &  rhs  )

inlinestatic

Returns

The cross product for two vectors.

Parameters

lhs	The first vector.
rhs	The second vector.

Definition at line 49 of file jade.vec2.hpp.

        {
            return (lhs.x * rhs.y) - (lhs.y * rhs.x);
        }

distance()

template<typename TValue >

static value_type jade::basic_vec2< TValue >::distance ( const basic_vec2< TValue > &  a, const basic_vec2< TValue > &  b  )

inlinestatic

Returns

The distance between two vectors.

Parameters

a	The first vector.
b	The second vector.

Definition at line 59 of file jade.vec2.hpp.

        {
            return (a - b).get_length();
        }

distance_squared()

template<typename TValue >

static value_type jade::basic_vec2< TValue >::distance_squared ( const basic_vec2< TValue > &  a, const basic_vec2< TValue > &  b  )

inlinestatic

Returns

The distance between two vectors.

Parameters

a	The first vector.
b	The second vector.

Definition at line 69 of file jade.vec2.hpp.

        {
            return (a - b).get_length_squared();
        }

dot()

template<typename TValue >

static basic_vec2 jade::basic_vec2< TValue >::dot ( const basic_vec2< TValue > &  a, const basic_vec2< TValue > &  b  )

inlinestatic

Returns

The dot product of two vectors.

Parameters

a	The first vector.
b	The second vector.

Definition at line 79 of file jade.vec2.hpp.

        {
            return basic_vec2(a.x * b.x, a.y * b.y);
        }

get_length()

template<typename TValue >

value_type jade::basic_vec2< TValue >::get_length ( ) const

inline

Returns

The length of the vector.

Definition at line 89 of file jade.vec2.hpp.

        {
            return std::sqrt(get_length_squared());
        }

Here is the caller graph for this function:

get_length_squared()

template<typename TValue >

value_type jade::basic_vec2< TValue >::get_length_squared ( ) const

inline

Returns

The length of the vector.

Definition at line 97 of file jade.vec2.hpp.

        {
            return (x * x) + (y * y);
        }

Here is the caller graph for this function:

lerp()

template<typename TValue >

static basic_vec2 jade::basic_vec2< TValue >::lerp ( const basic_vec2< TValue > &  src, const basic_vec2< TValue > &  dst, const value_type  percent  )

inlinestatic

Returns

A new vector from linearly interpolating between two other vectors.

Parameters

src	The first vector.
dst	The second vector.
percent	The percentage.

Definition at line 106 of file jade.vec2.hpp.

        {
            return src + (dst - src) * percent;
        }

max()

template<typename TValue >

static basic_vec2 jade::basic_vec2< TValue >::max ( const basic_vec2< TValue > &  a, const basic_vec2< TValue > &  b  )

inlinestatic

Returns

The maximum of two vectors.

Parameters

a	The first vector.
b	The second vector.

Definition at line 117 of file jade.vec2.hpp.

        {
            return basic_vec2(std::max(a.x, b.x), std::max(a.y, b.y));
        }

min()

template<typename TValue >

static basic_vec2 jade::basic_vec2< TValue >::min ( const basic_vec2< TValue > &  a, const basic_vec2< TValue > &  b  )

inlinestatic

Returns

The minimum of two vectors.

Parameters

a	The first vector.
b	The second vector.

Definition at line 127 of file jade.vec2.hpp.

        {
            return basic_vec2(std::min(a.x, b.x), std::min(a.y, b.y));
        }

normalize()

template<typename TValue >

static basic_vec2 jade::basic_vec2< TValue >::normalize ( const basic_vec2< TValue > &  v )

inlinestatic

Returns

The normal for the specified vector.

Parameters

v	The vector.

Definition at line 137 of file jade.vec2.hpp.

        {
            return v / v.get_length();
        }

operator*()

template<typename TValue >

basic_vec2 jade::basic_vec2< TValue >::operator* ( const value_type &  rhs ) const

inline

Returns

A new vector based on the specified operator.

Parameters

rhs	The right operand.

Definition at line 252 of file jade.vec2.hpp.

        {
            return basic_vec2(*this) *= rhs;
        }

operator*=()

template<typename TValue >

basic_vec2& jade::basic_vec2< TValue >::operator*= ( const value_type &  rhs )

inline

Returns

This instance after the operation with the specified value.

Parameters

rhs	The right operand.

Definition at line 190 of file jade.vec2.hpp.

        {
            x *= rhs;
            y *= rhs;
            return *this;
        }

operator+() [1/2]

template<typename TValue >

basic_vec2 jade::basic_vec2< TValue >::operator+ ( const basic_vec2< TValue > &  rhs ) const

inline

Returns

A new vector based on the specified operator.

Parameters

rhs	The right operand.

Definition at line 222 of file jade.vec2.hpp.

        {
            return basic_vec2(*this) += rhs;
        }

operator+() [2/2]

template<typename TValue >

basic_vec2 jade::basic_vec2< TValue >::operator+ ( const value_type &  rhs ) const

inline

Returns

A new vector based on the specified operator.

Parameters

rhs	The right operand.

Definition at line 212 of file jade.vec2.hpp.

        {
            return basic_vec2(*this) += rhs;
        }

operator+=() [1/2]

template<typename TValue >

basic_vec2& jade::basic_vec2< TValue >::operator+= ( const basic_vec2< TValue > &  rhs )

inline

Returns

This instance after the operation with the specified value.

Parameters

rhs	The right operand.

Definition at line 146 of file jade.vec2.hpp.

        {
            x += rhs.x;
            y += rhs.y;
            return *this;
        }

operator+=() [2/2]

template<typename TValue >

basic_vec2& jade::basic_vec2< TValue >::operator+= ( const value_type &  rhs )

inline

Returns

This instance after the operation with the specified value.

Parameters

rhs	The right operand.

Definition at line 157 of file jade.vec2.hpp.

        {
            x += rhs;
            y += rhs;
            return *this;
        }

operator-() [1/2]

template<typename TValue >

basic_vec2 jade::basic_vec2< TValue >::operator- ( const basic_vec2< TValue > &  rhs ) const

inline

Returns

A new vector based on the specified operator.

Parameters

rhs	The right operand.

Definition at line 242 of file jade.vec2.hpp.

        {
            return basic_vec2(*this) -= rhs;
        }

operator-() [2/2]

template<typename TValue >

basic_vec2 jade::basic_vec2< TValue >::operator- ( const value_type &  rhs ) const

inline

Returns

A new vector based on the specified operator.

Parameters

rhs	The right operand.

Definition at line 232 of file jade.vec2.hpp.

        {
            return basic_vec2(*this) -= rhs;
        }

operator-=() [1/2]

template<typename TValue >

basic_vec2& jade::basic_vec2< TValue >::operator-= ( const basic_vec2< TValue > &  rhs )

inline

Returns

This instance after the operation with the specified value.

Parameters

rhs	The right operand.

Definition at line 168 of file jade.vec2.hpp.

        {
            x -= rhs.x;
            y -= rhs.y;
            return *this;
        }

operator-=() [2/2]

template<typename TValue >

basic_vec2& jade::basic_vec2< TValue >::operator-= ( const value_type &  rhs )

inline

Returns

This instance after the operation with the specified value.

Parameters

rhs	The right operand.

Definition at line 179 of file jade.vec2.hpp.

        {
            x -= rhs;
            y -= rhs;
            return *this;
        }

operator/()

template<typename TValue >

basic_vec2 jade::basic_vec2< TValue >::operator/ ( const value_type &  rhs ) const

inline

Returns

A new vector based on the specified operator.

Parameters

rhs	The right operand.

Definition at line 262 of file jade.vec2.hpp.

        {
            return basic_vec2(*this) /= rhs;
        }

operator/=()

template<typename TValue >

basic_vec2& jade::basic_vec2< TValue >::operator/= ( const value_type &  rhs )

inline

Returns

This instance after the operation with the specified value.

Parameters

rhs	The right operand.

Definition at line 201 of file jade.vec2.hpp.

        {
            x /= rhs;
            y /= rhs;
            return *this;
        }

Field Documentation

x

template<typename TValue >

value_type jade::basic_vec2< TValue >::x

The X coordinate.

Definition at line 23 of file jade.vec2.hpp.

y

template<typename TValue >

value_type jade::basic_vec2< TValue >::y

The Y coordinate.

Definition at line 24 of file jade.vec2.hpp.

---

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

• jade.vec2.hpp