Ogre::LightFactory Class Reference

Factory object for creating Light instances. More...

#include <OgreLight.h>

Inheritance diagram for Ogre::LightFactory:

List of all members.

Public Member Functions
	LightFactory ()
	~LightFactory ()
const String &	getType (void) const
	Get the type of the object to be created.
void	destroyInstance (MovableObject *obj)
	Destroy an instance of the object.
virtual MovableObject *	createInstance (const String &name, SceneManager *manager, const NameValuePairList *params=0)
	Create a new instance of the object.
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?
void	_notifyTypeFlags (unsigned long flag)
	Notify this factory of the type mask to apply.
unsigned long	getTypeFlags (void) const
	Gets the type flag for this factory.
Static Public Attributes
String	FACTORY_TYPE_NAME
Protected Member Functions
MovableObject *	createInstanceImpl (const String &name, const NameValuePairList *params)
	Internal implementation of create method - must be overridden.
Protected Attributes
unsigned long	mTypeFlag
	Type flag, allocated if requested.

---

Detailed Description

Factory object for creating Light instances.

Definition at line 391 of file OgreLight.h.

---

Constructor & Destructor Documentation

Ogre::LightFactory::LightFactory (   )

Definition at line 396 of file OgreLight.h.

Ogre::LightFactory::~LightFactory (   )

Definition at line 397 of file OgreLight.h.

---

Member Function Documentation

void Ogre::MovableObjectFactory::_notifyTypeFlags (  unsigned long  flag  )  [inherited]

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. Definition at line 415 of file OgreMovableObject.h.

virtual MovableObject* Ogre::MovableObjectFactory::createInstance (  const String &  name, SceneManager *  manager, const NameValuePairList *  params = 0 )  [virtual, 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.

MovableObject* Ogre::LightFactory::createInstanceImpl (  const String &  name, const NameValuePairList *  params )  [protected, virtual]

Internal implementation of create method - must be overridden. Implements Ogre::MovableObjectFactory.

void Ogre::LightFactory::destroyInstance (  MovableObject *  obj  )  [virtual]

Destroy an instance of the object. Implements Ogre::MovableObjectFactory.

const String& Ogre::LightFactory::getType (  void   )  const [virtual]

Get the type of the object to be created. Implements Ogre::MovableObjectFactory.

unsigned long Ogre::MovableObjectFactory::getTypeFlags (  void   )  const [inherited]

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. Definition at line 422 of file OgreMovableObject.h.

virtual bool Ogre::MovableObjectFactory::requestTypeFlags (  void   )  const [virtual, inherited]

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. Definition at line 406 of file OgreMovableObject.h.

---

Member Data Documentation

String Ogre::LightFactory::FACTORY_TYPE_NAME [static]

Definition at line 399 of file OgreLight.h.

unsigned long Ogre::MovableObjectFactory::mTypeFlag [protected, inherited]

Type flag, allocated if requested. Definition at line 369 of file OgreMovableObject.h.

---

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

• OgreLight.h

---

Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 12 14:39:34 2006