Factory object for creating BillboardSet instances. More...

#include <OgreBillboardSet.h>

Inheritance diagram for Ogre::BillboardSetFactory:

Public Member Functions
	BillboardSetFactory ()

	~BillboardSetFactory ()

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

virtual 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 (void) const
	Get the type of the object to be created. More...

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

void	operator delete (void *ptr)

void	operator delete (void ptr, void )

void	operator delete (void ptr, const char , int, const char *)

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, const char , int, const char *)

void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info More...

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *ptr)
	placement operator new More...

void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info More...

void *	operator new[] (size_t sz)

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? More...

Static Public Attributes
static String	FACTORY_TYPE_NAME

Protected Member Functions
MovableObject *	createInstanceImpl (const String &name, const NameValuePairList *params)
	Internal implementation of create method - must be overridden. More...

Protected Attributes
uint32	mTypeFlag
	Type flag, allocated if requested. More...

Detailed Description

Factory object for creating BillboardSet instances.

Definition at line 859 of file OgreBillboardSet.h.

Constructor & Destructor Documentation

Ogre::BillboardSetFactory::BillboardSetFactory ( )

Definition at line 864 of file OgreBillboardSet.h.

Ogre::BillboardSetFactory::~BillboardSetFactory ( )

Definition at line 865 of file OgreBillboardSet.h.

Member Function Documentation

void Ogre::MovableObjectFactory::_notifyTypeFlags ( uint32 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 628 of file OgreMovableObject.h.

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

virtualinherited

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::BillboardSetFactory::createInstanceImpl	(	const String &	name,
		const NameValuePairList *	params
	)

protectedvirtual

Internal implementation of create method - must be overridden.

Implements Ogre::MovableObjectFactory.

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

virtual

Destroy an instance of the object.

Implements Ogre::MovableObjectFactory.

const String& Ogre::BillboardSetFactory::getType ( void ) const

virtual

Get the type of the object to be created.

Implements Ogre::MovableObjectFactory.

uint32 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 635 of file OgreMovableObject.h.

template<class Alloc >

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

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

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

virtualinherited

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 619 of file OgreMovableObject.h.

Member Data Documentation

String Ogre::BillboardSetFactory::FACTORY_TYPE_NAME

static

Definition at line 867 of file OgreBillboardSet.h.

uint32 Ogre::MovableObjectFactory::mTypeFlag

protectedinherited

Type flag, allocated if requested.

Definition at line 582 of file OgreMovableObject.h.

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

OgreBillboardSet.h

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation