#include <OgreRenderEngine.hh>

Public Types
enum	OgreRenderPathType { NONE = 0, VERTEX = 1, FORWARD = 2, DEFERRED = 3, RENDER_PATH_COUNT }

Public Member Functions
virtual	~OgreRenderEngine ()

void	AddResourcePath (const std::string &_uri)
	Documentation Inherited. More...

std::string	CreateWindow (const std::string &_handle, const unsigned int _width, const unsigned int _height, const double _ratio, const unsigned int antiAliasing)

virtual bool	Fini ()

virtual bool	IsEnabled () const
	Determines if the render-engine can be used. Despite loading and initializing the render-engine, it may not be possible to use due to hardware capabilities of the runtime system. More...

virtual std::string	Name () const
	Get name of the render-engine. More...

virtual Ogre::Root *	OgreRoot () const

OgreRenderPathType	RenderPathType () const

Public Member Functions inherited from BaseRenderEngine
virtual	~BaseRenderEngine ()

virtual ScenePtr	CreateScene (const std::string &_name)
	Create a new scene with the given name. The given name should be unique across all scenes managed by this render-engine. If a duplicate name is given, NULL will be returned. An unique ID will automatically be assigned to the created scene. More...

virtual ScenePtr	CreateScene (unsigned int _id, const std::string &_name)
	Create a new scene with the given ID. The given ID should be unique across all scenes managed by this render-engine. If a duplicate ID is given, NULL will be returned. An unique name will automatically be assigned to the created scene. More...

virtual void	Destroy ()
	Destroys all scenes created by render-engine and releases all loaded resources. This should be called when the given render-engine will no longer be used during runtime. More...

virtual void	DestroyScene (ScenePtr _scene)
	Destroy the given scene. If the given scene is not managed by this render-engine, no work will be done. More...

virtual void	DestroySceneById (unsigned int _id)
	Destroy the scene with the given ID. If no scenes exist with the given ID, no work will be done. More...

virtual void	DestroySceneByIndex (unsigned int _index)
	Destroy the scene at the given index. If no scenes exist at the given index, no work will be done. More...

virtual void	DestroySceneByName (const std::string &_name)
	Destroy the scene with the given name. If no scenes exist with the given name, no work will be done. More...

virtual void	DestroyScenes ()
	Destroy all scenes managed by this render-engine. More...

virtual bool	HasScene (ConstScenePtr _scene) const
	Determine if the given scene is actively managed by this render-engine. More...

virtual bool	HasSceneId (unsigned int _id) const
	Determine if this render-engine manages a scene with the given ID. More...

virtual bool	HasSceneName (const std::string &_name) const
	Determine if this render-engine manages a scene with the given name. More...

virtual bool	Init ()
	Initialize the render-engine. This should be called immediately after a successful call to Load. More...

virtual bool	IsInitialized () const
	Determines if the render-engine has been initialized. More...

virtual bool	IsLoaded () const
	Determines if the render-engine has been loaded. More...

virtual bool	Load ()
	Load any necessary resources to set up render-engine. This should called before any other function. More...

virtual ScenePtr	SceneById (unsigned int _id) const
	Get the scene with the given ID. If no scenes exist with the given ID, NULL will be returned. More...

virtual ScenePtr	SceneByIndex (unsigned int _index) const
	Get the scene at the given index. If no scenes exist at the given index, NULL will be returned. More...

virtual ScenePtr	SceneByName (const std::string &_name) const
	Get the scene with the given name. If no scenes exist with the given name, NULL will be returned. More...

virtual unsigned int	SceneCount () const
	Get the number of scenes actively managed by this render-engine. More...

Public Member Functions inherited from RenderEngine
virtual	~RenderEngine ()
	Deconstructor. More...

Protected Member Functions
virtual ScenePtr	CreateSceneImpl (unsigned int _id, const std::string &_name)

virtual bool	InitImpl ()

virtual bool	LoadImpl ()

virtual SceneStorePtr	Scenes () const

Protected Member Functions inherited from BaseRenderEngine
	BaseRenderEngine ()

virtual unsigned int	NextSceneId ()

virtual void	PrepareScene (ScenePtr _scene)

Additional Inherited Members
Protected Attributes inherited from BaseRenderEngine
bool	initialized

bool	loaded

unsigned int	nextSceneId

std::vector< std::string >	resourcePaths
	a list of paths that render engines use to locate their resources More...

Member Enumeration Documentation

◆ OgreRenderPathType

enum OgreRenderPathType

Enumerator
NONE	No rendering is done.
VERTEX	Most basic rendering, with least fidelity.
FORWARD	Utilizes the RTT shader system.
DEFERRED	Utilizes deferred rendering. Best fidelity.
RENDER_PATH_COUNT	Count of the rendering path enums.

Constructor & Destructor Documentation

◆ ~OgreRenderEngine()

virtual ~OgreRenderEngine ( )

virtual

Member Function Documentation

◆ AddResourcePath()

void AddResourcePath ( const std::string & _path )

virtual

Documentation Inherited.

Reimplemented from BaseRenderEngine.

◆ CreateSceneImpl()

virtual ScenePtr CreateSceneImpl	(	unsigned int	_id,
		const std::string &	_name
	)

protectedvirtual

Implements BaseRenderEngine.

◆ CreateWindow()

std::string CreateWindow	(	const std::string &	_handle,
		const unsigned int	_width,
		const unsigned int	_height,
		const double	_ratio,
		const unsigned int	antiAliasing
	)

◆ Fini()

virtual bool Fini ( )

virtual

Reimplemented from BaseRenderEngine.

◆ InitImpl()

virtual bool InitImpl ( )

protectedvirtual

Implements BaseRenderEngine.

◆ IsEnabled()

virtual bool IsEnabled ( ) const

virtual

Determines if the render-engine can be used. Despite loading and initializing the render-engine, it may not be possible to use due to hardware capabilities of the runtime system.

Returns: True if the render-engine can be used

Reimplemented from BaseRenderEngine.

◆ LoadImpl()

virtual bool LoadImpl ( )

protectedvirtual

Implements BaseRenderEngine.

◆ Name()

virtual std::string Name ( ) const

virtual

Get name of the render-engine.

Returns: The render-engine name

Implements RenderEngine.

◆ OgreRoot()

virtual Ogre::Root* OgreRoot ( ) const

virtual

◆ RenderPathType()

OgreRenderPathType RenderPathType ( ) const

◆ Scenes()

virtual SceneStorePtr Scenes ( ) const

protectedvirtual

Implements BaseRenderEngine.

The documentation for this class was generated from the following file:

OgreRenderEngine.hh

Ignition Rendering

API Reference

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Enumeration Documentation

◆ OgreRenderPathType

Constructor & Destructor Documentation

◆ ~OgreRenderEngine()

Member Function Documentation

◆ AddResourcePath()

◆ CreateSceneImpl()

◆ CreateWindow()

◆ Fini()

◆ InitImpl()

◆ IsEnabled()

◆ LoadImpl()

◆ Name()

◆ OgreRoot()

◆ RenderPathType()

◆ Scenes()