Ogre::v1::OverlayElementFactory Class Reference

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

#include <OgreOverlayElementFactory.h>

Inheritance diagram for Ogre::v1::OverlayElementFactory:

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

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.

Constructor & Destructor Documentation

~OverlayElementFactory()

virtual Ogre::v1::OverlayElementFactory::~OverlayElementFactory ( )

inlinevirtual

Destroy the overlay element factory.

Member Function Documentation

createOverlayElement()

virtual OverlayElement * Ogre::v1::OverlayElementFactory::createOverlayElement ( const String &  instanceName )

pure virtual

Creates a new OverlayElement instance with the name supplied.

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

destroyOverlayElement()

virtual void Ogre::v1::OverlayElementFactory::destroyOverlayElement ( OverlayElement *  pElement )

inlinevirtual

Destroys a OverlayElement which this factory created previously.

getTypeName()

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

pure virtual

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

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

operator delete() [1/3]

template<class Alloc >

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

inlineinherited

operator delete() [2/3]

template<class Alloc >

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

inlineinherited

operator delete() [3/3]

template<class Alloc >

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

inlineinherited

operator delete[]() [1/2]

template<class Alloc >

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

inlineinherited

operator delete[]() [2/2]

template<class Alloc >

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

inlineinherited

operator new() [1/3]

template<class Alloc >

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

inlineinherited

operator new() [2/3]

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

operator new() [3/3]

template<class Alloc >

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

inlineinherited

placement operator new

operator new[]() [1/2]

template<class Alloc >

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

inlineinherited

operator new[]() [2/2]

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

---

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

• OgreOverlayElementFactory.h