OGRE  1.12.4
Object-Oriented Graphics Rendering Engine
Ogre::AntiPortalFactory Class Reference

Factory object for creating AntiPortal instances. More...

#include <OgreAntiPortal.h>

+ Inheritance diagram for Ogre::AntiPortalFactory:

Public Member Functions

 AntiPortalFactory ()
 
 ~AntiPortalFactory ()
 
void _notifyTypeFlags (uint32 flag)
 Notify this factory of the type mask to apply. More...
 
MovableObjectcreateInstance (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 StringgetType () 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 AntiPortal instances.

Constructor & Destructor Documentation

◆ AntiPortalFactory()

Ogre::AntiPortalFactory::AntiPortalFactory ( )
inline

◆ ~AntiPortalFactory()

Ogre::AntiPortalFactory::~AntiPortalFactory ( )
inline

Member Function Documentation

◆ getType()

const String& Ogre::AntiPortalFactory::getType ( ) const
inlinevirtual

Get the type of the object to be created.

Implements Ogre::MovableObjectFactory.

◆ destroyInstance()

void Ogre::AntiPortalFactory::destroyInstance ( MovableObject obj)
virtual

Destroy an instance of the object.

Implements Ogre::MovableObjectFactory.

◆ requestTypeFlags()

bool Ogre::AntiPortalFactory::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
nameThe name of the new object
managerThe SceneManager instance that will be holding the instance once created.
paramsName/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::AntiPortalFactory::FACTORY_TYPE_NAME
static

◆ FACTORY_TYPE_FLAG

unsigned long Ogre::AntiPortalFactory::FACTORY_TYPE_FLAG
static

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