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