SFML - Simple and Fast Multimedia Library

SFML

previous page next page
Text.hpp
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2017 Laurent Gomila ([email protected])
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages arising from the use of this software.
8 //
9 // Permission is granted to anyone to use this software for any purpose,
10 // including commercial applications, and to alter it and redistribute it freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24 
25 #ifndef SFML_TEXT_HPP
26 #define SFML_TEXT_HPP
27 
29 // Headers
31 #include <SFML/Graphics/Export.hpp>
32 #include <SFML/Graphics/Drawable.hpp>
33 #include <SFML/Graphics/Transformable.hpp>
34 #include <SFML/Graphics/Font.hpp>
35 #include <SFML/Graphics/Rect.hpp>
36 #include <SFML/Graphics/VertexArray.hpp>
37 #include <SFML/System/String.hpp>
38 #include <string>
39 #include <vector>
40 
41 
42 namespace sf
43 {
48 class SFML_GRAPHICS_API Text : public Drawable, public Transformable
49 {
50 public:
51 
56  enum Style
57  {
58  Regular = 0,
59  Bold = 1 << 0,
60  Italic = 1 << 1,
61  Underlined = 1 << 2,
62  StrikeThrough = 1 << 3
63  };
64 
71  Text();
72 
88  Text(const String& string, const Font& font, unsigned int characterSize = 30);
89 
109  void setString(const String& string);
110 
126  void setFont(const Font& font);
127 
145  void setCharacterSize(unsigned int size);
146 
159  void setStyle(Uint32 style);
160 
177  SFML_DEPRECATED void setColor(const Color& color);
178 
191  void setFillColor(const Color& color);
192 
203  void setOutlineColor(const Color& color);
204 
218  void setOutlineThickness(float thickness);
219 
237  const String& getString() const;
238 
251  const Font* getFont() const;
252 
261  unsigned int getCharacterSize() const;
262 
271  Uint32 getStyle() const;
272 
285  SFML_DEPRECATED const Color& getColor() const;
286 
295  const Color& getFillColor() const;
296 
305  const Color& getOutlineColor() const;
306 
315  float getOutlineThickness() const;
316 
332  Vector2f findCharacterPos(std::size_t index) const;
333 
346  FloatRect getLocalBounds() const;
347 
360  FloatRect getGlobalBounds() const;
361 
362 private:
363 
371  virtual void draw(RenderTarget& target, RenderStates states) const;
372 
380  void ensureGeometryUpdate() const;
381 
383  // Member data
385  String m_string;
386  const Font* m_font;
387  unsigned int m_characterSize;
388  Uint32 m_style;
389  Color m_fillColor;
390  Color m_outlineColor;
391  float m_outlineThickness;
392  mutable VertexArray m_vertices;
393  mutable VertexArray m_outlineVertices;
394  mutable FloatRect m_bounds;
395  mutable bool m_geometryNeedUpdate;
396 };
397 
398 } // namespace sf
399 
400 
401 #endif // SFML_TEXT_HPP
402 
403 
sf::RenderStates
Define the states used for drawing to a RenderTarget.
Definition: RenderStates.hpp:45
sf::Color
Utility class for manipulating RGBA colors.
Definition: Color.hpp:40
sf::Text::Style
Style
Enumeration of the string drawing styles.
Definition: Text.hpp:56
sf::VertexArray
Define a set of one or more 2D primitives.
Definition: VertexArray.hpp:45
sf::Text
Graphical text that can be drawn to a render target.
Definition: Text.hpp:48
sf::RenderTarget
Base class for all render targets (window, texture, ...)
Definition: RenderTarget.hpp:51
sf::Drawable
Abstract base class for objects that can be drawn to a render target.
Definition: Drawable.hpp:44
sf::Font
Class for loading and manipulating character fonts.
Definition: Font.hpp:50
sf::Vector2
Utility template class for manipulating 2-dimensional vectors.
Definition: Vector2.hpp:37
sf::Transformable
Decomposed transform defined by a position, a rotation and a scale.
Definition: Transformable.hpp:41
sf::String
Utility string class that automatically handles conversions between types and encodings.
Definition: String.hpp:45
previous page start next page