vector.h

Go to the documentation of this file.

/*********************************************************************************
** Copyright (c) 2020 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************************/

#pragma  once

#include "legionDataStore/export.h"
#include "legionDataStore/datatypes.h"
#include <ostream>

namespace Legion
{
   class Vector2d;

//---------------------------------Vector2 Float --------------------------------------

   class LEGION_DLL Vector2f
   {
   public:
      //constructors
      Vector2f();
      Vector2f(const float x, const float y);
      Vector2f(const float* tuple);
      Vector2f(const Vector2f& other);
      Vector2f(const Vector2d& other);

      //assignment
      inline Vector2f& operator= (const Vector2f& vec);

      //comparison
      inline bool operator== (const Vector2f& vec) const;
      inline bool operator!= (const Vector2f& vec) const;
      inline bool operator<  (const Vector2f& vec) const;
      inline bool operator<= (const Vector2f& vec) const;
      inline bool operator>  (const Vector2f& vec) const;
      inline bool operator>= (const Vector2f& vec) const;

      //arithmetic operations
      inline Vector2f operator+ (const Vector2f& vec) const;
      inline Vector2f operator- (const Vector2f& vec) const;
      inline Vector2f operator* (float scalar) const;
      inline Vector2f operator/ (float scalar) const;
      inline Vector2f operator- () const;

      //arithmetic updates
      inline Vector2f& operator+= (const Vector2f& vec);
      inline Vector2f& operator-= (const Vector2f& vec);
      inline Vector2f& operator*= (float scalar);
      inline Vector2f& operator/= (float scalar);

      //vector operations
      inline float length() const;
      inline float lengthSquared() const;
      inline float dot(const Vector2f& vec) const;
      inline float normalize();
      inline float distanceFrom(const Vector2f& other) const;
      inline float distanceFromSquared(const Vector2f& other) const;
      inline void setLength(float newLength);
      inline void invert();

      inline bool isZero();

      //perpendicular operations
      // returns (y,-x)
      inline Vector2f perpendicular() const;
      // returns (y,-x)/sqrt(x*x+y*y)
      inline Vector2f unitPerp() const;
      // returns DotPerp((x,y),(V.x,V.y)) = x*V.y - y*V.x
      inline float dotPerp(const Vector2f& vec) const;

      //functions
      inline void rotateBy(float degrees, const Vector2f& center);

      inline float angleTrig() const;

      inline float angle() const;

      inline float angleBetween(const Vector2f& b) const;


      inline bool isBetweenPoints(const Vector2f& begin, const Vector2f& end) const;

      static Vector2f interpolate(const Vector2f& v0, const Vector2f& v1, float t);

      union {
         struct {
            float x;
            float y;
         };
         float data[2];
      };
   };

   LEGION_DLL Vector2f operator* (float scalar, const Vector2f& vec);

   // debugging output
   LEGION_DLL std::ostream& operator<< (std::ostream& outputStr, const Vector2f& vec);

//---------------------------------Vector2 Double --------------------------------------

   class LEGION_DLL  Vector2d
   {
   public:
      //constructors
      Vector2d();
      Vector2d(double x, double y);
      Vector2d(const double* tuple);
      Vector2d(const Vector2d& other);
      Vector2d(const Vector2f& other);

      //assignment
      inline Vector2d& operator= (const Vector2d& vec);

      //comparison
      inline bool operator== (const Vector2d& vec) const;
      inline bool operator!= (const Vector2d& vec) const;
      inline bool operator<  (const Vector2d& vec) const;
      inline bool operator<= (const Vector2d& vec) const;
      inline bool operator>  (const Vector2d& vec) const;
      inline bool operator>= (const Vector2d& vec) const;

      //arithmetic operations
      inline Vector2d operator+ (const Vector2d& vec) const;
      inline Vector2d operator- (const Vector2d& vec) const;
      inline Vector2d operator* (double scalar) const;
      inline Vector2d operator/ (double scalar) const;
      inline Vector2d operator- () const;

      //arithmetic updates
      inline Vector2d& operator+= (const Vector2d& vec);
      inline Vector2d& operator-= (const Vector2d& vec);
      inline Vector2d& operator*= (double scalar);
      inline Vector2d& operator/= (double scalar);

      //vector operations
      inline double length() const;
      inline double lengthSquared() const;
      inline double dot(const Vector2d& vec) const;
      inline double normalize();
      inline double distanceFrom(const Vector2d& other) const;
      inline double distanceFromSquared(const Vector2d& other) const;
      inline void setLength(double newLength);
      inline void invert();

      inline bool isZero();

      //perpendicular operations
      // returns (y,-x)
      inline Vector2d perpendicular() const;
      // returns (y,-x)/sqrt(x*x+y*y)
      inline Vector2d unitPerp() const;
      // returns DotPerp((x,y),(V.x,V.y)) = x*V.y - y*V.x
      inline double dotPerp(const Vector2d& vec) const;

      //functions
      inline void rotateBy(double degrees, const Vector2d& center);

      inline double angleTrig() const;

      inline double angle() const;

      inline double angleBetween(const Vector2d& b) const;


      inline bool isBetweenPoints(const Vector2d& begin, const Vector2d& end) const;

      static Vector2d interpolate(const Vector2d& v0, const Vector2d& v1, double t);
      
      union {
         struct {
            double x;
            double y;
         };
         double data[2];
      };
   };

   LEGION_DLL Vector2d operator* (double scalar, const Vector2d& vec);

   // debugging output
   LEGION_DLL std::ostream& operator<< (std::ostream& outputStr, const Vector2d& vec);

//---------------------------------Vector3 Float --------------------------------------

   class Vector3d;

   class LEGION_DLL Vector3f
   {
   public:
      //constructors
      Vector3f();
      Vector3f(float x, float y, float z);
      Vector3f(const float* tuple);
      Vector3f(const Vector3f& other);
      Vector3f(const Vector3d& other);

      //assignment
      inline Vector3f& operator= (const Vector3f& vec);

      //comparison
      inline bool operator== (const Vector3f& vec) const;
      inline bool operator!= (const Vector3f& vec) const;
      inline bool operator<  (const Vector3f& vec) const;
      inline bool operator<= (const Vector3f& vec) const;
      inline bool operator>  (const Vector3f& vec) const;
      inline bool operator>= (const Vector3f& vec) const;

      //arithmetic operations
      inline Vector3f operator+ (const Vector3f& vec) const;
      inline Vector3f operator- (const Vector3f& vec) const;
      inline Vector3f operator* (float scalar) const;
      inline Vector3f operator/ (float scalar) const;
      inline Vector3f operator- () const;

      //arithmetic updates
      inline Vector3f& operator+= (const Vector3f& vec);
      inline Vector3f& operator-= (const Vector3f& vec);
      inline Vector3f& operator*= (float scalar);
      inline Vector3f& operator/= (float scalar);

      //vector operations
      inline float length() const;
      inline float lengthSquared() const;
      inline float dot(const Vector3f& vec) const;
      inline Vector3f cross(const Vector3f& vec) const;
      inline Vector3f unitCross(const Vector3f& vec) const;
      inline float normalize();
      inline float distanceFrom(const Vector3f& vec) const;
      inline float distanceFromSquared(const Vector3f& vec) const;

      inline void setLength(float newLength);
      inline void invert();

      inline bool isZero();


      //functions
      inline float angleBetween(const Vector3f& v) const;


      inline bool isBetweenPoints(const Vector3f& begin, const Vector3f& end) const;

      static Vector3f interpolate(const Vector3f& v0, const Vector3f& v1, float t);

      union {
         struct {
            float x;
            float y;
            float z;
         };
         float data[3];
      };
   };

   // arithmetic operations
   LEGION_DLL Vector3f operator* (float scalar, const Vector3f& vec);

   // debugging output
   LEGION_DLL std::ostream& operator<< (std::ostream& outputStr, const Vector3f& vec);


//---------------------------------Vector3 Double --------------------------------------

   class LEGION_DLL Vector3d
   {
   public:
      //constructors
      Vector3d();
      Vector3d(double x, double y, double z);
      Vector3d(const double* tuple);
      Vector3d(const Vector3d& other);
      Vector3d(const Vector3f& other);

      //assignment
      inline Vector3d& operator= (const Vector3d& vec);

      //comparison
      inline bool operator== (const Vector3d& vec) const;
      inline bool operator!= (const Vector3d& vec) const;
      inline bool operator<  (const Vector3d& vec) const;
      inline bool operator<= (const Vector3d& vec) const;
      inline bool operator>  (const Vector3d& vec) const;
      inline bool operator>= (const Vector3d& vec) const;

      //arithmetic operations
      inline Vector3d operator+ (const Vector3d& vec) const;
      inline Vector3d operator- (const Vector3d& vec) const;
      inline Vector3d operator* (double scalar) const;
      inline Vector3d operator/ (double scalar) const;
      inline Vector3d operator- () const;

      //arithmetic updates
      inline Vector3d& operator+= (const Vector3d& vec);
      inline Vector3d& operator-= (const Vector3d& vec);
      inline Vector3d& operator*= (double scalar);
      inline Vector3d& operator/= (double scalar);

      //vector operations
      inline double length() const;
      inline double lengthSquared() const;
      inline double dot(const Vector3d& vec) const;
      inline Vector3d cross(const Vector3d& vec) const;
      inline Vector3d unitCross(const Vector3d& vec) const;
      inline double normalize();
      inline double distanceFrom(const Vector3d& vec) const;
      inline double distanceFromSquared(const Vector3d& vec) const;
      inline void setLength(double newLength);
      inline void invert();

      inline bool isZero();


      //functions
      inline double angleBetween(const Vector3d& v) const;


      inline bool isBetweenPoints(const Vector3d& begin, const Vector3d& end) const;

      static Vector3d interpolate(const Vector3d& v0, const Vector3d& v1, double t);

      union {
         struct {
            double x;
            double y;
            double z;
         };
         double data[3];
      };
   };

   // arithmetic operations
   LEGION_DLL Vector3d operator* (double scalar, const Vector3d& vec);

   // debugging output
   LEGION_DLL std::ostream& operator<< (std::ostream& outputStr, const Vector3d& vec);


   //---------------------------------Vector4 Float --------------------------------------

   class Vector4d;

   class LEGION_DLL Vector4f
   {
   public:
      //constructors
      Vector4f();
      Vector4f(float x, float y, float z, float w);
      Vector4f(const float* tuple);
      Vector4f(const Vector4f& other);
      Vector4f(const Vector4d& other);

      //assignment
      inline Vector4f& operator= (const Vector4f& vec);

      //comparison
      inline bool operator== (const Vector4f& vec) const;
      inline bool operator!= (const Vector4f& vec) const;
      inline bool operator<  (const Vector4f& vec) const;
      inline bool operator<= (const Vector4f& vec) const;
      inline bool operator>  (const Vector4f& vec) const;
      inline bool operator>= (const Vector4f& vec) const;

      //arithmetic operations
      inline Vector4f operator+ (const Vector4f& vec) const;
      inline Vector4f operator- (const Vector4f& vec) const;
      inline Vector4f operator* (float scalar) const;
      inline Vector4f operator/ (float scalar) const;
      inline Vector4f operator- () const;

      //arithmetic updates
      inline Vector4f& operator+= (const Vector4f& vec);
      inline Vector4f& operator-= (const Vector4f& vec);
      inline Vector4f& operator*= (float scalar);
      inline Vector4f& operator/= (float scalar);

      //vector operations
      inline float length() const;
      inline float lengthSquared() const;

      inline float normalize();
      inline float distanceFrom(const Vector4f& vec) const;
      inline float distanceFromSquared(const Vector4f& vec) const;

      inline void setLength(float newLength);
      inline void invert();

      inline bool isZero();



      inline bool isBetweenPoints(const Vector4f& begin, const Vector4f& end) const;

      static Vector4f interpolate(const Vector4f& v0, const Vector4f& v1, float t);

      union {
         struct {
            float x;
            float y;
            float z;
            float w;
         };
         float data[4];
      };
   };

   // arithmetic operations
   LEGION_DLL Vector4f operator* (float scalar, const Vector4f& vec);

   // debugging output
   LEGION_DLL std::ostream& operator<< (std::ostream& outputStr, const Vector4f& vec);


   //---------------------------------Vector4 Double --------------------------------------

   class LEGION_DLL Vector4d
   {
   public:
      //constructors
      Vector4d();
      Vector4d(double x, double y, double z, double w);
      Vector4d(const double* tuple);
      Vector4d(const Vector4d& other);
      Vector4d(const Vector4f& other);

      //assignment
      inline Vector4d& operator= (const Vector4d& vec);

      //comparison
      inline bool operator== (const Vector4d& vec) const;
      inline bool operator!= (const Vector4d& vec) const;
      inline bool operator<  (const Vector4d& vec) const;
      inline bool operator<= (const Vector4d& vec) const;
      inline bool operator>  (const Vector4d& vec) const;
      inline bool operator>= (const Vector4d& vec) const;

      //arithmetic operations
      inline Vector4d operator+ (const Vector4d& vec) const;
      inline Vector4d operator- (const Vector4d& vec) const;
      inline Vector4d operator* (double scalar) const;
      inline Vector4d operator/ (double scalar) const;
      inline Vector4d operator- () const;

      //arithmetic updates
      inline Vector4d& operator+= (const Vector4d& vec);
      inline Vector4d& operator-= (const Vector4d& vec);
      inline Vector4d& operator*= (double scalar);
      inline Vector4d& operator/= (double scalar);

      //vector operations
      inline double length() const;
      inline double lengthSquared() const;
      inline double normalize();
      inline double distanceFrom(const Vector4d& vec) const;
      inline double distanceFromSquared(const Vector4d& vec) const;
      inline void setLength(double newLength);
      inline void invert();

      inline bool isZero();



      inline bool isBetweenPoints(const Vector4d& begin, const Vector4d& end) const;

      static Vector4d interpolate(const Vector4d& v0, const Vector4d& v1, double t);

      union {
         struct {
            double x;
            double y;
            double z;
            double w;
         };
         double data[4];
      };
   };

   // arithmetic operations
   LEGION_DLL Vector4d operator* (double scalar, const Vector4d& vec);

   // debugging output
   LEGION_DLL std::ostream& operator<< (std::ostream& outputStr, const Vector4d& vec);
}