OgreOverlayElementFactory.h
Go to the documentation of this file.
/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/
Copyright (c) 2000-2013 Torus Knot Software Ltd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __OverlayElementFactory_H__
#define __OverlayElementFactory_H__
#include "OgreOverlayPrerequisites.h"
#include "OgreOverlayElement.h"
#include "OgrePanelOverlayElement.h"
#include "OgreBorderPanelOverlayElement.h"
#include "OgreTextAreaOverlayElement.h"
namespace Ogre {
class _OgreOverlayExport OverlayElementFactory : public OverlayAlloc
{
public:
virtual ~OverlayElementFactory () {}
virtual OverlayElement* createOverlayElement(const String& instanceName) = 0;
virtual void destroyOverlayElement(OverlayElement* pElement) { delete pElement; }
virtual const String& getTypeName(void) const = 0;
};
class _OgreOverlayExport PanelOverlayElementFactory: public OverlayElementFactory
{
public:
OverlayElement* createOverlayElement(const String& instanceName)
{
return OGRE_NEW PanelOverlayElement(instanceName);
}
virtual const String& getTypeName(void) const;
};
class _OgreOverlayExport BorderPanelOverlayElementFactory: public OverlayElementFactory
{
public:
OverlayElement* createOverlayElement(const String& instanceName)
{
return OGRE_NEW BorderPanelOverlayElement(instanceName);
}
virtual const String& getTypeName(void) const;
};
class _OgreOverlayExport TextAreaOverlayElementFactory: public OverlayElementFactory
{
public:
OverlayElement* createOverlayElement(const String& instanceName)
{
return OGRE_NEW TextAreaOverlayElement(instanceName);
}
virtual const String& getTypeName(void) const;
};
}
#endif
Ogre::OverlayElementFactory::~OverlayElementFactory
virtual ~OverlayElementFactory()
Destroy the overlay element factory.
Definition: OgreOverlayElementFactory.h:61
Ogre::BorderPanelOverlayElementFactory::createOverlayElement
OverlayElement * createOverlayElement(const String &instanceName)
See OverlayElementFactory.
Definition: OgreOverlayElementFactory.h:89
_OgreOverlayExport
#define _OgreOverlayExport
Definition: OgreOverlayPrerequisites.h:58
OgreOverlayElement.h
Ogre::TextAreaOverlayElementFactory
Factory for creating TextAreaOverlayElement instances.
Definition: OgreOverlayElementFactory.h:98
OGRE_NEW
#define OGRE_NEW
Definition: OgreMemoryAllocatorConfig.h:473
Ogre::BorderPanelOverlayElementFactory
Factory for creating BorderPanelOverlayElement instances.
Definition: OgreOverlayElementFactory.h:85
Ogre::PanelOverlayElement
OverlayElement representing a flat, single-material (or transparent) panel which can contain other el...
Definition: OgrePanelOverlayElement.h:58
OgreTextAreaOverlayElement.h
Ogre::TextAreaOverlayElementFactory::createOverlayElement
OverlayElement * createOverlayElement(const String &instanceName)
See OverlayElementFactory.
Definition: OgreOverlayElementFactory.h:102
Ogre::PanelOverlayElementFactory::createOverlayElement
OverlayElement * createOverlayElement(const String &instanceName)
See OverlayElementFactory.
Definition: OgreOverlayElementFactory.h:76
Ogre::OverlayElementFactory
Defines the interface which all components wishing to supply OverlayElement subclasses must implement...
Definition: OgreOverlayElementFactory.h:57
Ogre::OverlayElementFactory::destroyOverlayElement
virtual void destroyOverlayElement(OverlayElement *pElement)
Destroys a OverlayElement which this factory created previously.
Definition: OgreOverlayElementFactory.h:65
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::TextAreaOverlayElement
This class implements an overlay element which contains simple unformatted text.
Definition: OgreTextAreaOverlayElement.h:43
OgrePanelOverlayElement.h
OgreBorderPanelOverlayElement.h
OgreOverlayPrerequisites.h
Ogre::PanelOverlayElementFactory
Factory for creating PanelOverlayElement instances.
Definition: OgreOverlayElementFactory.h:72
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::OverlayElement
Abstract definition of a 2D element to be displayed in an Overlay.
Definition: OgreOverlayElement.h:108
Ogre::BorderPanelOverlayElement
A specialisation of the PanelOverlayElement to provide a panel with a border.
Definition: OgreBorderPanelOverlayElement.h:57
Ogre::AllocatedObject
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Definition: OgreMemoryAllocatedObject.h:58

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.