vector2.h

Go to the documentation of this file.

/*
 This file is part of the MinGfx Project.
 
 Copyright (c) 2017,2018 Regents of the University of Minnesota.
 All Rights Reserved.
 
 Original Author(s) of this File:
    Dan Keefe, 2018, University of Minnesota
    
 Author(s) of Significant Updates/Modifications to the File:
    ...
 */
 
#ifndef SRC_VECTOR2_H_
#define SRC_VECTOR2_H_
 
#include <iostream>
 
#include "point2.h"
 
 
namespace mingfx {
 
 
class Vector2 {
public:
    
    Vector2();
    
    Vector2(float x, float y);
    
    Vector2(float *v);
    
    Vector2(const Vector2& v);
    
    virtual ~Vector2();
    
    bool operator==(const Vector2& v) const;
    
    bool operator!=(const Vector2& v) const;
    
    Vector2& operator=(const Vector2& v);
    
    float operator[](const int i) const;
    
    float& operator[](const int i);
    
    float x() const { return v[0]; }
    
    float y() const { return v[1]; }
        
    float w() const { return 0.0; }
    
    
    // --- Vector operations ---
    
    float Dot(const Vector2& v) const;
    
    float Length() const;
    
    void Normalize();
    
    Vector2 ToUnit() const;
    
    Vector2 Lerp(const Vector2 &b, float alpha) const;
    
    const float * value_ptr() const;
 
    
    
    static Vector2 Normalize(const Vector2 &v);
    
    static float Dot(const Vector2 &v1, const Vector2 &v2);
    
    static const Vector2& Zero();
 
    static const Vector2& One();
 
    static const Vector2& UnitX();
 
    static const Vector2& UnitY();
    
    static Vector2 Lerp(const Vector2 &a, const Vector2 &b, float alpha);
 
private:
    float v[2];
};
 
 
// ---------- Operator Overloads for Working with Vectors ----------
 
 
// --- Scalers ---
 
Vector2 operator/(const Vector2& v, const float s);
 
Vector2 operator*(const float s, const Vector2& v);
 
Vector2 operator*(const Vector2& v, const float s);
 
Vector2 operator-(const Vector2& v);
 
// Note: no -(point) operator, that's an undefined operation
 
 
// --- Point and Vector Arithmetic ---
 
Point2 operator+(const Vector2& v, const Point2& p);
 
Point2 operator+(const Point2& p, const Vector2& v);
 
Vector2 operator+(const Vector2& v1, const Vector2& v2);
 
// Note: no (point + point) operator, that's an undefined operation
 
Point2 operator-(const Point2& p, const Vector2& v);
 
Vector2 operator-(const Vector2& v1, const Vector2& v2);
 
Vector2 operator-(const Point2& p1, const Point2& p2);
 
// Note: no (vector - point) operator, that's an undefined operation
 
 
// --- Stream operators ---
 
// Vector2
std::ostream & operator<< ( std::ostream &os, const Vector2 &v);
std::istream & operator>> ( std::istream &is, Vector2 &v);
 
    
} // end namespace
 
#endif