Visual Servoing Platform  version 3.6.1 under development (2024-04-23)
vpFont.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  * Draw text in an image.
32  */
33 
34 #ifndef _vpFont_h_
35 #define _vpFont_h_
36 
43 #include <visp3/core/vpColor.h>
44 #include <visp3/core/vpImage.h>
45 
53 class VISP_EXPORT vpFont
54 {
55 public:
56  enum vpFontFamily { GENERIC_MONOSPACE, TRUETYPE_FILE };
57 
58  vpFont(unsigned int height = 16, const vpFontFamily &fontFamily = TRUETYPE_FILE,
59  const std::string &ttfFilename = std::string(VISP_RUBIK_REGULAR_FONT_RESOURCES));
60  ~vpFont();
61 
62  bool drawText(vpImage<unsigned char> &I, const std::string &text, const vpImagePoint &position,
63  unsigned char color) const;
64  bool drawText(vpImage<unsigned char> &I, const std::string &text, const vpImagePoint &position, unsigned char color,
65  unsigned char background) const;
66 
67  bool drawText(vpImage<vpRGBa> &I, const std::string &text, const vpImagePoint &position, const vpColor &color) const;
68  bool drawText(vpImage<vpRGBa> &I, const std::string &text, const vpImagePoint &position, const vpColor &color,
69  const vpColor &background) const;
70 
71  unsigned int getHeight() const;
72  vpImagePoint getMeasure(const std::string &text) const;
73  bool setHeight(unsigned int height);
74 
75 private:
76  vpFont(const vpFont &); // noncopyable
77  vpFont &operator=(const vpFont &); //
78 
79  // PIMPL idiom
80  class Impl;
81  Impl *m_impl;
82 };
83 
84 #endif
Class to define RGB colors available for display functionalities.
Definition: vpColor.h:152
Font drawing functions for image.
Definition: vpFont.h:54
vpFontFamily
Definition: vpFont.h:56
Class that defines a 2D point in an image. This class is useful for image processing and stores only ...
Definition: vpImagePoint.h:82