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