Visual Servoing Platform  version 3.6.1 under development (2023-11-30)
vpRectOriented.h
1 /*
2  * ViSP, open source Visual Servoing Platform software.
3  * Copyright (C) 2005 - 2023 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  * Defines a (possibly oriented) rectangle in the plane.
32  */
33 
34 #ifndef vpRectOriented_h
35 #define vpRectOriented_h
36 
43 #include <visp3/core/vpImagePoint.h>
44 #include <visp3/core/vpRect.h>
45 
46 class VISP_EXPORT vpRectOriented
47 {
48 public:
50  vpRectOriented(const vpRectOriented &rect) = default;
51 
52  vpRectOriented(const vpImagePoint &center, double width, double height, double theta = 0);
53 
54  vpRectOriented(const vpRect &rect);
55 
56  vpRectOriented &operator=(const vpRectOriented &rect) = default;
57 
58  vpRectOriented &operator=(const vpRect &rect);
59 
60  operator vpRect();
61 
62  void setCenter(const vpImagePoint &center);
63 
64  void setPoints(const vpImagePoint &topLeft, const vpImagePoint &topRight, const vpImagePoint &bottomLeft,
65  const vpImagePoint &bottomRight);
66 
67  vpImagePoint getCenter() const;
68 
69  vpImagePoint getTopLeft() const;
70 
71  vpImagePoint getTopRight() const;
72 
73  vpImagePoint getBottomLeft() const;
74 
75  vpImagePoint getBottomRight() const;
76 
77  void setSize(double width, double height);
78 
79  double getWidth() const;
80 
81  double getHeight() const;
82 
83  void setOrientation(double theta);
84 
85  double getOrientation() const;
86 
87  bool isInside(const vpImagePoint &point) const;
88 
89 private:
90  vpImagePoint m_center;
91  double m_width;
92  double m_height;
93  double m_theta;
94  vpImagePoint m_topLeft;
95  vpImagePoint m_topRight;
96  vpImagePoint m_bottomLeft;
97  vpImagePoint m_bottomRight;
98  bool isLeft(const vpImagePoint &pointToTest, const vpImagePoint &point1, const vpImagePoint &point2) const;
99 };
100 #endif // vpRectOriented_h
Class that defines a 2D point in an image. This class is useful for image processing and stores only ...
Definition: vpImagePoint.h:82
Defines an oriented rectangle in the plane.
vpRectOriented(const vpRectOriented &rect)=default
vpRectOriented & operator=(const vpRectOriented &rect)=default
Defines a rectangle in the plane.
Definition: vpRect.h:76