#include <OgreRoot.h>
Public Types | ||||||||||||||||
typedef std::vector< DynLib * > | PluginLibList | |||||||||||||||
typedef std::vector< Plugin * > | PluginInstanceList | |||||||||||||||
typedef ConstMapIterator < MovableObjectFactoryMap > | MovableObjectFactoryIterator | |||||||||||||||
Public Member Functions | ||||||||||||||||
Root (const String &pluginFileName="plugins.cfg", const String &configFileName="ogre.cfg", const String &logFileName="Ogre.log") | ||||||||||||||||
Constructor. | ||||||||||||||||
~Root () | ||||||||||||||||
void | saveConfig (void) | |||||||||||||||
Saves the details of the current configuration. | ||||||||||||||||
bool | restoreConfig (void) | |||||||||||||||
Checks for saved video/sound/etc settings. | ||||||||||||||||
bool | showConfigDialog (void) | |||||||||||||||
Displays a dialog asking the user to choose system settings. | ||||||||||||||||
void | addRenderSystem (RenderSystem *newRend) | |||||||||||||||
Adds a new rendering subsystem to the list of available renderers. | ||||||||||||||||
RenderSystemList * | getAvailableRenderers (void) | |||||||||||||||
Retrieve a list of the available render systems. | ||||||||||||||||
RenderSystem * | getRenderSystemByName (const String &name) | |||||||||||||||
Retrieve a pointer to the render system by the given name. | ||||||||||||||||
void | setRenderSystem (RenderSystem *system) | |||||||||||||||
Sets the rendering subsystem to be used. | ||||||||||||||||
RenderSystem * | getRenderSystem (void) | |||||||||||||||
Retrieve a pointer to the currently selected render system. | ||||||||||||||||
RenderWindow * | initialise (bool autoCreateWindow, const String &windowTitle="OGRE Render Window", const String &customCapabilitiesConfig=StringUtil::BLANK) | |||||||||||||||
Initialises the renderer. | ||||||||||||||||
bool | isInitialised (void) const | |||||||||||||||
Returns whether the system is initialised or not. | ||||||||||||||||
void | useCustomRenderSystemCapabilities (RenderSystemCapabilities *capabilities) | |||||||||||||||
Requests active RenderSystem to use custom RenderSystemCapabilities. | ||||||||||||||||
void | addSceneManagerFactory (SceneManagerFactory *fact) | |||||||||||||||
Register a new SceneManagerFactory, a factory object for creating instances of specific SceneManagers. | ||||||||||||||||
void | removeSceneManagerFactory (SceneManagerFactory *fact) | |||||||||||||||
Unregister a SceneManagerFactory. | ||||||||||||||||
const SceneManagerMetaData * | getSceneManagerMetaData (const String &typeName) const | |||||||||||||||
Get more information about a given type of SceneManager. | ||||||||||||||||
SceneManagerEnumerator::MetaDataIterator | getSceneManagerMetaDataIterator (void) const | |||||||||||||||
Iterate over all types of SceneManager available for construction, providing some information about each one. | ||||||||||||||||
SceneManager * | createSceneManager (const String &typeName, const String &instanceName=StringUtil::BLANK) | |||||||||||||||
Create a SceneManager instance of a given type. | ||||||||||||||||
SceneManager * | createSceneManager (SceneTypeMask typeMask, const String &instanceName=StringUtil::BLANK) | |||||||||||||||
Create a SceneManager instance based on scene type support. | ||||||||||||||||
void | destroySceneManager (SceneManager *sm) | |||||||||||||||
Destroy an instance of a SceneManager. | ||||||||||||||||
SceneManager * | getSceneManager (const String &instanceName) const | |||||||||||||||
Get an existing SceneManager instance that has already been created, identified by the instance name. | ||||||||||||||||
SceneManagerEnumerator::SceneManagerIterator | getSceneManagerIterator (void) | |||||||||||||||
Get an iterator over all the existing SceneManager instances. | ||||||||||||||||
TextureManager * | getTextureManager (void) | |||||||||||||||
Retrieves a reference to the current TextureManager. | ||||||||||||||||
MeshManager * | getMeshManager (void) | |||||||||||||||
Retrieves a reference to the current MeshManager. | ||||||||||||||||
String | getErrorDescription (long errorNumber) | |||||||||||||||
Utility function for getting a better description of an error code. | ||||||||||||||||
void | addFrameListener (FrameListener *newListener) | |||||||||||||||
Registers a FrameListener which will be called back every frame. | ||||||||||||||||
void | removeFrameListener (FrameListener *oldListener) | |||||||||||||||
Removes a FrameListener from the list of listening classes. | ||||||||||||||||
void | queueEndRendering (void) | |||||||||||||||
Queues the end of rendering. | ||||||||||||||||
void | startRendering (void) | |||||||||||||||
Starts / restarts the automatic rendering cycle. | ||||||||||||||||
bool | renderOneFrame (void) | |||||||||||||||
Render one frame. | ||||||||||||||||
void | shutdown (void) | |||||||||||||||
Shuts down the system manually. | ||||||||||||||||
void | addResourceLocation (const String &name, const String &locType, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME, bool recursive=false) | |||||||||||||||
Adds a location to the list of searchable locations for a Resource type. | ||||||||||||||||
void | removeResourceLocation (const String &name, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME) | |||||||||||||||
Removes a resource location from the list. | ||||||||||||||||
void | convertColourValue (const ColourValue &colour, uint32 *pDest) | |||||||||||||||
Generates a packed data version of the passed in ColourValue suitable for use with the current RenderSystem. | ||||||||||||||||
RenderWindow * | getAutoCreatedWindow (void) | |||||||||||||||
Retrieves a pointer to the window that was created automatically. | ||||||||||||||||
RenderWindow * | createRenderWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0) | |||||||||||||||
Creates a new rendering window.
Key: "colourDepth" Description: Colour depth of the resulting rendering window; only applies if fullScreen is set. Values: 16 or 32 Default: desktop depth Notes: [W32 specific] Key: "left" Description: screen x coordinate from left Values: positive integers Default: 'center window on screen' Notes: Ignored in case of full screen Key: "top" Description: screen y coordinate from top Values: positive integers Default: 'center window on screen' Notes: Ignored in case of full screen Key: "depthBuffer" [DX9 specific] Description: Use depth buffer Values: false or true Default: true Key: "externalWindowHandle" [API specific] Description: External window handle, for embedding the OGRE context Values: positive integer for W32 (HWND handle) poslong:posint:poslong (display*:screen:windowHandle) or poslong:posint:poslong:poslong (display*:screen:windowHandle:XVisualInfo*) for GLX Default: 0 (None) Key: "externalGLControl" [Win32 OpenGL specific] Description: Let the external window control OpenGL i.e. don't select a pixel format for the window, do not change v-sync and do not swap buffer. When set to true, the calling application is responsible of OpenGL initialization and buffer swapping. It should also create an OpenGL context for its own rendering, Ogre will create one for its use. Then the calling application must also enable Ogre OpenGL context before calling any Ogre function and restore its OpenGL context after these calls. The Ogre OpenGL context can be retrieved after Ogre initialisation by calling wglGetCurrentDC() and wglGetCurrentContext(). It is only used when the externalWindowHandle parameter is used. Values: true, false Default: false Key: "externalGLContext" [Win32 OpenGL specific] Description: Use an externally created GL context Values: <Context as="" unsigned="" long>=""> Default: 0 (create own context) Key: "parentWindowHandle" [API specific] Description: Parent window handle, for embedding the OGRE context Values: positive integer for W32 (HWND handle) poslong:posint:poslong for GLX (display*:screen:windowHandle) Default: 0 (None) Key: "FSAA" Description: Full screen antialiasing factor Values: 0,2,4,6,... Default: 0 Key: "displayFrequency" Description: Display frequency rate, for fullscreen mode Values: 60...? Default: Desktop vsync rate Key: "vsync" Description: Synchronize buffer swaps to vsync Values: true, false Default: 0 Key: "border" Description: The type of window border (in windowed mode) Values: none, fixed, resize Default: resize Key: "outerDimensions" Description: Whether the width/height is expressed as the size of the outer window, rather than the content area Values: true, false Default: false Key: "useNVPerfHUD" [DX9 specific] Description: Enable the use of nVidia NVPerfHUD Values: true, false Default: false
Key: "gamma" Description: Enable hardware conversion from linear colour space to gamma colour space on rendering to the window. Values: true, false Default: false | ||||||||||||||||
void | detachRenderTarget (RenderTarget *pWin) | |||||||||||||||
Destroys a rendering window. | ||||||||||||||||
void | detachRenderTarget (const String &name) | |||||||||||||||
Destroys a named rendering window. | ||||||||||||||||
RenderTarget * | getRenderTarget (const String &name) | |||||||||||||||
Retrieves a pointer to the a named render window. | ||||||||||||||||
void | loadPlugin (const String &pluginName) | |||||||||||||||
Manually load a Plugin contained in a DLL / DSO. | ||||||||||||||||
void | unloadPlugin (const String &pluginName) | |||||||||||||||
Manually unloads a Plugin contained in a DLL / DSO. | ||||||||||||||||
void | installPlugin (Plugin *plugin) | |||||||||||||||
Install a new plugin. | ||||||||||||||||
void | uninstallPlugin (Plugin *plugin) | |||||||||||||||
Uninstall an existing plugin. | ||||||||||||||||
const PluginInstanceList & | getInstalledPlugins () const | |||||||||||||||
Gets a read-only list of the currently installed plugins. | ||||||||||||||||
Timer * | getTimer (void) | |||||||||||||||
Gets a pointer to the central timer used for all OGRE timings. | ||||||||||||||||
bool | _fireFrameStarted (FrameEvent &evt) | |||||||||||||||
Method for raising frame started events. | ||||||||||||||||
bool | _fireFrameRenderingQueued (FrameEvent &evt) | |||||||||||||||
Method for raising frame rendering queued events. | ||||||||||||||||
bool | _fireFrameEnded (FrameEvent &evt) | |||||||||||||||
Method for raising frame ended events. | ||||||||||||||||
bool | _fireFrameStarted () | |||||||||||||||
Method for raising frame started events. | ||||||||||||||||
bool | _fireFrameRenderingQueued () | |||||||||||||||
Method for raising frame rendering queued events. | ||||||||||||||||
bool | _fireFrameEnded () | |||||||||||||||
Method for raising frame ended events. | ||||||||||||||||
unsigned long | getNextFrameNumber (void) const | |||||||||||||||
Gets the number of the next frame to be rendered. | ||||||||||||||||
SceneManager * | _getCurrentSceneManager (void) const | |||||||||||||||
Returns the scene manager currently being used to render a frame. | ||||||||||||||||
void | _setCurrentSceneManager (SceneManager *sm) | |||||||||||||||
Sets the scene manager currently being used to render a frame. | ||||||||||||||||
bool | _updateAllRenderTargets (void) | |||||||||||||||
Internal method used for updating all RenderTarget objects (windows, renderable textures etc) which are set to auto-update. | ||||||||||||||||
RenderQueueInvocationSequence * | createRenderQueueInvocationSequence (const String &name) | |||||||||||||||
Create a new RenderQueueInvocationSequence, useful for linking to Viewport instances to perform custom rendering. | ||||||||||||||||
RenderQueueInvocationSequence * | getRenderQueueInvocationSequence (const String &name) | |||||||||||||||
Get a RenderQueueInvocationSequence. | ||||||||||||||||
void | destroyRenderQueueInvocationSequence (const String &name) | |||||||||||||||
Destroy a RenderQueueInvocationSequence. | ||||||||||||||||
void | destroyAllRenderQueueInvocationSequences (void) | |||||||||||||||
Destroy all RenderQueueInvocationSequences. | ||||||||||||||||
void | clearEventTimes (void) | |||||||||||||||
Clears the history of all event times. | ||||||||||||||||
void | setFrameSmoothingPeriod (Real period) | |||||||||||||||
Sets the period over which OGRE smooths out fluctuations in frame times. | ||||||||||||||||
Real | getFrameSmoothingPeriod (void) const | |||||||||||||||
Gets the period over which OGRE smooths out fluctuations in frame times. | ||||||||||||||||
void | addMovableObjectFactory (MovableObjectFactory *fact, bool overrideExisting=false) | |||||||||||||||
Register a new MovableObjectFactory which will create new MovableObject instances of a particular type, as identified by the getType() method. | ||||||||||||||||
void | removeMovableObjectFactory (MovableObjectFactory *fact) | |||||||||||||||
Removes a previously registered MovableObjectFactory. | ||||||||||||||||
bool | hasMovableObjectFactory (const String &typeName) const | |||||||||||||||
Checks whether a factory is registered for a given MovableObject type. | ||||||||||||||||
MovableObjectFactory * | getMovableObjectFactory (const String &typeName) | |||||||||||||||
Get a MovableObjectFactory for the given type. | ||||||||||||||||
uint32 | _allocateNextMovableObjectTypeFlag (void) | |||||||||||||||
Allocate the next MovableObject type flag. | ||||||||||||||||
MovableObjectFactoryIterator | getMovableObjectFactoryIterator (void) const | |||||||||||||||
Return an iterator over all the MovableObjectFactory instances currently registered. | ||||||||||||||||
void * | operator new (size_t sz, const char *file, int line, const char *func) | |||||||||||||||
operator new, with debug line info | ||||||||||||||||
void * | operator new (size_t sz) | |||||||||||||||
void * | operator new (size_t sz, void *ptr) | |||||||||||||||
placement operator new | ||||||||||||||||
void * | operator new[] (size_t sz, const char *file, int line, const char *func) | |||||||||||||||
array operator new, with debug line info | ||||||||||||||||
void * | operator new[] (size_t sz) | |||||||||||||||
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 *) | |||||||||||||||
Static Public Member Functions | ||||||||||||||||
static Root & | getSingleton (void) | |||||||||||||||
Override standard Singleton retrieval. | ||||||||||||||||
static Root * | getSingletonPtr (void) | |||||||||||||||
Override standard Singleton retrieval. | ||||||||||||||||
Protected Types | ||||||||||||||||
enum | FrameEventTimeType { FETT_ANY = 0, FETT_STARTED = 1, FETT_QUEUED = 2, FETT_ENDED = 3, FETT_COUNT = 4 } | |||||||||||||||
Indicates the type of event to be considered by calculateEventTime(). More... | ||||||||||||||||
typedef std::map< String, MovableObjectFactory * > | MovableObjectFactoryMap | |||||||||||||||
typedef std::map< String, RenderQueueInvocationSequence * > | RenderQueueInvocationSequenceMap | |||||||||||||||
Protected Member Functions | ||||||||||||||||
void | loadPlugins (const String &pluginsfile="plugins.cfg") | |||||||||||||||
Method reads a plugins configuration file and instantiates all plugins. | ||||||||||||||||
void | initialisePlugins () | |||||||||||||||
Initialise all loaded plugins - allows plugins to perform actions once the renderer is initialised. | ||||||||||||||||
void | shutdownPlugins () | |||||||||||||||
Shuts down all loaded plugins - allows things to be tidied up whilst all plugins are still loaded. | ||||||||||||||||
void | unloadPlugins () | |||||||||||||||
Unloads all loaded plugins. | ||||||||||||||||
void | oneTimePostWindowInit (void) | |||||||||||||||
Real | calculateEventTime (unsigned long now, FrameEventTimeType type) | |||||||||||||||
Internal method for calculating the average time between recently fired events. | ||||||||||||||||
Protected Attributes | ||||||||||||||||
PluginLibList | mPluginLibs | |||||||||||||||
List of plugin DLLs loaded. | ||||||||||||||||
PluginInstanceList | mPlugins | |||||||||||||||
List of Plugin instances registered. | ||||||||||||||||
MovableObjectFactoryMap | mMovableObjectFactoryMap | |||||||||||||||
uint32 | mNextMovableObjectTypeFlag | |||||||||||||||
MovableObjectFactory * | mEntityFactory | |||||||||||||||
MovableObjectFactory * | mLightFactory | |||||||||||||||
MovableObjectFactory * | mBillboardSetFactory | |||||||||||||||
MovableObjectFactory * | mManualObjectFactory | |||||||||||||||
MovableObjectFactory * | mBillboardChainFactory | |||||||||||||||
MovableObjectFactory * | mRibbonTrailFactory | |||||||||||||||
RenderQueueInvocationSequenceMap | mRQSequenceMap | |||||||||||||||
bool | mIsInitialised | |||||||||||||||
Are we initialised yet? | ||||||||||||||||
std::set< FrameListener * > | mFrameListeners | |||||||||||||||
Set of registered frame listeners. | ||||||||||||||||
std::set< FrameListener * > | mRemovedFrameListeners | |||||||||||||||
Set of frame listeners marked for removal. | ||||||||||||||||
std::deque< unsigned long > | mEventTimes [FETT_COUNT] | |||||||||||||||
Contains the times of recently fired events. | ||||||||||||||||
Static Protected Attributes | ||||||||||||||||
static T * | ms_Singleton | |||||||||||||||
Private Attributes | ||||||||||||||||
RenderSystemList | mRenderers | |||||||||||||||
RenderSystem * | mActiveRenderer | |||||||||||||||
String | mVersion | |||||||||||||||
String | mConfigFileName | |||||||||||||||
bool | mQueuedEnd | |||||||||||||||
bool | mFirstTimePostWindowInit | |||||||||||||||
LogManager * | mLogManager | |||||||||||||||
ControllerManager * | mControllerManager | |||||||||||||||
SceneManagerEnumerator * | mSceneManagerEnum | |||||||||||||||
SceneManager * | mCurrentSceneManager | |||||||||||||||
DynLibManager * | mDynLibManager | |||||||||||||||
ArchiveManager * | mArchiveManager | |||||||||||||||
MaterialManager * | mMaterialManager | |||||||||||||||
MeshManager * | mMeshManager | |||||||||||||||
ParticleSystemManager * | mParticleManager | |||||||||||||||
SkeletonManager * | mSkeletonManager | |||||||||||||||
OverlayElementFactory * | mPanelFactory | |||||||||||||||
OverlayElementFactory * | mBorderPanelFactory | |||||||||||||||
OverlayElementFactory * | mTextAreaFactory | |||||||||||||||
OverlayManager * | mOverlayManager | |||||||||||||||
FontManager * | mFontManager | |||||||||||||||
ArchiveFactory * | mZipArchiveFactory | |||||||||||||||
ArchiveFactory * | mFileSystemArchiveFactory | |||||||||||||||
ResourceGroupManager * | mResourceGroupManager | |||||||||||||||
ResourceBackgroundQueue * | mResourceBackgroundQueue | |||||||||||||||
ShadowTextureManager * | mShadowTextureManager | |||||||||||||||
RenderSystemCapabilitiesManager * | mRenderSystemCapabilitiesManager | |||||||||||||||
ScriptCompilerManager * | mCompilerManager | |||||||||||||||
Timer * | mTimer | |||||||||||||||
RenderWindow * | mAutoWindow | |||||||||||||||
Profiler * | mProfiler | |||||||||||||||
HighLevelGpuProgramManager * | mHighLevelGpuProgramManager | |||||||||||||||
ExternalTextureSourceManager * | mExternalTextureSourceManager | |||||||||||||||
CompositorManager * | mCompositorManager | |||||||||||||||
unsigned long | mNextFrame | |||||||||||||||
Real | mFrameSmoothingTime | |||||||||||||||
Friends | ||||||||||||||||
class | RenderSystem |
Definition at line 59 of file OgreRoot.h.
typedef std::vector<DynLib*> Ogre::Root::PluginLibList |
Definition at line 107 of file OgreRoot.h.
typedef std::vector<Plugin*> Ogre::Root::PluginInstanceList |
Definition at line 108 of file OgreRoot.h.
typedef std::map<String, MovableObjectFactory*> Ogre::Root::MovableObjectFactoryMap [protected] |
Definition at line 115 of file OgreRoot.h.
typedef std::map<String, RenderQueueInvocationSequence*> Ogre::Root::RenderQueueInvocationSequenceMap [protected] |
Definition at line 126 of file OgreRoot.h.
Definition at line 881 of file OgreRoot.h.
enum Ogre::Root::FrameEventTimeType [protected] |
Indicates the type of event to be considered by calculateEventTime().
Definition at line 162 of file OgreRoot.h.
Ogre::Root::Root | ( | const String & | pluginFileName = "plugins.cfg" , |
|
const String & | configFileName = "ogre.cfg" , |
|||
const String & | logFileName = "Ogre.log" | |||
) |
Constructor.
pluginFileName | The file that contains plugins information. Defaults to "plugins.cfg", may be left blank to ignore. | |
configFileName | The file that contains the configuration to be loaded. Defaults to "ogre.cfg", may be left blank to load nothing. | |
logFileName | The logfile to create, defaults to Ogre.log, may be left blank if you've already set up LogManager & Log yourself |
Ogre::Root::~Root | ( | ) |
void Ogre::Root::loadPlugins | ( | const String & | pluginsfile = "plugins.cfg" |
) | [protected] |
Method reads a plugins configuration file and instantiates all plugins.
pluginsfile | The file that contains plugins information. Defaults to "plugins.cfg". |
void Ogre::Root::initialisePlugins | ( | ) | [protected] |
Initialise all loaded plugins - allows plugins to perform actions once the renderer is initialised.
void Ogre::Root::shutdownPlugins | ( | ) | [protected] |
Shuts down all loaded plugins - allows things to be tidied up whilst all plugins are still loaded.
void Ogre::Root::unloadPlugins | ( | ) | [protected] |
Unloads all loaded plugins.
void Ogre::Root::oneTimePostWindowInit | ( | void | ) | [protected] |
Real Ogre::Root::calculateEventTime | ( | unsigned long | now, | |
FrameEventTimeType | type | |||
) | [protected] |
Internal method for calculating the average time between recently fired events.
now | The current time in ms. | |
type | The type of event to be considered. |
void Ogre::Root::saveConfig | ( | void | ) |
Saves the details of the current configuration.
bool Ogre::Root::restoreConfig | ( | void | ) |
Checks for saved video/sound/etc settings.
bool Ogre::Root::showConfigDialog | ( | void | ) |
Displays a dialog asking the user to choose system settings.
void Ogre::Root::addRenderSystem | ( | RenderSystem * | newRend | ) |
Adds a new rendering subsystem to the list of available renderers.
RenderSystemList* Ogre::Root::getAvailableRenderers | ( | void | ) |
Retrieve a list of the available render systems.
RenderSystem* Ogre::Root::getRenderSystemByName | ( | const String & | name | ) |
Retrieve a pointer to the render system by the given name.
name | Name of the render system intend to retrieve. |
void Ogre::Root::setRenderSystem | ( | RenderSystem * | system | ) |
Sets the rendering subsystem to be used.
system | Pointer to the render system to use. |
RenderSystem* Ogre::Root::getRenderSystem | ( | void | ) |
Retrieve a pointer to the currently selected render system.
RenderWindow* Ogre::Root::initialise | ( | bool | autoCreateWindow, | |
const String & | windowTitle = "OGRE Render Window" , |
|||
const String & | customCapabilitiesConfig = StringUtil::BLANK | |||
) |
Initialises the renderer.
autoCreateWindow | If true, a rendering window will automatically be created (saving a call to Root::createRenderWindow). The window will be created based on the options currently set on the render system. |
bool Ogre::Root::isInitialised | ( | void | ) | const |
void Ogre::Root::useCustomRenderSystemCapabilities | ( | RenderSystemCapabilities * | capabilities | ) |
Requests active RenderSystem to use custom RenderSystemCapabilities.
void Ogre::Root::addSceneManagerFactory | ( | SceneManagerFactory * | fact | ) |
Register a new SceneManagerFactory, a factory object for creating instances of specific SceneManagers.
void Ogre::Root::removeSceneManagerFactory | ( | SceneManagerFactory * | fact | ) |
Unregister a SceneManagerFactory.
const SceneManagerMetaData* Ogre::Root::getSceneManagerMetaData | ( | const String & | typeName | ) | const |
Get more information about a given type of SceneManager.
typeName | The type name of the SceneManager you want to enquire on. If you don't know the typeName already, you can iterate over the metadata for all types using getMetaDataIterator. |
SceneManagerEnumerator::MetaDataIterator Ogre::Root::getSceneManagerMetaDataIterator | ( | void | ) | const |
Iterate over all types of SceneManager available for construction, providing some information about each one.
SceneManager* Ogre::Root::createSceneManager | ( | const String & | typeName, | |
const String & | instanceName = StringUtil::BLANK | |||
) |
Create a SceneManager instance of a given type.
typeName | String identifying a unique SceneManager type | |
instanceName | Optional name to given the new instance that is created. If you leave this blank, an auto name will be assigned. |
SceneManager* Ogre::Root::createSceneManager | ( | SceneTypeMask | typeMask, | |
const String & | instanceName = StringUtil::BLANK | |||
) |
Create a SceneManager instance based on scene type support.
typeMask | A mask containing one or more SceneType flags | |
instanceName | Optional name to given the new instance that is created. If you leave this blank, an auto name will be assigned. |
void Ogre::Root::destroySceneManager | ( | SceneManager * | sm | ) |
Destroy an instance of a SceneManager.
SceneManager* Ogre::Root::getSceneManager | ( | const String & | instanceName | ) | const |
Get an existing SceneManager instance that has already been created, identified by the instance name.
instanceName | The name of the instance to retrieve. |
SceneManagerEnumerator::SceneManagerIterator Ogre::Root::getSceneManagerIterator | ( | void | ) |
Get an iterator over all the existing SceneManager instances.
TextureManager* Ogre::Root::getTextureManager | ( | void | ) |
Retrieves a reference to the current TextureManager.
MeshManager* Ogre::Root::getMeshManager | ( | void | ) |
Retrieves a reference to the current MeshManager.
String Ogre::Root::getErrorDescription | ( | long | errorNumber | ) |
Utility function for getting a better description of an error code.
void Ogre::Root::addFrameListener | ( | FrameListener * | newListener | ) |
Registers a FrameListener which will be called back every frame.
void Ogre::Root::removeFrameListener | ( | FrameListener * | oldListener | ) |
Removes a FrameListener from the list of listening classes.
void Ogre::Root::queueEndRendering | ( | void | ) |
Queues the end of rendering.
void Ogre::Root::startRendering | ( | void | ) |
Starts / restarts the automatic rendering cycle.
This frees up the CPU to do other things in between refreshes, since in this case frame rate is less important.
This method can only be called after Root::initialise has been called.
bool Ogre::Root::renderOneFrame | ( | void | ) |
Render one frame.
void Ogre::Root::shutdown | ( | void | ) |
void Ogre::Root::addResourceLocation | ( | const String & | name, | |
const String & | locType, | |||
const String & | groupName = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME , |
|||
bool | recursive = false | |||
) |
Adds a location to the list of searchable locations for a Resource type.
name | The name of the location, e.g. './data' or '/compressed/gamedata.zip' | |
locType | A string identifying the location type, e.g. 'FileSystem' (for folders), 'Zip' etc. Must map to a registered plugin which deals with this type (FileSystem and Zip should always be available) | |
groupName | Type of name of the resource group which this location should apply to; defaults to the General group which applies to all non-specific resources. | |
recursive | If the resource location has a concept of recursive directory traversal, enabling this option will mean you can load resources in subdirectories using only their unqualified name. The default is to disable this so that resources in subdirectories with the same name are still unique. |
void Ogre::Root::removeResourceLocation | ( | const String & | name, | |
const String & | groupName = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME | |||
) |
Removes a resource location from the list.
name | The name of the resource location as specified in addResourceLocation | |
groupName | The name of the resource group to which this location was assigned. |
void Ogre::Root::convertColourValue | ( | const ColourValue & | colour, | |
uint32 * | pDest | |||
) |
Generates a packed data version of the passed in ColourValue suitable for use with the current RenderSystem.
colour | The colour to convert | |
pDest | Pointer to location to put the result. |
RenderWindow* Ogre::Root::getAutoCreatedWindow | ( | void | ) |
RenderWindow* Ogre::Root::createRenderWindow | ( | const String & | name, | |
unsigned int | width, | |||
unsigned int | height, | |||
bool | fullScreen, | |||
const NameValuePairList * | miscParams = 0 | |||
) |
Creates a new rendering window.
name | The name of the window. Used in other methods later like setRenderTarget and getRenderWindow. | |
width | The width of the new window. | |
height | The height of the new window. | |
fullScreen | Specify true to make the window full screen without borders, title bar or menu bar. | |
miscParams | A NameValuePairList describing the other parameters for the new rendering window. Options are case sensitive. Unrecognised parameters will be ignored silently. These values might be platform dependent, but these are present for all platforms unless indicated otherwise: |
Key: "colourDepth" Description: Colour depth of the resulting rendering window; only applies if fullScreen is set. Values: 16 or 32 Default: desktop depth Notes: [W32 specific]
Key: "left" Description: screen x coordinate from left Values: positive integers Default: 'center window on screen' Notes: Ignored in case of full screen
Key: "top" Description: screen y coordinate from top Values: positive integers Default: 'center window on screen' Notes: Ignored in case of full screen
Key: "depthBuffer" [DX9 specific] Description: Use depth buffer Values: false or true Default: true
Key: "externalWindowHandle" [API specific] Description: External window handle, for embedding the OGRE context Values: positive integer for W32 (HWND handle) poslong:posint:poslong (display*:screen:windowHandle) or poslong:posint:poslong:poslong (display*:screen:windowHandle:XVisualInfo*) for GLX Default: 0 (None)
Key: "externalGLControl" [Win32 OpenGL specific] Description: Let the external window control OpenGL i.e. don't select a pixel format for the window, do not change v-sync and do not swap buffer. When set to true, the calling application is responsible of OpenGL initialization and buffer swapping. It should also create an OpenGL context for its own rendering, Ogre will create one for its use. Then the calling application must also enable Ogre OpenGL context before calling any Ogre function and restore its OpenGL context after these calls. The Ogre OpenGL context can be retrieved after Ogre initialisation by calling wglGetCurrentDC() and wglGetCurrentContext(). It is only used when the externalWindowHandle parameter is used. Values: true, false Default: false
Key: "externalGLContext" [Win32 OpenGL specific] Description: Use an externally created GL context Values: <Context as="" unsigned="" long>=""> Default: 0 (create own context)
Key: "parentWindowHandle" [API specific] Description: Parent window handle, for embedding the OGRE context Values: positive integer for W32 (HWND handle) poslong:posint:poslong for GLX (display*:screen:windowHandle) Default: 0 (None)
Key: "FSAA" Description: Full screen antialiasing factor Values: 0,2,4,6,... Default: 0
Key: "displayFrequency" Description: Display frequency rate, for fullscreen mode Values: 60...? Default: Desktop vsync rate
Key: "vsync" Description: Synchronize buffer swaps to vsync Values: true, false Default: 0
Key: "border" Description: The type of window border (in windowed mode) Values: none, fixed, resize Default: resize
Key: "outerDimensions" Description: Whether the width/height is expressed as the size of the outer window, rather than the content area Values: true, false Default: false
Key: "useNVPerfHUD" [DX9 specific] Description: Enable the use of nVidia NVPerfHUD Values: true, false Default: false
Key: "gamma" Description: Enable hardware conversion from linear colour space to gamma colour space on rendering to the window. Values: true, false Default: false
void Ogre::Root::detachRenderTarget | ( | RenderTarget * | pWin | ) |
Destroys a rendering window.
void Ogre::Root::detachRenderTarget | ( | const String & | name | ) |
Destroys a named rendering window.
RenderTarget* Ogre::Root::getRenderTarget | ( | const String & | name | ) |
Retrieves a pointer to the a named render window.
void Ogre::Root::loadPlugin | ( | const String & | pluginName | ) |
Manually load a Plugin contained in a DLL / DSO.
pluginName | Name of the plugin library to load |
void Ogre::Root::unloadPlugin | ( | const String & | pluginName | ) |
Manually unloads a Plugin contained in a DLL / DSO.
pluginName | Name of the plugin library to unload |
void Ogre::Root::installPlugin | ( | Plugin * | plugin | ) |
Install a new plugin.
void Ogre::Root::uninstallPlugin | ( | Plugin * | plugin | ) |
Uninstall an existing plugin.
const PluginInstanceList& Ogre::Root::getInstalledPlugins | ( | ) | const |
Gets a read-only list of the currently installed plugins.
Definition at line 629 of file OgreRoot.h.
Timer* Ogre::Root::getTimer | ( | void | ) |
Gets a pointer to the central timer used for all OGRE timings.
bool Ogre::Root::_fireFrameStarted | ( | FrameEvent & | evt | ) |
Method for raising frame started events.
evt | Event object which includes all the timing information which you have calculated for yourself |
bool Ogre::Root::_fireFrameRenderingQueued | ( | FrameEvent & | evt | ) |
Method for raising frame rendering queued events.
bool Ogre::Root::_fireFrameEnded | ( | FrameEvent & | evt | ) |
Method for raising frame ended events.
evt | Event object which includes all the timing information which you have calculated for yourself |
bool Ogre::Root::_fireFrameStarted | ( | ) |
Method for raising frame started events.
bool Ogre::Root::_fireFrameRenderingQueued | ( | ) |
Method for raising frame rendering queued events.
bool Ogre::Root::_fireFrameEnded | ( | ) |
Method for raising frame ended events.
unsigned long Ogre::Root::getNextFrameNumber | ( | void | ) | const |
Gets the number of the next frame to be rendered.
Definition at line 735 of file OgreRoot.h.
SceneManager* Ogre::Root::_getCurrentSceneManager | ( | void | ) | const |
Returns the scene manager currently being used to render a frame.
Definition at line 742 of file OgreRoot.h.
void Ogre::Root::_setCurrentSceneManager | ( | SceneManager * | sm | ) |
Sets the scene manager currently being used to render a frame.
bool Ogre::Root::_updateAllRenderTargets | ( | void | ) |
Internal method used for updating all RenderTarget objects (windows, renderable textures etc) which are set to auto-update.
RenderQueueInvocationSequence* Ogre::Root::createRenderQueueInvocationSequence | ( | const String & | name | ) |
Create a new RenderQueueInvocationSequence, useful for linking to Viewport instances to perform custom rendering.
name | The name to give the new sequence |
RenderQueueInvocationSequence* Ogre::Root::getRenderQueueInvocationSequence | ( | const String & | name | ) |
void Ogre::Root::destroyRenderQueueInvocationSequence | ( | const String & | name | ) |
Destroy a RenderQueueInvocationSequence.
name | The name to identify the sequence |
void Ogre::Root::destroyAllRenderQueueInvocationSequences | ( | void | ) |
Destroy all RenderQueueInvocationSequences.
name | The name to identify the sequence |
static Root& Ogre::Root::getSingleton | ( | void | ) | [static] |
Override standard Singleton retrieval.
Reimplemented from Ogre::Singleton< T >.
static Root* Ogre::Root::getSingletonPtr | ( | void | ) | [static] |
Override standard Singleton retrieval.
Reimplemented from Ogre::Singleton< T >.
void Ogre::Root::clearEventTimes | ( | void | ) |
Clears the history of all event times.
void Ogre::Root::setFrameSmoothingPeriod | ( | Real | period | ) |
Sets the period over which OGRE smooths out fluctuations in frame times.
Definition at line 844 of file OgreRoot.h.
Real Ogre::Root::getFrameSmoothingPeriod | ( | void | ) | const |
Gets the period over which OGRE smooths out fluctuations in frame times.
Definition at line 846 of file OgreRoot.h.
void Ogre::Root::addMovableObjectFactory | ( | MovableObjectFactory * | fact, | |
bool | overrideExisting = false | |||
) |
Register a new MovableObjectFactory which will create new MovableObject instances of a particular type, as identified by the getType() method.
fact | Pointer to the factory instance | |
overrideExisting | Set this to true to override any existing factories which are registered for the same type. You should only change this if you are very sure you know what you're doing. |
void Ogre::Root::removeMovableObjectFactory | ( | MovableObjectFactory * | fact | ) |
Removes a previously registered MovableObjectFactory.
bool Ogre::Root::hasMovableObjectFactory | ( | const String & | typeName | ) | const |
Checks whether a factory is registered for a given MovableObject type.
MovableObjectFactory* Ogre::Root::getMovableObjectFactory | ( | const String & | typeName | ) |
Get a MovableObjectFactory for the given type.
uint32 Ogre::Root::_allocateNextMovableObjectTypeFlag | ( | void | ) |
Allocate the next MovableObject type flag.
MovableObjectFactoryIterator Ogre::Root::getMovableObjectFactoryIterator | ( | void | ) | const |
Return an iterator over all the MovableObjectFactory instances currently registered.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, | |
const char * | file, | |||
int | line, | |||
const char * | func | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | [inherited] |
Definition at line 67 of file OgreMemoryAllocatedObject.h.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, | |
void * | ptr | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz, | |
const char * | file, | |||
int | line, | |||
const char * | func | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | [inherited] |
Definition at line 84 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | [inherited] |
Definition at line 89 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, | |
void * | ||||
) | [inherited] |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, | |
const char * | , | |||
int | , | |||
const char * | ||||
) | [inherited] |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | [inherited] |
Definition at line 106 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr, | |
const char * | , | |||
int | , | |||
const char * | ||||
) | [inherited] |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
friend class RenderSystem [friend] |
Definition at line 63 of file OgreRoot.h.
RenderSystemList Ogre::Root::mRenderers [private] |
Definition at line 65 of file OgreRoot.h.
RenderSystem* Ogre::Root::mActiveRenderer [private] |
Definition at line 66 of file OgreRoot.h.
String Ogre::Root::mVersion [private] |
Definition at line 67 of file OgreRoot.h.
String Ogre::Root::mConfigFileName [private] |
Definition at line 68 of file OgreRoot.h.
bool Ogre::Root::mQueuedEnd [private] |
Definition at line 69 of file OgreRoot.h.
bool Ogre::Root::mFirstTimePostWindowInit [private] |
Definition at line 71 of file OgreRoot.h.
LogManager* Ogre::Root::mLogManager [private] |
Definition at line 74 of file OgreRoot.h.
ControllerManager* Ogre::Root::mControllerManager [private] |
Definition at line 75 of file OgreRoot.h.
Definition at line 76 of file OgreRoot.h.
SceneManager* Ogre::Root::mCurrentSceneManager [private] |
Definition at line 77 of file OgreRoot.h.
DynLibManager* Ogre::Root::mDynLibManager [private] |
Definition at line 78 of file OgreRoot.h.
ArchiveManager* Ogre::Root::mArchiveManager [private] |
Definition at line 79 of file OgreRoot.h.
MaterialManager* Ogre::Root::mMaterialManager [private] |
Definition at line 80 of file OgreRoot.h.
MeshManager* Ogre::Root::mMeshManager [private] |
Definition at line 81 of file OgreRoot.h.
Definition at line 82 of file OgreRoot.h.
SkeletonManager* Ogre::Root::mSkeletonManager [private] |
Definition at line 83 of file OgreRoot.h.
OverlayElementFactory* Ogre::Root::mPanelFactory [private] |
Definition at line 84 of file OgreRoot.h.
Definition at line 85 of file OgreRoot.h.
Definition at line 86 of file OgreRoot.h.
OverlayManager* Ogre::Root::mOverlayManager [private] |
Definition at line 87 of file OgreRoot.h.
FontManager* Ogre::Root::mFontManager [private] |
Definition at line 88 of file OgreRoot.h.
ArchiveFactory* Ogre::Root::mZipArchiveFactory [private] |
Definition at line 89 of file OgreRoot.h.
Definition at line 90 of file OgreRoot.h.
Definition at line 91 of file OgreRoot.h.
Definition at line 92 of file OgreRoot.h.
Definition at line 93 of file OgreRoot.h.
Definition at line 94 of file OgreRoot.h.
Definition at line 95 of file OgreRoot.h.
Timer* Ogre::Root::mTimer [private] |
Definition at line 97 of file OgreRoot.h.
RenderWindow* Ogre::Root::mAutoWindow [private] |
Definition at line 98 of file OgreRoot.h.
Profiler* Ogre::Root::mProfiler [private] |
Definition at line 99 of file OgreRoot.h.
Definition at line 100 of file OgreRoot.h.
Definition at line 101 of file OgreRoot.h.
CompositorManager* Ogre::Root::mCompositorManager [private] |
Definition at line 102 of file OgreRoot.h.
unsigned long Ogre::Root::mNextFrame [private] |
Definition at line 103 of file OgreRoot.h.
Real Ogre::Root::mFrameSmoothingTime [private] |
Definition at line 104 of file OgreRoot.h.
PluginLibList Ogre::Root::mPluginLibs [protected] |
PluginInstanceList Ogre::Root::mPlugins [protected] |
Definition at line 116 of file OgreRoot.h.
uint32 Ogre::Root::mNextMovableObjectTypeFlag [protected] |
Definition at line 117 of file OgreRoot.h.
MovableObjectFactory* Ogre::Root::mEntityFactory [protected] |
Definition at line 119 of file OgreRoot.h.
MovableObjectFactory* Ogre::Root::mLightFactory [protected] |
Definition at line 120 of file OgreRoot.h.
MovableObjectFactory* Ogre::Root::mBillboardSetFactory [protected] |
Definition at line 121 of file OgreRoot.h.
MovableObjectFactory* Ogre::Root::mManualObjectFactory [protected] |
Definition at line 122 of file OgreRoot.h.
MovableObjectFactory* Ogre::Root::mBillboardChainFactory [protected] |
Definition at line 123 of file OgreRoot.h.
MovableObjectFactory* Ogre::Root::mRibbonTrailFactory [protected] |
Definition at line 124 of file OgreRoot.h.
Definition at line 127 of file OgreRoot.h.
bool Ogre::Root::mIsInitialised [protected] |
std::set<FrameListener*> Ogre::Root::mFrameListeners [protected] |
std::set<FrameListener*> Ogre::Root::mRemovedFrameListeners [protected] |
std::deque<unsigned long> Ogre::Root::mEventTimes[FETT_COUNT] [protected] |
T* Ogre::Singleton< T >::ms_Singleton [static, protected, inherited] |
Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Sep 27 22:06:04 2009