OgreOverlayElementFactory.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __OverlayElementFactory_H__
29 #define __OverlayElementFactory_H__
30 
32 #include "OgreOverlayElement.h"
36 
37 namespace Ogre {
38 
58  {
59  public:
61  virtual ~OverlayElementFactory () {}
63  virtual OverlayElement* createOverlayElement(const String& instanceName) = 0;
65  virtual void destroyOverlayElement(OverlayElement* pElement) { delete pElement; }
67  virtual const String& getTypeName(void) const = 0;
68  };
69 
70 
73  {
74  public:
77  {
78  return OGRE_NEW PanelOverlayElement(instanceName);
79  }
81  virtual const String& getTypeName(void) const;
82  };
83 
86  {
87  public:
90  {
91  return OGRE_NEW BorderPanelOverlayElement(instanceName);
92  }
94  virtual const String& getTypeName(void) const;
95  };
96 
99  {
100  public:
103  {
104  return OGRE_NEW TextAreaOverlayElement(instanceName);
105  }
107  virtual const String& getTypeName(void) const;
108  };
112 }
113 
114 
115 
116 #endif
virtual ~OverlayElementFactory()
Destroy the overlay element factory.
OverlayElement * createOverlayElement(const String &instanceName)
See OverlayElementFactory.
#define _OgreOverlayExport
Factory for creating TextAreaOverlayElement instances.
#define OGRE_NEW
Factory for creating BorderPanelOverlayElement instances.
OverlayElement representing a flat, single-material (or transparent) panel which can contain other el...
OverlayElement * createOverlayElement(const String &instanceName)
See OverlayElementFactory.
OverlayElement * createOverlayElement(const String &instanceName)
See OverlayElementFactory.
Defines the interface which all components wishing to supply OverlayElement subclasses must implement...
virtual void destroyOverlayElement(OverlayElement *pElement)
Destroys a OverlayElement which this factory created previously.
_StringBase String
This class implements an overlay element which contains simple unformatted text.
Factory for creating PanelOverlayElement instances.
Abstract definition of a 2D element to be displayed in an Overlay.
A specialisation of the PanelOverlayElement to provide a panel with a border.
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sun Oct 9 2016 22:12:54