OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::OverlayElementFactory Class Referenceabstract

Defines the interface which all components wishing to supply OverlayElement subclasses must implement. More...

#include <OgreOverlayElementFactory.h>

+ Inheritance diagram for Ogre::OverlayElementFactory:
+ Collaboration diagram for Ogre::OverlayElementFactory:

Public Member Functions

virtual ~OverlayElementFactory ()
 Destroy the overlay element factory. More...
 
virtual OverlayElementcreateOverlayElement (const String &instanceName)=0
 Creates a new OverlayElement instance with the name supplied. More...
 
virtual void destroyOverlayElement (OverlayElement *pElement)
 Destroys a OverlayElement which this factory created previously. More...
 
virtual const StringgetTypeName (void) const =0
 Gets the string uniquely identifying the type of element this factory creates. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 

Detailed Description

Defines the interface which all components wishing to supply OverlayElement subclasses must implement.

Remarks
To allow the OverlayElement types available for inclusion on overlays to be extended, OGRE allows external apps or plugins to register their ability to create custom OverlayElements with the OverlayManager, using the addOverlayElementFactory method. Classes wanting to do this must implement this interface.
Each OverlayElementFactory creates a single type of OverlayElement, identified by a 'type name' which must be unique.

Definition at line 57 of file OgreOverlayElementFactory.h.

Constructor & Destructor Documentation

virtual Ogre::OverlayElementFactory::~OverlayElementFactory ( )
inlinevirtual

Destroy the overlay element factory.

Definition at line 61 of file OgreOverlayElementFactory.h.

Member Function Documentation

virtual OverlayElement* Ogre::OverlayElementFactory::createOverlayElement ( const String instanceName)
pure virtual
virtual void Ogre::OverlayElementFactory::destroyOverlayElement ( OverlayElement pElement)
inlinevirtual

Destroys a OverlayElement which this factory created previously.

Definition at line 65 of file OgreOverlayElementFactory.h.

virtual const String& Ogre::OverlayElementFactory::getTypeName ( void  ) const
pure virtual

Gets the string uniquely identifying the type of element this factory creates.

Implemented in Ogre::TextAreaOverlayElementFactory, Ogre::BorderPanelOverlayElementFactory, and Ogre::PanelOverlayElementFactory.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.


The documentation for this class was generated from the following file: