Factory object for creating Portal instances. More...

#include <OgrePortalBase.h>

Inheritance diagram for Ogre::PortalBaseFactory:

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

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

virtual void	destroyInstance (MovableObject *obj)=0
	Destroy an instance of the object.

virtual const String &	getType (void) const =0
	Get the type of the object to be created.

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

virtual bool	requestTypeFlags (void) const
	Does this factory require the allocation of a 'type flag', used to selectively include / exclude this type from scene queries?

Detailed Description

Factory object for creating Portal instances.

Member Function Documentation

◆ getType()

virtual const String & Ogre::MovableObjectFactory::getType ( void ) const

pure virtualinherited

Get the type of the object to be created.

Implemented in Ogre::AntiPortalFactory, Ogre::PortalFactory, Ogre::BillboardChainFactory, Ogre::BillboardSetFactory, Ogre::EntityFactory, Ogre::LightFactory, Ogre::ManualObjectFactory, Ogre::ParticleSystemFactory, Ogre::RibbonTrailFactory, and Ogre::PCZLightFactory.

◆ 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.

◆ destroyInstance()

virtual void Ogre::MovableObjectFactory::destroyInstance ( MovableObject * obj )

pure virtualinherited

Destroy an instance of the object.

Implemented in Ogre::BillboardChainFactory, Ogre::BillboardSetFactory, Ogre::EntityFactory, Ogre::LightFactory, Ogre::ManualObjectFactory, Ogre::ParticleSystemFactory, Ogre::RibbonTrailFactory, Ogre::AntiPortalFactory, Ogre::PCZLightFactory, and Ogre::PortalFactory.

◆ requestTypeFlags()

virtual bool Ogre::MovableObjectFactory::requestTypeFlags ( void ) const

inlinevirtualinherited

Does this factory require the allocation of a 'type flag', used to selectively include / exclude this type from scene queries?

Remarks: The default implementation here is to return 'false', ie not to request a unique type mask from Root. For objects that never need to be excluded in SceneQuery results, that's fine, since the default implementation of MovableObject::getTypeFlags is to return all ones, hence matching any query type mask. However, if you want the objects created by this factory to be filterable by queries using a broad type, you have to give them a (preferably unique) type mask - and given that you don't know what other MovableObject types are registered, Root will allocate you one.

Reimplemented in Ogre::AntiPortalFactory, and Ogre::PortalFactory.

◆ _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