Vectors/VectorAlgebra2D.hpp

Go to the documentation of this file.

//
// Thor C++ Library
// Copyright (c) 2011 Jan Haller
// 
// This software is provided 'as-is', without any express or implied
// warranty. In no event will the authors be held liable for any damages
// arising from the use of this software.
// 
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it
// freely, subject to the following restrictions:
// 
// 1. The origin of this software must not be misrepresented; you must not
//    claim that you wrote the original software. If you use this software
//    in a product, an acknowledgment in the product documentation would be
//    appreciated but is not required.
// 
// 2. Altered source versions must be plainly marked as such, and must not be
//    misrepresented as being the original software.
// 
// 3. This notice may not be removed or altered from any source distribution.
//


#ifndef THOR_VECTORALGEBRA2D_HPP
#define THOR_VECTORALGEBRA2D_HPP

#include <Thor/Math/Trigonometry.hpp>

#include <SFML/System/Vector2.hpp>
#include <SFML/System/Vector3.hpp>

#include <cassert>


namespace thor
{


template <typename T>
T                           Length(const sf::Vector2<T>& vector);

template <typename T>
T                           SquaredLength(const sf::Vector2<T>& vector);

template <typename T>
void                        SetLength(sf::Vector2<T>& vector, T newLength);

template <typename T>
sf::Vector2<T>              UnitVector(const sf::Vector2<T>& vector);

template <typename T>
T                           PolarAngle(const sf::Vector2<T>& vector);

template <typename T>
void                        SetPolarAngle(sf::Vector2<T>& vector, T newAngle);

template <typename T>
void                        Rotate(sf::Vector2<T>& vector, T angle);

template <typename T>
sf::Vector2<T>              RotatedVector(const sf::Vector2<T>& vector, T angle);

template <typename T>
sf::Vector2<T>              PerpendicularVector(const sf::Vector2<T>& vector);

// ---------------------------------------------------------------------------------------------------------------------------


template <typename T>
T                           Angle(const sf::Vector2<T>& lhs, const sf::Vector2<T>& rhs);

template <typename T>
T                           DotProduct(const sf::Vector2<T>& lhs, const sf::Vector2<T>& rhs);

template <typename T>
sf::Vector3<T>              CrossProduct(const sf::Vector2<T>& lhs, const sf::Vector2<T>& rhs);

template <typename T>
sf::Vector2<T>              ComponentwiseProduct(const sf::Vector2<T>& lhs, const sf::Vector2<T>& rhs);

template <typename T>
sf::Vector2<T>              ComponentwiseQuotient(const sf::Vector2<T>& lhs, const sf::Vector2<T>& rhs);

// ---------------------------------------------------------------------------------------------------------------------------


template <typename DestType, typename SourceType>
sf::Vector2<DestType>       ConvertVector(const sf::Vector2<SourceType>& vector);


} // namespace thor

#include <Thor/Detail/VectorAlgebra2D.inl>
#endif // THOR_VECTORALGEBRA2D_HPP