OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgreTextAreaOverlayElement.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2 This source file is a part of OGRE
3 (Object-oriented Graphics Rendering Engine)
4 
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2014 Torus Knot Software Ltd
8 Permission is hereby granted, free of charge, to any person obtaining a copy
9 of this software and associated documentation files (the "Software"), to deal
10 in the Software without restriction, including without limitation the rights
11 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 copies of the Software, and to permit persons to whom the Software is
13 furnished to do so, subject to the following conditions:
14 
15 The above copyright notice and this permission notice shall be included in
16 all copies or substantial portions of the Software.
17 
18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 THE SOFTWARE
25 -------------------------------------------------------------------------*/
26 
27 #ifndef _TextAreaOverlayElement_H__
28 #define _TextAreaOverlayElement_H__
29 
30 #include "OgreOverlayElement.h"
31 #include "OgreRenderOperation.h"
32 
33 namespace Ogre
34 {
44  {
45  public:
46  enum Alignment
47  {
50  Center
51  };
52 
53  public:
55  TextAreaOverlayElement(const String& name);
56  virtual ~TextAreaOverlayElement();
57 
58  virtual void initialise(void);
59  virtual void setCaption(const DisplayString& text);
60 
61  void setCharHeight( Real height );
62  Real getCharHeight() const;
63 
64  void setSpaceWidth( Real width );
65  Real getSpaceWidth() const;
66 
67  void setFontName( const String& font );
68  const String& getFontName() const;
69 
71  virtual const String& getTypeName(void) const;
73  const MaterialPtr& getMaterial(void) const;
75  void getRenderOperation(RenderOperation& op);
77  void setMaterialName(const String& matName);
78 
85  void setColour(const ColourValue& col);
86 
88  const ColourValue& getColour(void) const;
95  void setColourBottom(const ColourValue& col);
97  const ColourValue& getColourBottom(void) const;
104  void setColourTop(const ColourValue& col);
106  const ColourValue& getColourTop(void) const;
107 
108  inline void setAlignment( Alignment a )
109  {
110  mAlignment = a;
111  mGeomPositionsOutOfDate = true;
112  }
113  inline Alignment getAlignment() const
114  {
115  return mAlignment;
116  }
117 
119  void setMetricsMode(GuiMetricsMode gmm);
120 
122  void _update(void);
123 
124  //-----------------------------------------------------------------------------------------
129  {
130  public:
131  String doGet( const void* target ) const;
132  void doSet( void* target, const String& val );
133  };
134  //-----------------------------------------------------------------------------------------
139  {
140  public:
141  String doGet( const void* target ) const;
142  void doSet( void* target, const String& val );
143  };
144  //-----------------------------------------------------------------------------------------
149  {
150  public:
151  String doGet( const void* target ) const;
152  void doSet( void* target, const String& val );
153  };
154  //-----------------------------------------------------------------------------------------
159  {
160  public:
161  String doGet( const void* target ) const;
162  void doSet( void* target, const String& val );
163  };
164  //-----------------------------------------------------------------------------------------
169  {
170  public:
171  String doGet( const void* target ) const;
172  void doSet( void* target, const String& val );
173  };
174  //-----------------------------------------------------------------------------------------
179  {
180  public:
181  String doGet( const void* target ) const;
182  void doSet( void* target, const String& val );
183  };
184  //-----------------------------------------------------------------------------------------
189  {
190  public:
191  String doGet( const void* target ) const;
192  void doSet( void* target, const String& val );
193  };
194  //-----------------------------------------------------------------------------------------
199  {
200  public:
201  String doGet( const void* target ) const;
202  void doSet( void* target, const String& val );
203  };
204 
205  protected:
208 
211 
214 
216  void addBaseParameters(void);
217 
219 
220  // Command objects
228 
229 
236  size_t mAllocSize;
238 
243 
244 
246  void checkMemoryAllocation( size_t numChars );
248  virtual void updatePositionGeometry();
250  virtual void updateTextureGeometry();
252  virtual void updateColours(void);
253  };
256 }
257 
258 #endif
259 
float Real
Software floating point type.
Command object for setting the alignment.
bool mTransparent
Flag indicating if this panel should be visual or just group things.
#define _OgreOverlayExport
Class representing colour.
Command object for setting the bottom colour.
GuiMetricsMode
Enum describing how the position / size of an element is to be recorded.
This class implements an overlay element which contains simple unformatted text.
Command object for setting the caption.
Command object for setting the top colour.
Alignment mAlignment
The text alignment.
#define _OgrePrivate
Definition: OgrePlatform.h:256
Command object for setting the width of a space.
RenderOperation mRenderOp
Render operation.
unsigned short ushort
Abstract definition of a 2D element to be displayed in an Overlay.
'New' rendering operation using vertex buffers.
String DisplayString
_StringBase String
Definition: OgreCommon.h:53
Command object for setting the constant colour.
Command object for setting the char height.
Command object for setting the caption.
ColourValue mColourBottom
Colours to use for the vertices.
Abstract class which is command object which gets/sets parameters.