added GPL copyrights

[physics.git] / src / Vector2.h

/*
 *  Copyright (C) 2008 Patrik Gornicz, Gornicz_P (at) hotmail (dot) com.
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef VECTOR2_H
#define VECTOR2_H

#include <string>

using std::string;

/// ***** Header Class *****
class Vector2
{
  public:
    float x;
    float y;

    Vector2();
    Vector2(float, float);
    Vector2(const Vector2&);
    ~Vector2();

    void zero();
    void unit();

    float angle() const;
    float length() const;

    Vector2 add(const Vector2&) const;
    Vector2 subtract(const Vector2&) const;
    Vector2 divide(float) const;
    Vector2 multiply(float) const;

    string toString() const;
    void print() const;
};

/// ***** Header Methods *****

// definitions of the operators are external because (float, Vector2) would
// fail inside the class

Vector2 operator+(const Vector2&, const Vector2&);
Vector2 operator-(const Vector2&, const Vector2&);
Vector2 operator*(float, const Vector2&);
Vector2 operator*(const Vector2&, float);
Vector2 operator/(const Vector2&, float);

void operator+=(Vector2&, const Vector2&);
void operator-=(Vector2&, const Vector2&);
void operator*=(Vector2&, float);
void operator/=(Vector2&, float);

#endif // VECTOR2_H