Spinning Topp Logo BlackTopp Studios
inc
multilinetextlayer.h
1 // © Copyright 2010 - 2016 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 
41 #ifndef _uimultilinetextlayer_h
42 #define _uimultilinetextlayer_h
43 
44 #include "UI/textlayer.h"
45 #include "UI/character.h"
46 
47 namespace Mezzanine
48 {
49  namespace UI
50  {
51  class TextLine;
52  ///////////////////////////////////////////////////////////////////////////////
53  /// @brief This is a render layer specializing in multi-line text.
54  /// @details
55  ///////////////////////////////////////
57  {
58  protected:
59  /// @copydoc TextLayer::PopulateTextLinesImpl(const Real)
60  virtual void PopulateTextLinesImpl(const Real MaxWidth);
61  /// @copydoc TextLayer::GetIndexAtOffsetImpl(const Vector2& Offset)
62  virtual CharIndexPair GetIndexAtOffsetImpl(const Vector2& Offset);
63  /// @copydoc TextLayer::GetOffsetAtIndexImpl(const Integer Index)
64  virtual CharOffsetPair GetOffsetAtIndexImpl(const Integer Index);
65  /// @internal
66  /// @brief Gets the TextLine at the requested index, or creates one if it doesn't exist.
67  /// @param Index The index of the TextLine to retrieve. If it is not valid it will be created.
68  /// @return Returns a pointer to the TextLine at the specified index.
69  virtual TextLine* GetOrCreateTextLine(const UInt32 Index);
70  public:
71  /// @brief No-Font constructor.
72  /// @param ParentRenderable The renderable that created this layer.
73  MultiLineTextLayer(QuadRenderable* ParentRenderable);
74  /// @brief Class constructor.
75  /// @param FontName The name of the font to use for this layer.
76  /// @param ParentRenderable The renderable that created this layer.
77  MultiLineTextLayer(const String& FontName, QuadRenderable* ParentRenderable);
78  /// @brief Text-Scaling constructor.
79  /// @note This constructor defaults to Screen Relative text, but this can be altered after construction.
80  /// @param LineHeight The relative scalar to be used when determining the size of characters generated by this text layer.
81  /// @param ParentRenderable The renderable that created this layer.
82  MultiLineTextLayer(const Real& LineHeight, QuadRenderable* ParentRenderable);
83  /// @brief Class destructor.
84  virtual ~MultiLineTextLayer();
85 
86  ///////////////////////////////////////////////////////////////////////////////
87  // Utility
88 
89  /// @copydoc RenderLayer::GetLayerType() const
90  virtual UI::RenderLayerType GetLayerType() const;
91 
92  ///////////////////////////////////////////////////////////////////////////////
93  // Text Methods
94 
95  ///////////////////////////////////////////////////////////////////////////////
96  // Serialization
97 
98  /// @copydoc SimpleRenderer::ProtoSerializeProperties(XML::Node&) const
99  virtual void ProtoSerializeProperties(XML::Node& SelfRoot) const;
100  /// @copydoc SimpleRenderer::ProtoDeSerializeProperties(const XML::Node&)
101  virtual void ProtoDeSerializeProperties(const XML::Node& SelfRoot);
102 
103  /// @copydoc SimpleRenderer::GetDerivedSerializableName() const
104  virtual String GetDerivedSerializableName() const;
105  /// @copydoc SimpleRenderer::GetSerializableName()
106  static String GetSerializableName();
107  };//DialogLayer
108  }//UI
109 }//Mezzanine
110 
111 #endif
std::pair< Boole, Vector2 > CharOffsetPair
An std::pair type used as a return for index-offset conversions.
Definition: textlayer.h:88
int Integer
A datatype used to represent any integer close to.
Definition: datatypes.h:154
This is a render layer specializing in multi-line text.
This represents a single line of text to be rendered by a TextLayer.
Definition: textline.h:59
std::pair< Boole, Integer > CharIndexPair
An std::pair type used as a return for index-offset conversions.
Definition: textlayer.h:86
float Real
A Datatype used to represent a real floating point number.
Definition: datatypes.h:141
A light-weight handle for manipulating nodes in DOM tree.
Definition: node.h:89
uint32_t UInt32
An 32-bit unsigned integer.
Definition: datatypes.h:126
This is used to represent a point on a 2 dimentional area, such as a screen.
Definition: vector2.h:63
RenderLayerType
This enum describes the type of RenderLayer this is for use in casting.
#define MEZZ_LIB
Some platforms require special decorations to denote what is exported/imported in a share library...
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
This represents a nestable quad for an object in a GUI layout.
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159
This is a base class for render layers that render text.
Definition: textlayer.h:64