kg: src/Vector.hh@39e59dd36b6e (annotated)

185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	1	#ifndef VECTOR_HH
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	2	#define VECTOR_HH
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	3
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	4	#include <iostream>
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	5	#include <cmath>
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	6
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	7	/**
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	8	* A 2D Vector class. Implements standard vector operations.
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	9	*/
370 39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	10	template <typename T> class VectorType {
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	11	public:
370 39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	12	/** Horizontal component */
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	13	T x;
370 39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	14	/** Vertical component */
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	15	T y;
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	16
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	17	/**
370 39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	18	* Default constructor. Values are zero
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	19	*/
370 39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	20	VectorType() :
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	21	x(0), y(0)
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	22	{
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	23
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	24	}
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	25
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	26	/**
370 39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	27	* Scalar constuctor.
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	28	*
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	29	* @param x Initial x-coordinate
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	30	* @param y Initial y-coordinate
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	31	*/
370 39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	32	VectorType (const T &x, const T &y) :
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	33	x(x), y(y)
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	34	{
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	35
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	36	}
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	37
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	38	/**
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	39	* Copy constructor.
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	40	*
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	41	* @param v Vector to be copied.
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	42	*/
370 39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	43	VectorType (const VectorType &v) :
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	44	x(v.x),
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	45	y(v.y)
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	46	{
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	47
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	48	}
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	49
370 39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	50	/**
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	51	* @name Standard operators
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	52	*
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	53	* @{
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	54	*/
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	55	VectorType& operator= (const VectorType &v) {
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	56	x = v.x;
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	57	y = v.y;
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	58
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	59	return *this;
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	60	}
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	61
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	62	VectorType operator+ (const VectorType &v) const {
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	63	return VectorType(x + v.x, y + v.y);
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	64	}
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	65
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	66	VectorType operator- (const VectorType &v) const {
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	67	return VectorType(x - v.x, y - v.y);
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	68	}
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	69
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	70	/** Unary minus (v + -v = 0) */
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	71	VectorType operator- (void) const {
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	72	return VectorType(-x, -y);
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	73	}
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	74
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	75	/** Scalar multiplication */
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	76	VectorType operator* (const T &scalar) const {
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	77	return VectorType(x * scalar, y * scalar);
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	78	}
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	79
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	80	/** Scalar division */
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	81	VectorType operator/ (const T &scalar) const {
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	82	return VectorType(x / scalar, y / scalar);
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	83	}
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	84
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	85	/** Dot product */
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	86	T operator* (const VectorType &v) const {
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	87	return (x * v.x + y * v.y);
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	88	}
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	89
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	90	void operator+= (const VectorType &v) {
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	91	x += v.x;
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	92	y += v.y;
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	93	}
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	94
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	95	void operator-= (const VectorType &v) {
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	96	x -= v.x;
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	97	y -= v.y;
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	98	}
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	99
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	100	void operator*= (const T &scalar) {
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	101	x *= scalar;
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	102	y *= scalar;
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	103	}
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	104
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	105	void operator/= (const T &scalar) {
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	106	x /= scalar;
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	107	y /= scalar;
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	108	}
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	109
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	110	/**
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	111	* XXX: This needs to do some rounding for float-vectors
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	112	*/
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	113	bool operator== (const VectorType &other) const {
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	114	return (x == other.x) && (y == other.y);
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	115	}
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	116
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	117	/**
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	118	* XXX: This needs to do some rounding for float-vectors
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	119	*/
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	120	bool operator!= (const VectorType &other) const {
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	121	return (x != other.x) \|\| (y != other.y);
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	122	}
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	123
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	124	// @}
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	125
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	126	/**
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	127	* Vector scalar length
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	128	*/
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	129	T length (void) const {
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	130	return sqrt(sqrLength());
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	131	}
370 39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	132
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	133	/**
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	134	* Vector scalar length, squared
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	135	*/
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	136	T sqrLength (void) const {
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	137	return (x * x) + (y * y);
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	138	}
370 39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	139
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	140	/**
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	141	* XXX: should be replaced with a working operator== implementation
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	142	*
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	143	* This doesn't actually round, it truncates
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	144	*/
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	145	VectorType roundToInt (void) const {
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	146	return VectorType((int)(x), (int)(y));
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	147	}
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	148
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	149	/**
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	150	* Test for a zero-length vector.
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	151	*
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	152	* XXX: this is currently only used when testing for Vector(0, 0), probably breaks otherwise
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	153	*/
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	154	bool zero (void) const {
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	155	return x == 0 && y == 0;
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	156	}
221 fbc5db6fce45 reorganize the weapons code and input handling code terom parents: 185 diff changeset	157
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	158	};
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	159
370 39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	160	/**
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	161	* @name Postfix operators
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	162	* Operators with the vector as the second argument :)
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	163	*
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	164	* @{
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	165	*/
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	166	template<typename T> VectorType<T> operator* (const T &scalar, const VectorType<T> &v) {
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	167	return (v * scalar);
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	168	}
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	169
370 39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	170	/**
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	171	* Make vectors printable
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	172	*/
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	173	template<typename T> std::ostream& operator<< (std::ostream &s, const VectorType<T> &v) {
39e59dd36b6e clean up Vector a bit, remove unused Terrain -> direction function terom parents: 300 diff changeset	174	return s << "(" << v.x << ", " << v.y << ")";
185 25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	175	}
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	176
25becd2cb026 that's not a prototype anymore... at least it shouldn't be terom parents: diff changeset	177	#endif

author	terom
	Mon, 15 Dec 2008 14:24:38 +0000
changeset 370	39e59dd36b6e
parent 300	417183866f35
child 377	01d3c340b372
permissions	-rw-r--r--