vector2D.H

Go to the documentation of this file.

/*
  This file is part of Designar.
  Copyright (C) 2017 by Alejandro J. Mujica

  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/>.

  Any user request of this software, write to 

  Alejandro Mujica

  aledrums@gmail.com
*/

# ifndef DSGVECTOR2D_H
# define DSGVECTOR2D_H

# include <point2D.H>

namespace Designar
{
  class Vector2D : public Point2D
  {
    using Base = Point2D;
    using Base::Base;

  public:
    static const Vector2D ZERO;

    bool is_to_right_from(const Vector2D &) const;

    bool is_to_right_on_from(const Vector2D &) const;

    bool is_to_left_from(const Vector2D &) const;

    bool is_to_left_on_from(const Vector2D &) const;

    bool is_collinear_with(const Vector2D &) const;
    
    bool is_normalized() const;

    bool is_unitarian() const;

    real_t square_magnitude() const;

    real_t magnitude() const;

    real_t length() const;

    void normalize();

    void negate();

    void scale(double);

    bool is_opposite(const Vector2D &) const;

    Vector2D get_opposite() const;

    real_t angle_with(const Vector2D &) const;

    void add_scaled_vector(const Vector2D &, real_t);

    real_t dot_product(const Vector2D &) const;

    real_t scalar_product(const Vector2D &) const;

    real_t cross_product(const Vector2D &) const;

    real_t vector_product(const Vector2D &) const;

    Vector2D component_product(const Vector2D &) const;

    Vector2D operator - () const;

    Vector2D operator * (real_t) const;

    void operator *= (real_t);

    friend Vector2D operator * (real_t, const Vector2D &);

    real_t operator * (const Vector2D &) const;

    Vector2D operator + (const Vector2D &) const;

    void operator += (const Vector2D &);

    Vector2D operator - (const Vector2D &) const;

    void operator -= (const Vector2D &);

    static std::tuple<Vector2D, Vector2D>
    make_orthonormal_basis(const Vector2D &);
  };
  
} // end namespace Designar

# endif // DSGVECTOR_2D_H