Visual Servoing Platform  version 3.6.1 under development (2024-11-15)
vpFeatureDisplay.h
1 /*
2  * ViSP, open source Visual Servoing Platform software.
3  * Copyright (C) 2005 - 2024 by Inria. All rights reserved.
4  *
5  * This software is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  * See the file LICENSE.txt at the root directory of this source
10  * distribution for additional information about the GNU GPL.
11  *
12  * For using ViSP with software that can not be combined with the GNU
13  * GPL, please contact Inria about acquiring a ViSP Professional
14  * Edition License.
15  *
16  * See https://visp.inria.fr for more information.
17  *
18  * This software was developed at:
19  * Inria Rennes - Bretagne Atlantique
20  * Campus Universitaire de Beaulieu
21  * 35042 Rennes Cedex
22  * France
23  *
24  * If you have questions regarding the use of this file, please contact
25  * Inria at visp@inria.fr
26  *
27  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
28  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
29  *
30  * Description:
31  * Interface with the image for feature display.
32  */
33 
39 #ifndef VP_FEATURE_DISPLAY_H
40 #define VP_FEATURE_DISPLAY_H
41 
42 #include <visp3/core/vpConfig.h>
43 
44 // Color / image / display
45 #include <visp3/core/vpColor.h>
46 #include <visp3/core/vpImage.h>
47 #include <visp3/core/vpRGBa.h>
48 
49 // Meter/pixel conversion
50 #include <visp3/core/vpCameraParameters.h>
51 
52 BEGIN_VISP_NAMESPACE
59 class VISP_EXPORT vpFeatureDisplay
60 {
61 
62 public:
63  static void displayCylinder(double rho1, double theta1, double rho2, double theta2, const vpCameraParameters &cam,
64  const vpImage<unsigned char> &I, const vpColor &color = vpColor::green,
65  unsigned int thickness = 1);
66  static void displayCylinder(double rho1, double theta1, double rho2, double theta2, const vpCameraParameters &cam,
67  const vpImage<vpRGBa> &I, const vpColor &color = vpColor::green,
68  unsigned int thickness = 1);
69 
70  static void displayEllipse(double x, double y, double n20, double n11, double n02, const vpCameraParameters &cam,
71  const vpImage<unsigned char> &I, const vpColor &color = vpColor::green,
72  unsigned int thickness = 1);
73 
74  static void displayEllipse(double x, double y, double n20, double n11, double n02, const vpCameraParameters &cam,
75  const vpImage<vpRGBa> &I, const vpColor &color = vpColor::green,
76  unsigned int thickness = 1);
77 
78  static void displayLine(double rho, double theta, const vpCameraParameters &cam, const vpImage<unsigned char> &I,
79  const vpColor &color = vpColor::green, unsigned int thickness = 1);
80  static void displayLine(double rho, double theta, const vpCameraParameters &cam, const vpImage<vpRGBa> &I,
81  const vpColor &color = vpColor::green, unsigned int thickness = 1);
82 
83  static void displayPoint(double x, double y, const vpCameraParameters &cam, const vpImage<unsigned char> &I,
84  const vpColor &color = vpColor::green, unsigned int thickness = 1);
85  static void displayPoint(double x, double y, const vpCameraParameters &cam, const vpImage<vpRGBa> &I,
86  const vpColor &color = vpColor::green, unsigned int thickness = 1);
87 };
88 END_VISP_NAMESPACE
89 #endif
Generic class defining intrinsic camera parameters.
Class to define RGB colors available for display functionalities.
Definition: vpColor.h:157
static const vpColor green
Definition: vpColor.h:220
Interface with the image for feature display.