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