OGRE  1.9
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::RibbonTrailFactory Class Reference

Factory object for creating RibbonTrail instances. More...

#include <OgreRibbonTrail.h>

+ Inheritance diagram for Ogre::RibbonTrailFactory:
+ Collaboration diagram for Ogre::RibbonTrailFactory:

Public Member Functions

 RibbonTrailFactory ()
 
 ~RibbonTrailFactory ()
 
void _notifyTypeFlags (uint32 flag)
 Notify this factory of the type mask to apply. More...
 
virtual 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 (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

MovableObjectcreateInstanceImpl (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 RibbonTrail instances.

Definition at line 227 of file OgreRibbonTrail.h.

Constructor & Destructor Documentation

Ogre::RibbonTrailFactory::RibbonTrailFactory ( )
inline

Definition at line 232 of file OgreRibbonTrail.h.

Ogre::RibbonTrailFactory::~RibbonTrailFactory ( )
inline

Definition at line 233 of file OgreRibbonTrail.h.

Member Function Documentation

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.

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
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.
MovableObject* Ogre::RibbonTrailFactory::createInstanceImpl ( const String name,
const NameValuePairList params 
)
protectedvirtual

Internal implementation of create method - must be overridden.

Implements Ogre::MovableObjectFactory.

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

Destroy an instance of the object.

Implements Ogre::MovableObjectFactory.

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

Get the type of the object to be created.

Implements Ogre::MovableObjectFactory.

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.

Definition at line 635 of file OgreMovableObject.h.

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

Definition at line 96 of file OgreMemoryAllocatedObject.h.

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

Definition at line 102 of file OgreMemoryAllocatedObject.h.

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

Definition at line 108 of file OgreMemoryAllocatedObject.h.

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

Definition at line 113 of file OgreMemoryAllocatedObject.h.

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

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 
)
inlineinherited

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)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

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

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 
)
inlineinherited

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)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

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::PortalFactory, and Ogre::AntiPortalFactory.

Definition at line 619 of file OgreMovableObject.h.

Member Data Documentation

String Ogre::RibbonTrailFactory::FACTORY_TYPE_NAME
static

Definition at line 235 of file OgreRibbonTrail.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: