vpPolygon3D.h

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2025 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 https://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:
 * Implements a polygon of the model used by the model-based tracker.
 */

 
#ifndef vpPolygon3D_HH
#define vpPolygon3D_HH
 
#include <vector>
 
#include <visp3/core/vpConfig.h>
#include <visp3/core/vpMeterPixelConversion.h>
#include <visp3/core/vpPixelMeterConversion.h>
#include <visp3/core/vpPoint.h>
 
BEGIN_VISP_NAMESPACE
class VISP_EXPORT vpPolygon3D
{
public:
  typedef enum
  {
    NO_CLIPPING = 0,
    NEAR_CLIPPING = 1,
    FAR_CLIPPING = 2,
    LEFT_CLIPPING = 4,
    RIGHT_CLIPPING = 8,
    UP_CLIPPING = 16,
    DOWN_CLIPPING = 32,
    FOV_CLIPPING = 60,
    ALL_CLIPPING = 63
  } vpPolygon3DClippingType;
 
public:
  unsigned int nbpt;
  unsigned int nbCornersInsidePrev;
  vpPoint *p;
  std::vector<std::pair<vpPoint, unsigned int> > polyClipped;
  unsigned int clippingFlag;
  double distNearClip;
  double distFarClip;
 
private:
  bool getClippedPointsFovGeneric(const vpPoint &p1, const vpPoint &p2, vpPoint &p1Clipped, vpPoint &p2Clipped,
                                  unsigned int &p1ClippedInfo, unsigned int &p2ClippedInfo, const vpColVector &normal,
                                  const unsigned int &flag);
 
  bool getClippedPointsDistance(const vpPoint &p1, const vpPoint &p2, vpPoint &p1Clipped, vpPoint &p2Clipped,
                                unsigned int &p1ClippedInfo, unsigned int &p2ClippedInfo, const unsigned int &flag,
                                const double &distance);
 
public:
  vpPolygon3D();
  vpPolygon3D(const vpPolygon3D &mbtp);
  virtual ~vpPolygon3D();
 
  void addPoint(unsigned int n, const vpPoint &P);
 
  void changeFrame(const vpHomogeneousMatrix &cMo);
 
  void computePolygonClipped(const vpCameraParameters &cam = vpCameraParameters());

  inline unsigned int getClipping() const { return clippingFlag; }

  inline double getFarClippingDistance() const { return distFarClip; }

  inline unsigned int getNbPoint() const { return nbpt; }

  inline unsigned int getNbCornerInsidePrevImage() const { return nbCornersInsidePrev; }
 
  unsigned int getNbCornerInsideImage(const vpImage<unsigned char> &I, const vpCameraParameters &cam);

  inline double getNearClippingDistance() const { return distNearClip; }
 
  vpPoint &getPoint(const unsigned int _index);
 
  std::vector<vpImagePoint> getRoi(const vpCameraParameters &cam);
 
  std::vector<vpImagePoint> getRoi(const vpCameraParameters &cam, const vpHomogeneousMatrix &cMo);
 
  void getRoiClipped(const vpCameraParameters &cam, std::vector<vpImagePoint> &roi);
 
  void getRoiClipped(const vpCameraParameters &cam, std::vector<vpImagePoint> &roi, const vpHomogeneousMatrix &cMo);
 
  void getRoiClipped(const vpCameraParameters &cam, std::vector<std::pair<vpImagePoint, unsigned int> > &roi);
 
  void getRoiClipped(const vpCameraParameters &cam, std::vector<std::pair<vpImagePoint, unsigned int> > &roi,
                     const vpHomogeneousMatrix &cMo);
 
#ifdef VISP_BUILD_DEPRECATED_FUNCTIONS
  VP_DEPRECATED void getRoiClipped(std::vector<vpPoint> &points);
#endif
 
  void getPolygonClipped(std::vector<std::pair<vpPoint, unsigned int> > &poly);
 
  void getPolygonClipped(std::vector<vpPoint> &poly);
 
  vpPolygon3D &operator=(const vpPolygon3D &mbtp);

  inline void setClipping(const unsigned int &flags) { clippingFlag = flags; }

  inline void setFarClippingDistance(const double &dist)
  {
    distFarClip = dist;
    clippingFlag = (clippingFlag | vpPolygon3D::FAR_CLIPPING);
  }
 
  virtual void setNbPoint(unsigned int nb);

  inline void setNearClippingDistance(const double &dist)
  {
    distNearClip = dist;
    clippingFlag = (clippingFlag | vpPolygon3D::NEAR_CLIPPING);
  }
 
public:
  static void getClippedPolygon(const std::vector<vpPoint> &ptIn, std::vector<vpPoint> &ptOut,
                                const vpHomogeneousMatrix &cMo, const unsigned int &clippingFlags,
                                const vpCameraParameters &cam = vpCameraParameters(), const double &znear = 0.001,
                                const double &zfar = 100);
  static void getMinMaxRoi(const std::vector<vpImagePoint> &roi, int &i_min, int &i_max, int &j_min, int &j_max);
  static bool roiInsideImage(const vpImage<unsigned char> &I, const std::vector<vpImagePoint> &corners);
};
END_VISP_NAMESPACE
 
#ifdef VISP_HAVE_NLOHMANN_JSON
#include VISP_NLOHMANN_JSON(json.hpp)
#include <visp3/core/vpJsonParsing.h>
 
#if defined(__clang__)
// Mute warning : declaration requires an exit-time destructor [-Wexit-time-destructors]
// message : expanded from macro 'NLOHMANN_JSON_SERIALIZE_ENUM'
#  pragma clang diagnostic push
#  pragma clang diagnostic ignored "-Wexit-time-destructors"
#endif
 
NLOHMANN_JSON_SERIALIZE_ENUM(VISP_NAMESPACE_ADDRESSING vpPolygon3D::vpPolygon3DClippingType, {
    {VISP_NAMESPACE_ADDRESSING vpPolygon3D::NO_CLIPPING, "none"},
    {VISP_NAMESPACE_ADDRESSING vpPolygon3D::NEAR_CLIPPING, "near"},
    {VISP_NAMESPACE_ADDRESSING vpPolygon3D::FAR_CLIPPING, "far"},
    {VISP_NAMESPACE_ADDRESSING vpPolygon3D::LEFT_CLIPPING, "left"},
    {VISP_NAMESPACE_ADDRESSING vpPolygon3D::RIGHT_CLIPPING, "right"},
    {VISP_NAMESPACE_ADDRESSING vpPolygon3D::UP_CLIPPING, "up"},
    {VISP_NAMESPACE_ADDRESSING vpPolygon3D::DOWN_CLIPPING, "down"},
    {VISP_NAMESPACE_ADDRESSING vpPolygon3D::FOV_CLIPPING, "fov"},
    {VISP_NAMESPACE_ADDRESSING vpPolygon3D::ALL_CLIPPING, "all"}
});
 
#if defined(__clang__)
#  pragma clang diagnostic pop
#endif
 
inline nlohmann::json clippingFlagsToJSON(const unsigned int flags)
{
#ifdef ENABLE_VISP_NAMESPACE
  using namespace VISP_NAMESPACE_NAME;
#endif
  constexpr std::array<vpPolygon3D::vpPolygon3DClippingType, 3> specificFlags = {
    vpPolygon3D::ALL_CLIPPING,
    vpPolygon3D::FOV_CLIPPING,
    vpPolygon3D::NO_CLIPPING
  };
  for (const auto f: specificFlags) {
    if (flags == f) {
      return nlohmann::json::array({ f });
    }
  }
  return flagsToJSON<vpPolygon3D::vpPolygon3DClippingType>(flags, {
    vpPolygon3D::NEAR_CLIPPING,
    vpPolygon3D::FAR_CLIPPING,
    vpPolygon3D::LEFT_CLIPPING,
    vpPolygon3D::RIGHT_CLIPPING,
    vpPolygon3D::UP_CLIPPING,
    vpPolygon3D::DOWN_CLIPPING,
  });
}
 
#endif
#endif