summaryrefslogtreecommitdiff
path: root/include/SFML/System/Vector3.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'include/SFML/System/Vector3.hpp')
-rwxr-xr-xinclude/SFML/System/Vector3.hpp217
1 files changed, 217 insertions, 0 deletions
diff --git a/include/SFML/System/Vector3.hpp b/include/SFML/System/Vector3.hpp
new file mode 100755
index 0000000..0174c3f
--- /dev/null
+++ b/include/SFML/System/Vector3.hpp
@@ -0,0 +1,217 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2008 Laurent Gomila (laurent.gom@gmail.com)
+//
+// 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 SFML_VECTOR3_HPP
+#define SFML_VECTOR3_HPP
+
+
+namespace sf
+{
+////////////////////////////////////////////////////////////
+/// Vector3 is an utility class for manipulating 3 dimensional
+/// vectors. Template parameter defines the type of coordinates
+/// (integer, float, ...)
+////////////////////////////////////////////////////////////
+template <typename T>
+class Vector3
+{
+public :
+
+ ////////////////////////////////////////////////////////////
+ /// Default constructor
+ ///
+ ////////////////////////////////////////////////////////////
+ Vector3();
+
+ ////////////////////////////////////////////////////////////
+ /// Construct the vector from its coordinates
+ ///
+ /// \param X : X coordinate
+ /// \param Y : Y coordinate
+ /// \param Z : Z coordinate
+ ///
+ ////////////////////////////////////////////////////////////
+ Vector3(T X, T Y, T Z);
+
+ ////////////////////////////////////////////////////////////
+ // Member data
+ ////////////////////////////////////////////////////////////
+ T x; ///< X coordinate of the vector
+ T y; ///< Y coordinate of the vector
+ T z; ///< Z coordinate of the vector
+};
+
+////////////////////////////////////////////////////////////
+/// Operator - overload ; returns the opposite of a vector
+///
+/// \param V : Vector to negate
+///
+/// \return -V
+///
+////////////////////////////////////////////////////////////
+template <typename T>
+Vector3<T> operator -(const Vector3<T>& V);
+
+////////////////////////////////////////////////////////////
+/// Operator += overload ; add two vectors and assign to the first op
+///
+/// \param V1 : First vector
+/// \param V2 : Second vector
+///
+/// \return V1 + V2
+///
+////////////////////////////////////////////////////////////
+template <typename T>
+Vector3<T>& operator +=(Vector3<T>& V1, const Vector3<T>& V2);
+
+////////////////////////////////////////////////////////////
+/// Operator -= overload ; subtract two vectors and assign to the first op
+///
+/// \param V1 : First vector
+/// \param V2 : Second vector
+///
+/// \return V1 - V2
+///
+////////////////////////////////////////////////////////////
+template <typename T>
+Vector3<T>& operator -=(Vector3<T>& V1, const Vector3<T>& V2);
+
+////////////////////////////////////////////////////////////
+/// Operator + overload ; adds two vectors
+///
+/// \param V1 : First vector
+/// \param V2 : Second vector
+///
+/// \return V1 + V2
+///
+////////////////////////////////////////////////////////////
+template <typename T>
+Vector3<T> operator +(const Vector3<T>& V1, const Vector3<T>& V2);
+
+////////////////////////////////////////////////////////////
+/// Operator - overload ; subtracts two vectors
+///
+/// \param V1 : First vector
+/// \param V2 : Second vector
+///
+/// \return V1 - V2
+///
+////////////////////////////////////////////////////////////
+template <typename T>
+Vector3<T> operator -(const Vector3<T>& V1, const Vector3<T>& V2);
+
+////////////////////////////////////////////////////////////
+/// Operator * overload ; multiply a vector by a scalar value
+///
+/// \param V : Vector
+/// \param X : Scalar value
+///
+/// \return V * X
+///
+////////////////////////////////////////////////////////////
+template <typename T>
+Vector3<T> operator *(const Vector3<T>& V, T X);
+
+////////////////////////////////////////////////////////////
+/// Operator * overload ; multiply a scalar value by a vector
+///
+/// \param X : Scalar value
+/// \param V : Vector
+///
+/// \return X * V
+///
+////////////////////////////////////////////////////////////
+template <typename T>
+Vector3<T> operator *(T X, const Vector3<T>& V);
+
+////////////////////////////////////////////////////////////
+/// Operator *= overload ; multiply-assign a vector by a scalar value
+///
+/// \param V : Vector
+/// \param X : Scalar value
+///
+/// \return V * X
+///
+////////////////////////////////////////////////////////////
+template <typename T>
+Vector3<T>& operator *=(Vector3<T>& V, T X);
+
+////////////////////////////////////////////////////////////
+/// Operator / overload ; divide a vector by a scalar value
+///
+/// \param V : Vector
+/// \param X : Scalar value
+///
+/// \return V / X
+///
+////////////////////////////////////////////////////////////
+template <typename T>
+Vector3<T> operator /(const Vector3<T>& V, T X);
+
+////////////////////////////////////////////////////////////
+/// Operator /= overload ; divide-assign a vector by a scalar value
+///
+/// \param V : Vector
+/// \param X : Scalar value
+///
+/// \return V / X
+///
+////////////////////////////////////////////////////////////
+template <typename T>
+Vector3<T>& operator /=(Vector3<T>& V, T X);
+
+////////////////////////////////////////////////////////////
+/// Operator == overload ; compares the equality of two vectors
+///
+/// \param V1 : First vector
+/// \param V2 : Second vector
+///
+/// \return True if V1 is equal to V2
+///
+////////////////////////////////////////////////////////////
+template <typename T>
+bool operator ==(const Vector3<T>& V1, const Vector3<T>& V2);
+
+////////////////////////////////////////////////////////////
+/// Operator != overload ; compares the difference of two vectors
+///
+/// \param V1 : First vector
+/// \param V2 : Second vector
+///
+/// \return True if V1 is different than V2
+///
+////////////////////////////////////////////////////////////
+template <typename T>
+bool operator !=(const Vector3<T>& V1, const Vector3<T>& V2);
+
+#include <SFML/System/Vector3.inl>
+
+// Define the most common types
+typedef Vector3<int> Vector3i;
+typedef Vector3<float> Vector3f;
+
+} // namespace sf
+
+
+#endif // SFML_VECTOR3_HPP