Factory object for creating Portal instances. More...

#include <OgrePortal.h>

Inheritance diagram for Ogre::PortalFactory:

Public Member Functions
	PortalFactory ()

	~PortalFactory ()

void	_notifyTypeFlags (uint32 flag)
	Notify this factory of the type mask to apply. More...

MovableObject *	createInstance (const String &name, SceneManager manager, const NameValuePairList params=0)
	Create a new instance of the object. More...

void	destroyInstance (MovableObject *obj)
	Destroy an instance of the object. More...

const String &	getType () const
	Get the type of the object to be created. More...

uint32	getTypeFlags (void) const
	Gets the type flag for this factory. More...

bool	requestTypeFlags () const
	Return true here as we want to get a unique type flag. More...

Static Public Attributes
static unsigned long	FACTORY_TYPE_FLAG

static String	FACTORY_TYPE_NAME

Detailed Description

Factory object for creating Portal instances.

Constructor & Destructor Documentation

◆ PortalFactory()

Ogre::PortalFactory::PortalFactory ( )

inline

◆ ~PortalFactory()

Ogre::PortalFactory::~PortalFactory ( )

inline

Member Function Documentation

◆ getType()

const String& Ogre::PortalFactory::getType ( ) const

inlinevirtual

Get the type of the object to be created.

Implements Ogre::MovableObjectFactory.

◆ destroyInstance()

void Ogre::PortalFactory::destroyInstance ( MovableObject * obj )

virtual

Destroy an instance of the object.

Implements Ogre::MovableObjectFactory.

◆ requestTypeFlags()

bool Ogre::PortalFactory::requestTypeFlags ( void ) const

inlinevirtual

Return true here as we want to get a unique type flag.

Reimplemented from Ogre::MovableObjectFactory.

◆ createInstance()

MovableObject* Ogre::MovableObjectFactory::createInstance	(	const String &	name,
		SceneManager *	manager,
		const NameValuePairList *	params = `0`
	)

inherited

Create a new instance of the object.

Parameters

name	The name of the new object
manager	The SceneManager instance that will be holding the instance once created.
params	Name/value pair list of additional parameters required to construct the object (defined per subtype). Optional.

◆ _notifyTypeFlags()

void Ogre::MovableObjectFactory::_notifyTypeFlags ( uint32 flag )

inlineinherited

Notify this factory of the type mask to apply.

Remarks: This should normally only be called by Root in response to a 'true' result from requestTypeMask. However, you can actually use it yourself if you're careful; for example to assign the same mask to a number of different types of object, should you always wish them to be treated the same in queries.

◆ getTypeFlags()

uint32 Ogre::MovableObjectFactory::getTypeFlags ( void ) const

inlineinherited

Gets the type flag for this factory.

Remarks: A type flag is like a query flag, except that it applies to all instances of a certain type of object.

Member Data Documentation

◆ FACTORY_TYPE_NAME

String Ogre::PortalFactory::FACTORY_TYPE_NAME

static

◆ FACTORY_TYPE_FLAG

unsigned long Ogre::PortalFactory::FACTORY_TYPE_FLAG