crown-engine/engine/core/math/Vector2.h

/*
Copyright (c) 2013 Daniele Bartolini, Michele Rossi
Copyright (c) 2012 Daniele Bartolini, Simone Boscaratto

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
*/

#pragma once

#include "Assert.h"
#include "Types.h"
#include "MathUtils.h"

namespace crown
{

/// 2D column vector.
class Vector2
{
public:

	float				x, y;

	/// Does nothing for efficiency.
						Vector2();		

	/// Initializes all the components to val							
						Vector2(float val);	

	/// Constructs from two components						
						Vector2(float nx, float ny);

	/// Constructs from array
						Vector2(const float v[2]);
						Vector2(const Vector2& a);					

	/// Random access by index
	float				operator[](uint32_t i) const;

	/// Random access by index			
	float&				operator[](uint32_t i);					

	Vector2				operator+(const Vector2& a) const;			
	Vector2&			operator+=(const Vector2& a);				
	Vector2 			operator-(const Vector2& a) const;			
	Vector2&			operator-=(const Vector2& a);				
	Vector2				operator*(float k) const;				
	Vector2&			operator*=(float k);						
	Vector2				operator/(float k) const;				
	Vector2&			operator/=(float k);

	/// Dot product						
	float				dot(const Vector2& a) const;				

	/// For simmetry
	friend Vector2		operator*(float k, const Vector2& a);		

	bool				operator==(const Vector2& other) const;	
	bool				operator!=(const Vector2& other) const;

	/// Returns whether all the components of this vector are smaller than all of the @a other vector	
	bool				operator<(const Vector2& other) const;		

	/// Returns whether all the components of this vector are greater than all of the @a other vector
	bool				operator>(const Vector2& other) const;		

	/// Returns the vector's length
	float				length() const;

	/// Returns the vector's squared length							
	float				squared_length() const;

	/// Sets the vector's length					
	void				set_length(float len);					
	float				get_angle() const;
	float				get_angle_2d() const;

	/// Normalizes the vector
	Vector2&			normalize();

	/// Returns the normalized vector							
	Vector2				get_normalized() const;

	/// Negates the vector (i.e. builds the inverse)					
	Vector2&			negate();

	/// Negates the vector (i.e. builds the inverse)								
	Vector2				operator-() const;						

	/// Returns the distance
	float				get_distance_to(const Vector2& a) const;

	/// Returns the angle in radian	
	float				get_angle_between(const Vector2& a) const;

	/// Sets all components to zero
	void				zero();

	/// Returns the pointer to the vector's data
	float*				to_float_ptr();	

	/// Returns the pointer to the vector's data						
	const float*		to_float_ptr() const;					

	static const Vector2	ZERO;
	static const Vector2	ONE;
	static const Vector2	XAXIS;
	static const Vector2	YAXIS;
};

//-----------------------------------------------------------------------------
inline Vector2::Vector2()
{
}

//-----------------------------------------------------------------------------
inline Vector2::Vector2(float val) : x(val), y(val)
{
}

//-----------------------------------------------------------------------------
inline Vector2::Vector2(float nx, float ny) : x(nx), y(ny)
{
}

//-----------------------------------------------------------------------------
inline Vector2::Vector2(const float a[2]) : x(a[0]), y(a[1])
{
}

//-----------------------------------------------------------------------------
inline Vector2::Vector2(const Vector2& a) : x(a.x), y(a.y)
{
}

//-----------------------------------------------------------------------------
inline float Vector2::operator[](uint32_t i) const
{
	CE_ASSERT(i < 2, "Index must be < 2");

	return (&x)[i];
}

//-----------------------------------------------------------------------------
inline float& Vector2::operator[](uint32_t i)
{
	CE_ASSERT(i < 2, "Index must be < 2");

	return (&x)[i];
}

//-----------------------------------------------------------------------------
inline Vector2 Vector2::operator+(const Vector2& a) const
{
	return Vector2(x + a.x, y + a.y);
}

//-----------------------------------------------------------------------------
inline Vector2& Vector2::operator+=(const Vector2& a)
{
	x += a.x;
	y += a.y;

	return *this;
}

//-----------------------------------------------------------------------------
inline Vector2 Vector2::operator-(const Vector2& a) const
{
	return Vector2(x - a.x, y - a.y);
}

//-----------------------------------------------------------------------------
inline Vector2& Vector2::operator-=(const Vector2& a)
{
	x -= a.x;
	y -= a.y;

	return *this;
}

//-----------------------------------------------------------------------------
inline Vector2 Vector2::operator*(float k) const
{
	return Vector2(x * k, y * k);
}

//-----------------------------------------------------------------------------
inline Vector2& Vector2::operator*=(float k)
{
	x *= k;
	y *= k;

	return *this;
}

//-----------------------------------------------------------------------------
inline Vector2 Vector2::operator/(float k) const
{
	CE_ASSERT(k != (float)0.0, "Division by zero");

	float inv = (float)(1.0 / k);

	return Vector2(x * inv, y * inv);
}

//-----------------------------------------------------------------------------
inline Vector2& Vector2::operator/=(float k)
{
	CE_ASSERT(k != (float)0.0, "Division by zero");

	float inv = (float)(1.0 / k);

	x *= inv;
	y *= inv;

	return *this;
}

//-----------------------------------------------------------------------------
inline float Vector2::dot(const Vector2& a) const
{
	return x * a.x + y * a.y;
}

//-----------------------------------------------------------------------------
inline bool Vector2::operator==(const Vector2& other) const
{
	return math::equals(x, other.x) && math::equals(y, other.y);
}

//-----------------------------------------------------------------------------
inline bool Vector2::operator!=(const Vector2& other) const
{
	return !math::equals(x, other.x) || !math::equals(y, other.y);
}

//-----------------------------------------------------------------------------
inline bool Vector2::operator<(const Vector2& other) const
{
	return ((x < other.x) && (y < other.y));
}

//-----------------------------------------------------------------------------
inline bool Vector2::operator>(const Vector2& other) const
{
	return ((x > other.x) && (y > other.y));
}

//-----------------------------------------------------------------------------
inline float Vector2::length() const
{
	return math::sqrt(x * x + y * y);
}

//-----------------------------------------------------------------------------
inline float Vector2::squared_length() const
{
	return x * x + y * y;
}

//-----------------------------------------------------------------------------
inline void Vector2::set_length(float len)
{
	normalize();

	x *= len;
	y *= len;
}

//-----------------------------------------------------------------------------
inline float Vector2::get_angle() const
{
	return math::atan2(y, x);
}

//-----------------------------------------------------------------------------
inline float Vector2::get_angle_2d() const
{
	return math::atan2(-y, x);
}

//-----------------------------------------------------------------------------
inline Vector2& Vector2::normalize()
{
	float len = length();

	if (math::equals(len, (float)0.0))
	{
		return *this;
	}

	x /= len;
	y /= len;

	return *this;
}

//-----------------------------------------------------------------------------
inline Vector2 Vector2::get_normalized() const
{
	Vector2 tmp(x, y);

	return tmp.normalize();
}

//-----------------------------------------------------------------------------
inline Vector2& Vector2::negate()
{
	x = -x;
	y = -y;

	return *this;
}

//-----------------------------------------------------------------------------
inline Vector2 Vector2::operator-() const
{
	return Vector2(-x, -y);
}

//-----------------------------------------------------------------------------
inline float Vector2::get_distance_to(const Vector2& a) const
{
	return (*this - a).length();
}

//-----------------------------------------------------------------------------
inline float Vector2::get_angle_between(const Vector2& a) const
{
	return math::acos(this->dot(a) / (this->length() * a.length()));
}

//-----------------------------------------------------------------------------
inline void Vector2::zero()
{
	x = 0.0;
	y = 0.0;
}

//-----------------------------------------------------------------------------
inline float* Vector2::to_float_ptr()
{
	return &x;
}

//-----------------------------------------------------------------------------
inline const float* Vector2::to_float_ptr() const
{
	return &x;
}

//-----------------------------------------------------------------------------
inline Vector2 get_projected_parallel(const Vector2& v, const Vector2& n)
{
	float n_len_q;
	n_len_q = n.length();
	n_len_q = n_len_q * n_len_q;

	return n * (v.dot(n) / n_len_q);
}

//-----------------------------------------------------------------------------
inline Vector2 get_projected_perpendicular(const Vector2& v, const Vector2& n)
{
	return v - get_projected_parallel(v, n);
}

//-----------------------------------------------------------------------------
inline Vector2 operator*(float k, const Vector2& a)
{
	return a * k;
}

} // namespace crown