All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
gazebo::rendering::RenderEngine Class Reference

Adaptor to Ogre3d. More...

#include <rendering/rendering.hh>

Inheritance diagram for gazebo::rendering::RenderEngine:
Inheritance graph
[legend]

Public Types

enum  RenderPathType {
  NONE = 0, VERTEX = 1, FORWARD = 2, DEFERRED = 3,
  RENDER_PATH_COUNT
}
 The type of rendering path used by the rendering engine. More...

Public Member Functions

void AddResourcePath (const std::string &_uri)
 Add a new path for Ogre to search for resources.
ScenePtr CreateScene (const std::string &_name, bool _enableVisualizations)
 Create a scene.
void Fini ()
 Tears down the rendering engine.
RenderPathType GetRenderPathType () const
 Get the type of rendering path to use.
ScenePtr GetScene (const std::string &_name="")
 Get a scene by name.
ScenePtr GetScene (unsigned int _index)
 Get a scene by index.
unsigned int GetSceneCount () const
 Get the number of scenes.
WindowManagerPtr GetWindowManager () const
 Get a pointer to the window manager.
void Init ()
 Initialize Ogre. Load must happen before Init.
void Load ()
 Load the parameters for Ogre. Load must happen before Init.
void RemoveScene (const std::string &_name)
 Remove a scene.

Public Attributes

Ogre::Root * root
 Pointer to the root scene node.

Protected Attributes

void * dummyContext
 GLX context used to render the scenes.Used for gui-less operation.
void * dummyDisplay
 Pointer to the dummy display.Used for gui-less operation.
uint64_t dummyWindowId
 ID for a dummy window. Used for gui-less operation.

Additional Inherited Members

- Static Public Member Functions inherited from SingletonT< T >
static T * Instance ()
 Get an instance of the singleton.
- Protected Member Functions inherited from SingletonT< T >
 SingletonT ()
 Constructor.
virtual ~SingletonT ()
 Destructor.

Detailed Description

Adaptor to Ogre3d.

Provides the interface to load, initialize the rendering engine.

Member Enumeration Documentation

The type of rendering path used by the rendering engine.

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.

Member Function Documentation

void gazebo::rendering::RenderEngine::AddResourcePath ( const std::string &  _uri)

Add a new path for Ogre to search for resources.

Parameters
[in]_uriURI of the path. The uri should be of the form file:// or model://
ScenePtr gazebo::rendering::RenderEngine::CreateScene ( const std::string &  _name,
bool  _enableVisualizations 
)

Create a scene.

Parameters
[in]_nameThe name of the scene.
[in]_enableVisualizationsTrue enables visualization elements such as laser lines.
void gazebo::rendering::RenderEngine::Fini ( )

Tears down the rendering engine.

RenderPathType gazebo::rendering::RenderEngine::GetRenderPathType ( ) const

Get the type of rendering path to use.

This is automatically determined based on the computers capabilities

Returns
The RenderPathType
ScenePtr gazebo::rendering::RenderEngine::GetScene ( const std::string &  _name = "")

Get a scene by name.

Parameters
[in]_nameName of the scene to retreive.
Returns
A pointer to the Scene, or NULL if the scene doesn't exist.
ScenePtr gazebo::rendering::RenderEngine::GetScene ( unsigned int  _index)

Get a scene by index.

The index should be between 0 and GetSceneCount().

Parameters
[in]_indexThe index of the scene.
Returns
A pointer to a Scene, or NULL if the index was invalid.
unsigned int gazebo::rendering::RenderEngine::GetSceneCount ( ) const

Get the number of scenes.

Returns
The number of scenes created by the RenderEngine.
WindowManagerPtr gazebo::rendering::RenderEngine::GetWindowManager ( ) const

Get a pointer to the window manager.

Returns
Pointer to the window manager.
void gazebo::rendering::RenderEngine::Init ( )

Initialize Ogre. Load must happen before Init.

void gazebo::rendering::RenderEngine::Load ( )

Load the parameters for Ogre. Load must happen before Init.

void gazebo::rendering::RenderEngine::RemoveScene ( const std::string &  _name)

Remove a scene.

Parameters
[in]_nameThe name of the scene to remove.

Member Data Documentation

void* gazebo::rendering::RenderEngine::dummyContext
protected

GLX context used to render the scenes.Used for gui-less operation.

void* gazebo::rendering::RenderEngine::dummyDisplay
protected

Pointer to the dummy display.Used for gui-less operation.

uint64_t gazebo::rendering::RenderEngine::dummyWindowId
protected

ID for a dummy window. Used for gui-less operation.

Ogre::Root* gazebo::rendering::RenderEngine::root

Pointer to the root scene node.


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