[AE Engine logo] Public API Reference
Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

aeRegistry Class Reference

This class is an interface to the global object registry. More...

#include <registry.h>

Inheritance diagram for aeRegistry:

aeBase List of all members.

Public Member Functions

 aeRegistry (int argc, char *argv[])
 Initialize the registry.

bool checkCmdLineHelp () const
 Check if the -help flag was specified in the command line.

void printHelp ()
 Print help.

aeBasequeryInterface (aeInterface interface)
 Query for an interface.

unsigned int getInterfaceCount () const
 Get the number of interfaces in the interfacepool.

aeObjectfindObjectByName (const char *)
 Find object by name.

unsigned int getObjectCount () const
 Get the number of objects in the objectpool.

aeTexturefindTextureByName (const char *)
 Find texture by name.

unsigned int getTextureCount () const
 Get the number of textures in the texturepool.

aeMaterialfindMaterialByName (const char *)
 Find material by name.

unsigned int getMaterialCount () const
 Get the number of materials in the materialpool.

void pushObjectToPool (aeObject *)
 Push an object to the objectpool.

void pushTextureToPool (aeTexture *)
 Push a texture to the texturepool.

void pushMaterialToPool (aeMaterial *)
 Push a material to the materialpool.

aePluginloadPlugin (aeInterface)
 Load a plugin.


Static Public Attributes

aeRegistry * self_ptr
 Global registry self ref.


Private Attributes

aeBaseptr_map interfacePool
aeObjectptr_map objectPool
aeMaterialptr_map materialPool
aeTextureptr_map texturePool
bool cmdLineHelpRequested

Detailed Description

This class is an interface to the global object registry.

Definition at line 86 of file registry.h.


Constructor & Destructor Documentation

aeRegistry::aeRegistry int    argc,
char *    argv[]
 

Initialize the registry.

Parameters:
argc argc from main().
argv argv from main().


Member Function Documentation

bool aeRegistry::checkCmdLineHelp   const [inline]
 

Check if the -help flag was specified in the command line.

Returns:
true if -help was requested.

Definition at line 114 of file registry.h.

aeMaterial* aeRegistry::findMaterialByName const char *   
 

Find material by name.

Parameters:
char * The material name.
Returns:
The material.

aeObject* aeRegistry::findObjectByName const char *   
 

Find object by name.

Parameters:
char * The object name.
Returns:
The object.

aeTexture* aeRegistry::findTextureByName const char *   
 

Find texture by name.

Parameters:
char * The texture name.
Returns:
The texture.

unsigned int aeRegistry::getInterfaceCount   const [inline]
 

Get the number of interfaces in the interfacepool.

Returns:
The number of interfaces.

Definition at line 136 of file registry.h.

unsigned int aeRegistry::getMaterialCount   const [inline]
 

Get the number of materials in the materialpool.

Returns:
The number of materials.

Definition at line 184 of file registry.h.

unsigned int aeRegistry::getObjectCount   const [inline]
 

Get the number of objects in the objectpool.

Returns:
The number of objects.

Definition at line 152 of file registry.h.

unsigned int aeRegistry::getTextureCount   const [inline]
 

Get the number of textures in the texturepool.

Returns:
The number of textures.

Definition at line 168 of file registry.h.

aePlugin* aeRegistry::loadPlugin aeInterface   
 

Load a plugin.

Use the AE_GET_PLUGIN() macro to load a plugin.

Parameters:
aePluginID The plugin ID.
Returns:
Pointer to the plugin.

void aeRegistry::printHelp  
 

Print help.

void aeRegistry::pushMaterialToPool aeMaterial  
 

Push a material to the materialpool.

Normally you don't need to do this since adding a material will do it automagically.

Parameters:
aeMaterial * The material.

void aeRegistry::pushObjectToPool aeObject  
 

Push an object to the objectpool.

Use aeEngine::AddObject() to add an object.

Parameters:
aeObject * The object.

void aeRegistry::pushTextureToPool aeTexture  
 

Push a texture to the texturepool.

Normally you don't need to do this since the texture loader plugin will take care of it.

Parameters:
aeTexture * The texture.

aeBase* aeRegistry::queryInterface aeInterface    interface
 

Query for an interface.

This returns a pointer to the interface requested. If no such interface instance exists in the registry NULL is returned.

Parameters:
iface Interface to query (e.g. aeSystem).
Returns:
Pointer to the interface.


The documentation for this class was generated from the following file:
AE Engine Public API Reference
Generated on Wed Apr 9 09:43:41 2003 by Doxygen.