Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

Emma::RenderManager Class Reference

RenderManager implements IRenderManager. More...

#include <EmmaRenderManager.h>

Inheritance diagram for Emma::RenderManager:

Fusion::Object Emma::IRenderManager Emma::Extension Emma::EventHandler Fusion::IObject List of all members.

Public Member Functions

 RenderManager ()
 DECLARE_CLASS (RenderManager, Object)
virtual Fusion::ResultType initialize ()
 Initialize this instance.
virtual Fusion::ResultType finalize ()
 Finalize this instance before it is destroyed.
virtual IScenecreateRootScene (IInstance *, IWindow *)
 This creates the root scene given an IInstance and an IWindow in which to render.
virtual Fusion::ResultType processEvent (IInstance *, const Event &)
 this is used to pass system events to the render manager
virtual Fusion::ResultType setProperty (const Fusion::Id &, const Fusion::Value &)
 this sets a global property on the render manager
virtual Fusion::ResultType render (IInstance *)
 This method calls renderOneFrame in Ogre.
virtual IRenderableGroupgetRootRenderableGroup ()
 each scene has a root renderablegroup that corresponds to a scene node all other scene nodes are inserted under this node
virtual IRenderablecreateRenderable (IInstance *, Fusion::IObject *, RenderableType, IRenderable *b=NULL)
 This creates a renderable object for each Emma object that needs to be rendered in Ogre.
virtual IScenecreateRenderToTexture (IInstance *, Fusion::IObject *, IRenderableGroup *, Fusion::UTF8String &)
 This creates a new render target which is a render to texture return value is the index of the ogre instance scene surface object note that each render manager can have multiple ogre instance scene surface objects.
virtual void setResourceGroupActive ()
 set the current resource group name to the resource group of this render manager
virtual Fusion::UTF8String getResourceGroupName ()
 each render manager creates its own resource group name
virtual void saveScreenshotToFile (Fusion::UTF8String name)
 saves a screenshot of the current scene to a file
virtual void setLatestResourcePath (const Fusion::UTF8String &s)
 register a string value to remember later
virtual const Fusion::UTF8StringgetLatestResourcePath ()
 get the latest registered string value
virtual void * getMeshInfo (Fusion::UTF8String)
 load the passed mesh file and return the pointer to the mesh structure
virtual bool handleEvent (const Event &event)
 Callback function that is implemented by the callee.
OgreApplicationgetOgreApp ()
OgreInstancegetOgreInstance ()
virtual void lock ()
 makes sure only one-thread is using the render manager at any given instant
virtual void unlock ()
 releases the lock.
void setPickable (bool v)
virtual RendererType getRendererType () const
 Return the RendererType.

Protected Member Functions

virtual ~RenderManager ()

Detailed Description

RenderManager implements IRenderManager.


Constructor & Destructor Documentation

virtual Emma::RenderManager::~RenderManager  )  [protected, virtual]
 

Emma::RenderManager::RenderManager  ) 
 


Member Function Documentation

virtual IRenderable* Emma::RenderManager::createRenderable IInstance ,
Fusion::IObject ,
RenderableType  ,
IRenderable b = NULL
[virtual]
 

This creates a renderable object for each Emma object that needs to be rendered in Ogre.

This method asks the IObject interface about the properties of the Emma object and creates a corresponding Emma Renderable object. If this object directly correponds to an Ogre mesh, it loads the mesh.

Implements Emma::IRenderManager.

virtual IScene* Emma::RenderManager::createRenderToTexture IInstance ,
Fusion::IObject ,
IRenderableGroup ,
Fusion::UTF8String
[virtual]
 

This creates a new render target which is a render to texture return value is the index of the ogre instance scene surface object note that each render manager can have multiple ogre instance scene surface objects.

Implements Emma::IRenderManager.

virtual IScene* Emma::RenderManager::createRootScene IInstance ,
IWindow
[virtual]
 

This creates the root scene given an IInstance and an IWindow in which to render.

Returns new IScene or NULL on failure.

Implements Emma::IRenderManager.

Emma::RenderManager::DECLARE_CLASS RenderManager  ,
Object 
 

virtual Fusion::ResultType Emma::RenderManager::finalize  )  [virtual]
 

Finalize this instance before it is destroyed.

Reimplemented from Fusion::Object.

virtual const Fusion::UTF8String& Emma::RenderManager::getLatestResourcePath  )  [inline, virtual]
 

get the latest registered string value

Implements Emma::IRenderManager.

virtual void* Emma::RenderManager::getMeshInfo Fusion::UTF8String   )  [virtual]
 

load the passed mesh file and return the pointer to the mesh structure

Implements Emma::IRenderManager.

OgreApplication* Emma::RenderManager::getOgreApp  )  [inline]
 

OgreInstance* Emma::RenderManager::getOgreInstance  ) 
 

virtual RendererType Emma::RenderManager::getRendererType  )  const [virtual]
 

Return the RendererType.

Implements Emma::IRenderManager.

virtual Fusion::UTF8String Emma::RenderManager::getResourceGroupName  )  [virtual]
 

each render manager creates its own resource group name

Implements Emma::IRenderManager.

virtual IRenderableGroup* Emma::RenderManager::getRootRenderableGroup  )  [virtual]
 

each scene has a root renderablegroup that corresponds to a scene node all other scene nodes are inserted under this node

Implements Emma::IRenderManager.

virtual bool Emma::RenderManager::handleEvent const Event event  )  [virtual]
 

Callback function that is implemented by the callee.

Parameters:
event specifies the time of the event. Event time will be the same for events occurring in the same render phase For example, PREUPDATE, POSTUPDATE, PRERENDER and POSTRENDER event callbacks will all pass the same event time for the same frame. Returning stop Emma from calling the rest of the handlers for this event If you return true, Emma will keep on calling rest of the handlers for this event

Implements Emma::EventHandler.

virtual Fusion::ResultType Emma::RenderManager::initialize  )  [virtual]
 

Initialize this instance.

Reimplemented from Fusion::Object.

virtual void Emma::RenderManager::lock  )  [virtual]
 

makes sure only one-thread is using the render manager at any given instant

Implements Emma::IRenderManager.

virtual Fusion::ResultType Emma::RenderManager::processEvent IInstance ,
const Event
[virtual]
 

this is used to pass system events to the render manager

Implements Emma::IRenderManager.

virtual Fusion::ResultType Emma::RenderManager::render IInstance  )  [virtual]
 

This method calls renderOneFrame in Ogre.

Implements Emma::IRenderManager.

virtual void Emma::RenderManager::saveScreenshotToFile Fusion::UTF8String  name  )  [virtual]
 

saves a screenshot of the current scene to a file

Implements Emma::IRenderManager.

virtual void Emma::RenderManager::setLatestResourcePath const Fusion::UTF8String s  )  [inline, virtual]
 

register a string value to remember later

Implements Emma::IRenderManager.

void Emma::RenderManager::setPickable bool  v  )  [inline]
 

virtual Fusion::ResultType Emma::RenderManager::setProperty const Fusion::Id ,
const Fusion::Value
[virtual]
 

this sets a global property on the render manager

Implements Emma::IRenderManager.

virtual void Emma::RenderManager::setResourceGroupActive  )  [virtual]
 

set the current resource group name to the resource group of this render manager

Implements Emma::IRenderManager.

virtual void Emma::RenderManager::unlock  )  [virtual]
 

releases the lock.

when

Implements Emma::IRenderManager.


The documentation for this class was generated from the following file:
Generated on Sat Apr 1 06:08:31 2006 for Emma SDK Guide by  doxygen 1.4.3