aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/api/Vector2.h
blob: bf9d12431fb3d5c8d867b8f3ac686bb0620d1654 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
#pragma once

namespace crepe {

//! 2D vector
template <class T>
struct Vector2 {
	//! X component of the vector
	T x = 0;
	//! Y component of the vector
	T y = 0;

	//! Subtracts another vector from this vector and returns the result.
	Vector2 operator-(const Vector2<T> & other) const;

	//! Subtracts a scalar value from both components of this vector and returns the result.
	Vector2 operator-(T scalar) const;

	//! Adds another vector to this vector and returns the result.
	Vector2 operator+(const Vector2<T> & other) const;

	//! Adds a scalar value to both components of this vector and returns the result.
	Vector2 operator+(T scalar) const;

	//! Multiplies this vector by another vector element-wise and returns the result.
	Vector2 operator*(const Vector2<T> & other) const;

	//! Multiplies this vector by a scalar and returns the result.
	Vector2 operator*(T scalar) const;

	//! Divides this vector by another vector element-wise and returns the result.
	Vector2 operator/(const Vector2<T> & other) const;

	//! Divides this vector by a scalar and returns the result.
	Vector2 operator/(T scalar) const;

	//! Adds another vector to this vector and updates this vector.
	Vector2 & operator+=(const Vector2<T> & other);

	//! Adds a scalar value to both components of this vector and updates this vector.
	Vector2 & operator+=(T other);

	//! Subtracts another vector from this vector and updates this vector.
	Vector2 & operator-=(const Vector2<T> & other);

	//! Subtracts a scalar value from both components of this vector and updates this vector.
	Vector2 & operator-=(T other);

	//! Multiplies this vector by another vector element-wise and updates this vector.
	Vector2 & operator*=(const Vector2<T> & other);

	//! Multiplies this vector by a scalar and updates this vector.
	Vector2 & operator*=(T other);

	//! Divides this vector by another vector element-wise and updates this vector.
	Vector2 & operator/=(const Vector2<T> & other);

	//! Divides this vector by a scalar and updates this vector.
	Vector2 & operator/=(T other);

	//! Returns the negation of this vector.
	Vector2 operator-() const;

	//! Checks if this vector is equal to another vector.
	bool operator==(const Vector2<T> & other) const;

	//! Checks if this vector is not equal to another vector.
	bool operator!=(const Vector2<T> & other) const;

	//! Truncates the vector to a maximum length.
	void truncate(T max);

	//! Normalizes the vector (resulting in vector with a length of 1).
	void normalize();

	//! Returns the length of the vector.
	T length() const;

	//! Returns the squared length of the vector.
	T length_squared() const;

	//! Returns the dot product (inwendig product) of this vector and another vector.
	T dot(const Vector2<T> & other) const;

	//! Returns the distance between this vector and another vector.
	T distance(const Vector2<T> & other) const;

	//! Returns the squared distance between this vector and another vector.
	T distance_squared(const Vector2<T> & other) const;

	//! Returns the perpendicular vector to this vector.
	Vector2 perpendicular() const;
};

} // namespace crepe

#include "Vector2.hpp"