vpImagePoint.h

/****************************************************************************
 *
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2019 by Inria. All rights reserved.
 *
 * This software 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 2 of the License, or
 * (at your option) any later version.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * See http://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at visp@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Description:
 * 2D point useful for image processing
 *
 * Authors:
 * Nicolas Melchior
 * Fabien Spindler
 *
 *****************************************************************************/

#ifndef vpImagePoint_H
#define vpImagePoint_H

#include <visp3/core/vpConfig.h>
#include <visp3/core/vpMath.h>

#include <cmath>  // std::fabs
#include <limits> // numeric_limits
#include <ostream>
#include <vector>

class vpRect;

class VISP_EXPORT vpImagePoint
{
public:
  inline vpImagePoint() : i(0), j(0) {}
  inline vpImagePoint(double ii, double jj) : i(ii), j(jj) {}
  inline vpImagePoint(const vpImagePoint &ip) : i(ip.i), j(ip.j) {}
  inline virtual ~vpImagePoint() { ; }

  inline vpImagePoint &operator=(const vpImagePoint &ip)
  {
    this->i = ip.i;
    this->j = ip.j;
    return *this;
  }
#ifdef VISP_HAVE_CPP11_COMPATIBILITY

  inline vpImagePoint &operator=(const vpImagePoint &&ip)
  {
    this->i = std::move(ip.i);
    this->j = std::move(ip.j);
    return *this;
  }
#endif

  vpImagePoint &operator+=(const vpImagePoint &ip);

  inline vpImagePoint &operator-=(const vpImagePoint &ip)
  {
    this->i -= ip.i;
    this->j -= ip.j;
    return *this;
  }
  vpImagePoint &operator/=(const double scale);
  inline vpImagePoint &operator*=(const double scale)
  {
    this->i *= scale;
    this->j *= scale;
    return *this;
  }

  inline void set_i(const double ii) { this->i = ii; }

  inline void set_j(const double jj) { this->j = jj; }

  inline void set_ij(const double ii, const double jj)
  {
    this->i = ii;
    this->j = jj;
  }

  inline double get_i() const { return i; }

  inline double get_j() const { return j; }

  inline void set_u(const double u) { j = u; }

  inline void set_v(const double v) { i = v; }

  inline void set_uv(const double u, const double v)
  {
    this->i = v;
    this->j = u;
  }

  inline double get_u() const { return j; }

  inline double get_v() const { return i; }

  static double distance(const vpImagePoint &iP1, const vpImagePoint &iP2)
  {
    return (sqrt(vpMath::sqr(iP1.get_i() - iP2.get_i()) + vpMath::sqr(iP1.get_j() - iP2.get_j())));
  }

  static vpRect getBBox(const std::vector<vpImagePoint> &ipVec);

  static double sqrDistance(const vpImagePoint &iP1, const vpImagePoint &iP2)
  {
    return (vpMath::sqr(iP1.get_i() - iP2.get_i()) + vpMath::sqr(iP1.get_j() - iP2.get_j()));
  }

  bool inRectangle(const vpRect &rect) const;

  friend VISP_EXPORT bool operator==(const vpImagePoint &ip1, const vpImagePoint &ip2);
  friend VISP_EXPORT bool operator!=(const vpImagePoint &ip1, const vpImagePoint &ip2);
  friend VISP_EXPORT vpImagePoint operator+=(const vpImagePoint &ip1, const vpImagePoint &ip2);
  friend VISP_EXPORT vpImagePoint operator+(const vpImagePoint &ip1, const vpImagePoint &ip2);
  friend VISP_EXPORT vpImagePoint operator+(const vpImagePoint &ip1, const int offset);
  friend VISP_EXPORT vpImagePoint operator+(const vpImagePoint &ip1, const unsigned int offset);
  friend VISP_EXPORT vpImagePoint operator+(const vpImagePoint &ip1, const double offset);
  friend VISP_EXPORT vpImagePoint operator-(const vpImagePoint &ip1, const vpImagePoint &ip2);
  friend VISP_EXPORT vpImagePoint operator-(const vpImagePoint &ip1, const int offset);
  friend VISP_EXPORT vpImagePoint operator-(const vpImagePoint &ip1, const unsigned int offset);
  friend VISP_EXPORT vpImagePoint operator-(const vpImagePoint &ip1, const double offset);
  friend VISP_EXPORT vpImagePoint operator*(const vpImagePoint &ip1, const double scale);
  friend VISP_EXPORT vpImagePoint operator/(const vpImagePoint &ip1, const double scale);
  friend VISP_EXPORT std::ostream &operator<<(std::ostream &os, const vpImagePoint &ip);

private:
  double i, j;
};

#endif