vector3.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_VECTOR3_H_
#define SRC_VECTOR3_H_
 
#include <iostream>
 
#include "point3.h"
 
 
namespace mingfx {
 
    
class Vector3 {
public:
 
    Vector3();
 
    Vector3(float x, float y, float z);
 
    Vector3(float *v);
 
    Vector3(const Vector3& v);
 
    virtual ~Vector3();
 
    bool operator==(const Vector3& v) const;
 
    bool operator!=(const Vector3& v) const;
 
    Vector3& operator=(const Vector3& 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 z() const { return v[2]; }
 
    float w() const { return 0.0; }
    
    
    // --- Vector operations ---
 
    float Dot(const Vector3& v) const;
 
    Vector3 Cross(const Vector3& v) const;
 
    float Length() const;
 
    void Normalize();
 
    Vector3 ToUnit() const;
 
    const float * value_ptr() const;
 
    Vector3 Lerp(const Vector3 &b, float alpha) const;
    
    
    static const Vector3& Zero();
 
    static const Vector3& One();
 
    static const Vector3& UnitX();
 
    static const Vector3& UnitY();
 
    static const Vector3& UnitZ();
    
 
    static Vector3 Normalize(const Vector3 &v);
    
    static Vector3 Cross(const Vector3 &v1, const Vector3 &v2);
    
    static float Dot(const Vector3 &v1, const Vector3 &v2);
    
    static Vector3 Lerp(const Vector3 &a, const Vector3 &b, float alpha);
    
private:
    float v[3];
};
 
 
// ---------- Operator Overloads for Working with Vectors ----------
 
 
// --- Scalers ---
 
Vector3 operator/(const Vector3& v, const float s);
 
Vector3 operator*(const float s, const Vector3& v);
 
Vector3 operator*(const Vector3& v, const float s);
 
Vector3 operator-(const Vector3& v);
 
// Note: no -(point) operator, that's an undefined operation
 
 
// --- Point and Vector Arithmetic ---
 
Point3 operator+(const Vector3& v, const Point3& p);
 
Point3 operator+(const Point3& p, const Vector3& v);
 
Vector3 operator+(const Vector3& v1, const Vector3& v2);
 
// Note: no (point + point) operator, that's an undefined operation
 
Point3 operator-(const Point3& p, const Vector3& v);
 
Vector3 operator-(const Vector3& v1, const Vector3& v2);
 
Vector3 operator-(const Point3& p1, const Point3& p2);
 
// Note: no (vector - point) operator, that's an undefined operation
 
    
    
    
// --- Stream operators ---
 
// Vector3
std::ostream & operator<< ( std::ostream &os, const Vector3 &v);
std::istream & operator>> ( std::istream &is, Vector3 &v);
 
    
} // end namespace
 
#endif