Go to the documentation of this file.
41 #if OGRE_PLATFORM == OGRE_PLATFORM_ANDROID
102 #if OGRE_PLATFORM == OGRE_PLATFORM_ANDROID
225 const String& configFileName =
"ogre.cfg",
226 const String& logFileName =
"Ogre.log");
602 bool recursive =
false);
1005 bool overrideExisting =
false);
bool createRenderWindows(const RenderWindowDescriptionList &renderWindowDescriptions, RenderWindowList &createdWindows)
Creates multiple rendering windows.
Class for loading & managing textures.
Injects the output of a request to the mesh in a thread safe way.
bool restoreConfig(void)
Checks for saved video/sound/etc settings.
A interface class defining a listener which can be used to receive notifications of frame events.
ExternalTextureSourceManager * mExternalTextureSourceManager
deque< unsigned long >::type EventTimesQueue
Contains the times of recently fired events.
void useCustomRenderSystemCapabilities(RenderSystemCapabilities *capabilities)
Requests active RenderSystem to use custom RenderSystemCapabilities.
bool _fireFrameEnded(FrameEvent &evt)
Method for raising frame ended events.
const SceneManagerMetaData * getSceneManagerMetaData(const String &typeName) const
Get more information about a given type of SceneManager.
bool _fireFrameStarted(FrameEvent &evt)
Method for raising frame started events.
SceneManagerEnumerator::MetaDataIterator getSceneManagerMetaDataIterator(void) const
Iterate over all types of SceneManager available for construction, providing some information about e...
static Root * getSingletonPtr(void)
Override standard Singleton retrieval.
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.
bool getRemoveRenderQueueStructuresOnClear() const
Get whether the entire render queue structure should be emptied on clearing, or whether just the obje...
Defines the functionality of a 3D API.
ShadowTextureManager * mShadowTextureManager
Interface to a general purpose request / response style background work queue.
ResourceBackgroundQueue * mResourceBackgroundQueue
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
ArchiveManager * mArchiveManager
void oneTimePostWindowInit(void)
Internal method for one-time tasks after first window creation.
void installPlugin(Plugin *plugin)
Install a new plugin.
PluginLibList mPluginLibs
List of plugin DLLs loaded.
RenderSystem * mActiveRenderer
ScriptCompilerManager * mCompilerManager
CompositorManager * mCompositorManager
bool hasMovableObjectFactory(const String &typeName) const
Checks whether a factory is registered for a given MovableObject type.
RenderQueueInvocationSequence * getRenderQueueInvocationSequence(const String &name)
Get a RenderQueueInvocationSequence.
void destroyRenderTarget(const String &name)
Destroys the given named RenderTarget.
set< FrameListener * >::type mAddedFrameListeners
void setFrameSmoothingPeriod(Real period)
Sets the period over which OGRE smooths out fluctuations in frame times.
void addRenderSystem(RenderSystem *newRend)
Adds a new rendering subsystem to the list of available renderers.
Handles the management of skeleton resources.
void addSceneManagerFactory(SceneManagerFactory *fact)
Register a new SceneManagerFactory, a factory object for creating instances of specific SceneManagers...
This class is used to perform Resource operations in a background thread.
String getErrorDescription(long errorNumber)
Utility function for getting a better description of an error code.
MovableObjectFactory * getMovableObjectFactory(const String &typeName)
Get a MovableObjectFactory for the given type.
set< FrameListener * >::type mFrameListeners
Set of registered frame listeners.
void setDefaultMinPixelSize(Real pixelSize)
Set the default minimum pixel size for object to be rendered by.
void setWorkQueue(WorkQueue *queue)
Replace the current work queue with an alternative.
void populateFrameEvent(FrameEventTimeType type, FrameEvent &evtToUpdate)
Update a set of event times (note, progressive, only call once for each type per frame)
Manages the target rendering window.
MeshManager * getMeshManager(void)
Retrieves a reference to the current MeshManager.
Class for managing Controller instances.
vector< RenderWindowDescription >::type RenderWindowDescriptionList
Render window creation parameters container.
const PluginInstanceList & getInstalledPlugins() const
Gets a read-only list of the currently installed plugins.
MovableObjectFactoryMap mMovableObjectFactoryMap
bool hasSceneManager(const String &instanceName) const
Determines if a given SceneManager already exists.
The root class of the Ogre system.
MaterialManager * mMaterialManager
uint32 _allocateNextMovableObjectTypeFlag(void)
Allocate the next MovableObject type flag.
void addMovableObjectFactory(MovableObjectFactory *fact, bool overrideExisting=false)
Register a new MovableObjectFactory which will create new MovableObject instances of a particular typ...
Class for managing Material settings for Ogre.
bool _fireFrameEnded()
Method for raising frame ended events.
void uninstallPlugin(Plugin *plugin)
Uninstall an existing plugin.
bool mIsBlendWeightsGpuRedundant
Tells whether blend weights information needs to be passed to the GPU.
deque< SceneManager * >::type SceneManagerStack
RenderTarget * detachRenderTarget(const String &name)
Detaches a named RenderTarget from the active render system and returns a pointer to it.
SceneManagerEnumerator::SceneManagerIterator getSceneManagerIterator(void)
Get an iterator over all the existing SceneManager instances.
void addFrameListener(FrameListener *newListener)
Registers a FrameListener which will be called back every frame.
void destroySceneManager(SceneManager *sm)
Destroy an instance of a SceneManager.
bool mFirstTimePostWindowInit
In case multiple render windows are created, only once are the resources loaded.
RenderQueueInvocationSequence * createRenderQueueInvocationSequence(const String &name)
Create a new RenderQueueInvocationSequence, useful for linking to Viewport instances to perform custo...
uint32 mNextMovableObjectTypeFlag
Class for managing Compositor settings for Ogre.
RenderWindow * initialise(bool autoCreateWindow, const String &windowTitle="OGRE Render Window", const String &customCapabilitiesConfig=StringUtil::BLANK)
Initialises the renderer.
LodStrategyManager * mLodStrategyManager
Interface definition for a factory class which produces a certain kind of MovableObject,...
bool showConfigDialog(void)
Displays a dialog asking the user to choose system settings.
uint16 SceneTypeMask
Bitmask containing scene types.
SceneManager * createSceneManager(SceneTypeMask typeMask, const String &instanceName=StringUtil::BLANK)
Create a SceneManager instance based on scene type support.
Abstract factory class, archive codec plugins can register concrete subclasses of this.
RenderWindow * createRenderWindow(const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)
Creates a new rendering window.
MovableObjectFactory * mLightFactory
RenderSystemList mRenderers
bool _fireFrameRenderingQueued(FrameEvent &evt)
Method for raising frame rendering queued events.
void destroyAllRenderQueueInvocationSequences(void)
Destroy all RenderQueueInvocationSequences.
Class which will create instances of a given SceneManager.
map< String, String >::type NameValuePairList
Name / value parameter pair (first = name, second = value)
Class defining a generic OGRE plugin.
unsigned int getDisplayMonitorCount() const
Gets the number of display monitors.
bool endRenderingQueued(void)
Check for planned end of rendering.
void removeSceneManagerFactory(SceneManagerFactory *fact)
Unregister a SceneManagerFactory.
void setBlendWeightsGpuRedundant(bool redundant)
Sets whether blend weights information needs to be passed to the GPU.
Real getDefaultMinPixelSize()
Get the default minimum pixel size for object to be rendered by.
Class to manage the available shadow textures which may be shared between many SceneManager instances...
bool _fireFrameRenderingQueued()
Method for raising frame rendering queued events.
static const String BLANK
Constant blank string, useful for returning by ref where local does not exist.
void destroyRenderTarget(RenderTarget *target)
Destroys the given RenderTarget.
void setBlendIndicesGpuRedundant(bool redundant)
Sets whether blend indices information needs to be passed to the GPU.
A 'canvas' which can receive the results of a rendering operation.
void unloadPlugin(const String &pluginName)
Manually unloads a Plugin contained in a DLL / DSO.
Manages the organisation and rendering of a 'scene' i.e.
MovableObjectFactory * mBillboardSetFactory
Class to hold a linear sequence of RenderQueueInvocation objects.
vector< DynLib * >::type PluginLibList
void setRemoveRenderQueueStructuresOnClear(bool r)
Set whether the entire render queue structure should be emptied on clearing, or whether just the obje...
Real getFrameSmoothingPeriod(void) const
Gets the period over which OGRE smooths out fluctuations in frame times.
vector< RenderWindow * >::type RenderWindowList
Render window container.
map< String, RenderQueueInvocationSequence * >::type RenderQueueInvocationSequenceMap
RenderTarget * detachRenderTarget(RenderTarget *pWin)
Detaches a RenderTarget from the active render system and returns a pointer to it.
RenderTarget * getRenderTarget(const String &name)
Retrieves a pointer to a named render target.
bool _updateAllRenderTargets(FrameEvent &evt)
Internal method used for updating all RenderTarget objects (windows, renderable textures etc) which a...
Template class for creating single-instance global classes.
static String DEFAULT_RESOURCE_GROUP_NAME
Default resource group name.
bool _fireFrameStarted()
Method for raising frame started events.
set< FrameListener * >::type mRemovedFrameListeners
Set of frame listeners marked for removal and addition.
Real calculateEventTime(unsigned long now, FrameEventTimeType type)
Internal method for calculating the average time between recently fired events.
MeshManager * mMeshManager
RenderQueueInvocationSequenceMap mRQSequenceMap
Manages threaded compilation of scripts.
MovableObjectFactory * mManualObjectFactory
void queueEndRendering(bool state=true)
Queues the end of rendering.
SceneManager * _getCurrentSceneManager(void) const
Returns the scene manager currently being used to render a frame.
RenderWindow * mAutoWindow
singleton class for storing the capabilities of the graphics card.
SceneManager * createSceneManager(const String &typeName, const String &instanceName=StringUtil::BLANK)
Create a SceneManager instance of a given type.
void setRenderSystem(RenderSystem *system)
Sets the rendering subsystem to be used.
SceneManagerStack mSceneManagerStack
Root(const String &pluginFileName="plugins" OGRE_BUILD_SUFFIX ".cfg", const String &configFileName="ogre.cfg", const String &logFileName="Ogre.log")
Constructor.
ParticleSystemManager * mParticleManager
void loadPlugins(const String &pluginsfile="plugins" OGRE_BUILD_SUFFIX ".cfg")
Method reads a plugins configuration file and instantiates all plugins.
bool _updateAllRenderTargets(void)
Internal method used for updating all RenderTarget objects (windows, renderable textures etc) which a...
void _syncAddedRemovedFrameListeners()
RenderSystemCapabilitiesManager * mRenderSystemCapabilitiesManager
MovableObjectFactory * mRibbonTrailFactory
HighLevelGpuProgramManager * mHighLevelGpuProgramManager
static Root & getSingleton(void)
Override standard Singleton retrieval.
void convertColourValue(const ColourValue &colour, uint32 *pDest)
Generates a packed data version of the passed in ColourValue suitable for use with the current Render...
ResourceGroupManager * mResourceGroupManager
Struct containing information about a frame event.
void shutdownPlugins()
Shuts down all loaded plugins - allows things to be tidied up whilst all plugins are still loaded.
SceneManagerEnumerator * mSceneManagerEnum
SkeletonManager * mSkeletonManager
ArchiveFactory * mEmbeddedZipArchiveFactory
Concrete IteratorWrapper for nonconst access to the underlying key-value container.
DynLibManager * mDynLibManager
void destroyRenderQueueInvocationSequence(const String &name)
Destroy a RenderQueueInvocationSequence.
void loadPlugin(const String &pluginName)
Manually load a Plugin contained in a DLL / DSO.
DataStreamPtr openFileStream(const String &filename, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME, const String &locationPattern=StringUtil::BLANK)
Helper method to assist you in accessing readable file streams.
The profiler allows you to measure the performance of your code.
Class representing colour.
bool isBlendIndicesGpuRedundant() const
Returns whether blend indices information needs to be passed to the GPU see setBlendIndicesGpuRedunda...
ArchiveFactory * mFileSystemArchiveFactory
MovableObjectFactory * mBillboardChainFactory
vector< Plugin * >::type PluginInstanceList
bool isInitialised(void) const
Returns whether the system is initialised or not.
void shutdown(void)
Shuts down the system manually.
void _pushCurrentSceneManager(SceneManager *sm)
Pushes the scene manager currently being used to render.
bool mRemoveQueueStructuresOnClear
void saveConfig(void)
Saves the details of the current configuration.
const RenderSystemList & getAvailableRenderers(void)
Retrieve a list of the available render systems.
Real mDefaultMinPixelSize
Handles the management of mesh resources.
bool isBlendWeightsGpuRedundant() const
Returns whether blend weights information needs to be passed to the GPU see setBlendWeightsGpuRedunda...
void startRendering(void)
Starts / restarts the automatic rendering cycle.
MovableObjectFactoryIterator getMovableObjectFactoryIterator(void) const
Return an iterator over all the MovableObjectFactory instances currently registered.
RenderWindow * getAutoCreatedWindow(void)
Retrieves a pointer to the window that was created automatically.
Class for managing RenderSystemCapabilities database for Ogre.
float Real
Software floating point type.
Manages particle systems, particle system scripts (templates) and the available emitter & affector fa...
map< String, MovableObjectFactory * >::type MovableObjectFactoryMap
Concrete IteratorWrapper for const access to the underlying key-value container.
void _popCurrentSceneManager(SceneManager *sm)
Pops the scene manager currently being used to render.
WorkQueue * getWorkQueue() const
Get the WorkQueue for processing background tasks.
void unloadPlugins()
Unloads all loaded plugins.
ArchiveFactory * mZipArchiveFactory
Manager for Dynamic-loading Libraries.
DataStreamPtr createFileStream(const String &filename, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME, bool overwrite=false, const String &locationPattern=StringUtil::BLANK)
Helper method to assist you in creating writeable file streams.
Enumerates the SceneManager classes available to applications.
This class manages the available ArchiveFactory plugins.
vector< RenderSystem * >::type RenderSystemList
unsigned long getNextFrameNumber(void) const
Gets the number of the next frame to be rendered.
bool renderOneFrame(void)
Render one frame.
ControllerManager * mControllerManager
TextureManager * getTextureManager(void)
Retrieves a reference to the current TextureManager.
The log manager handles the creation and retrieval of logs for the application.
bool renderOneFrame(Real timeSinceLastFrame)
Render one frame, with custom frame time information.
bool mIsBlendIndicesGpuRedundant
Tells whether blend indices information needs to be passed to the GPU.
SceneManager * getSceneManager(const String &instanceName) const
Get an existing SceneManager instance that has already been created, identified by the instance name.
RenderSystem * getRenderSystemByName(const String &name)
Retrieve a pointer to the render system by the given name.
PluginInstanceList mPlugins
List of Plugin instances registered.
void removeFrameListener(FrameListener *oldListener)
Removes a FrameListener from the list of listening classes.
ConstMapIterator< MovableObjectFactoryMap > MovableObjectFactoryIterator
RenderSystem * getRenderSystem(void)
Retrieve a pointer to the currently selected render system.
FrameEventTimeType
Indicates the type of event to be considered by calculateEventTime().
void initialisePlugins()
Initialise all loaded plugins - allows plugins to perform actions once the renderer is initialised.
This ResourceManager manages high-level vertex and fragment programs.
bool mIsInitialised
Are we initialised yet?
Timer * getTimer(void)
Gets a pointer to the central timer used for all OGRE timings.
This singleton class manages the list of resource groups, and notifying the various resource managers...
Concrete IteratorWrapper for const access to the underlying container.
MovableObjectFactory * mEntityFactory
Singleton Class which handles the registering and control of texture plugins.
void removeMovableObjectFactory(MovableObjectFactory *fact)
Removes a previously registered MovableObjectFactory.
Manager for LOD strategies.
void clearEventTimes(void)
Clears the history of all event times.
Copyright © 2012 Torus Knot Software Ltd

This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.