Gazebo Rendering

API Reference

7.4.2

#include <BaseRenderEngine.hh>

Public Member Functions

virtual ~BaseRenderEngine ()
 
virtual void AddResourcePath (const std::string &_path) override
 Add path to media resource location. More...
 
virtual ScenePtr CreateScene (const std::string &_name) override
 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) override
 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 () override
 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) override
 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) override
 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) override
 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) override
 Destroy the scene with the given name. If no scenes exist with the given name, no work will be done. More...
 
virtual void DestroyScenes () override
 Destroy all scenes managed by this render-engine. More...
 
virtual bool Fini () override
 
virtual rendering::GraphicsAPI GraphicsAPI () const override
 Returns the GraphicsAPI currently in use. More...
 
virtual bool HasScene (ConstScenePtr _scene) const override
 Determine if the given scene is actively managed by this render-engine. More...
 
virtual bool HasSceneId (unsigned int _id) const override
 Determine if this render-engine manages a scene with the given ID. More...
 
virtual bool HasSceneName (const std::string &_name) const override
 Determine if this render-engine manages a scene with the given name. More...
 
virtual bool Headless () const override
 Get headless mode. More...
 
virtual bool Init () override
 Initialize the render-engine. This should be called immediately after a successful call to Load. More...
 
virtual bool IsEnabled () const override
 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 bool IsInitialized () const override
 Determines if the render-engine has been initialized. More...
 
virtual bool IsLoaded () const override
 Determines if the render-engine has been loaded. More...
 
virtual bool Load (const std::map< std::string, std::string > &_params={}) override
 Load any necessary resources to set up render-engine. This should called before any other function. More...
 
virtual RenderPassSystemPtr RenderPassSystem () const override
 Get the render pass system for this engine. More...
 
virtual ScenePtr SceneById (unsigned int _id) const override
 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 override
 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 override
 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 override
 Get the number of scenes actively managed by this render-engine. More...
 
virtual void SetHeadless (bool _headless) override
 Set headless mode Only available in OGRE 2.2, which makes use of EGL. More...
 
- Public Member Functions inherited from RenderEngine
virtual ~RenderEngine ()
 Destructor. More...
 
virtual std::string Name () const =0
 Get name of the render-engine. More...
 

Protected Member Functions

 BaseRenderEngine ()
 
virtual ScenePtr CreateSceneImpl (unsigned int _id, const std::string &_name)=0
 
virtual bool InitImpl ()=0
 
virtual bool LoadImpl (const std::map< std::string, std::string > &_params)=0
 Engine implementation of Load function. More...
 
virtual unsigned int NextSceneId ()
 
virtual void PrepareScene (ScenePtr _scene)
 
virtual SceneStorePtr Scenes () const =0
 

Protected Attributes

bool initialized = false
 
bool isHeadless = false
 
bool loaded = false
 
unsigned int nextSceneId
 
RenderPassSystemPtr renderPassSystem
 Render pass system for this render engine. More...
 
std::vector< std::stringresourcePaths
 a list of paths that render engines use to locate their resources More...
 
std::string winID = ""
 ID from a external window. More...
 

Constructor & Destructor Documentation

◆ BaseRenderEngine()

BaseRenderEngine ( )
protected

◆ ~BaseRenderEngine()

virtual ~BaseRenderEngine ( )
virtual

Member Function Documentation

◆ AddResourcePath()

virtual void AddResourcePath ( const std::string _path)
overridevirtual

Add path to media resource location.

Parameters
[in]_pathAbsolute path to resource location

Implements RenderEngine.

Reimplemented in Ogre2RenderEngine, and OgreRenderEngine.

◆ CreateScene() [1/2]

virtual ScenePtr CreateScene ( const std::string _name)
overridevirtual

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.

Parameters
[in]_nameName of the new scene
Returns
The created scene

Implements RenderEngine.

◆ CreateScene() [2/2]

virtual ScenePtr CreateScene ( unsigned int  _id,
const std::string _name 
)
overridevirtual

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.

Parameters
[in]_idID of the new scene
[in]_nameName of the new scene
Returns
The created scene

Implements RenderEngine.

◆ CreateSceneImpl()

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

Implemented in Ogre2RenderEngine, and OgreRenderEngine.

◆ Destroy()

virtual void Destroy ( )
overridevirtual

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.

Returns
True if the render-engine was successfully destroyed

Implements RenderEngine.

Reimplemented in OgreRenderEngine, and Ogre2RenderEngine.

◆ DestroyScene()

virtual void DestroyScene ( ScenePtr  _scene)
overridevirtual

Destroy the given scene. If the given scene is not managed by this render-engine, no work will be done.

Parameters
[in]_sceneScene to be destroyed

Implements RenderEngine.

◆ DestroySceneById()

virtual void DestroySceneById ( unsigned int  _id)
overridevirtual

Destroy the scene with the given ID. If no scenes exist with the given ID, no work will be done.

Parameters
[in]_idID of the scene to destroy

Implements RenderEngine.

◆ DestroySceneByIndex()

virtual void DestroySceneByIndex ( unsigned int  _index)
overridevirtual

Destroy the scene at the given index. If no scenes exist at the given index, no work will be done.

Parameters
[in]_indexIndex of the scene to destroy

Implements RenderEngine.

◆ DestroySceneByName()

virtual void DestroySceneByName ( const std::string _name)
overridevirtual

Destroy the scene with the given name. If no scenes exist with the given name, no work will be done.

Parameters
[in]_nameName of the scene to destroy

Implements RenderEngine.

◆ DestroyScenes()

virtual void DestroyScenes ( )
overridevirtual

Destroy all scenes managed by this render-engine.

Implements RenderEngine.

◆ Fini()

virtual bool Fini ( )
overridevirtual

Implements RenderEngine.

◆ GraphicsAPI()

virtual rendering::GraphicsAPI GraphicsAPI ( ) const
inlineoverridevirtual

Returns the GraphicsAPI currently in use.

Returns
GraphicsAPI currently in use

Implements RenderEngine.

Reimplemented in Ogre2RenderEngine, and OgreRenderEngine.

References gz::rendering::UNKNOWN.

◆ HasScene()

virtual bool HasScene ( ConstScenePtr  _scene) const
overridevirtual

Determine if the given scene is actively managed by this render-engine.

Parameters
[in]_sceneScene in question
Returns
True if the scene is managed by this render-engine

Implements RenderEngine.

◆ HasSceneId()

virtual bool HasSceneId ( unsigned int  _id) const
overridevirtual

Determine if this render-engine manages a scene with the given ID.

Parameters
[in]_idID of scene in question
Returns
True if this render-engine manages the specified scene

Implements RenderEngine.

◆ HasSceneName()

virtual bool HasSceneName ( const std::string _name) const
overridevirtual

Determine if this render-engine manages a scene with the given name.

Parameters
[in]_nameName of scene in question
Returns
True if this render-engine manages the specified scene

Implements RenderEngine.

◆ Headless()

virtual bool Headless ( ) const
overridevirtual

Get headless mode.

Returns
True if headless mode is enable, false otherwise.

Implements RenderEngine.

◆ Init()

virtual bool Init ( )
overridevirtual

Initialize the render-engine. This should be called immediately after a successful call to Load.

Returns
True if the render-engine was successfully initialized

Implements RenderEngine.

◆ InitImpl()

virtual bool InitImpl ( )
protectedpure virtual

Implemented in Ogre2RenderEngine, and OgreRenderEngine.

◆ IsEnabled()

virtual bool IsEnabled ( ) const
overridevirtual

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

Implements RenderEngine.

Reimplemented in OgreRenderEngine, and Ogre2RenderEngine.

◆ IsInitialized()

virtual bool IsInitialized ( ) const
overridevirtual

Determines if the render-engine has been initialized.

Returns
True if the render-engine is initialized

Implements RenderEngine.

◆ IsLoaded()

virtual bool IsLoaded ( ) const
overridevirtual

Determines if the render-engine has been loaded.

Returns
True if the render-engine is loaded

Implements RenderEngine.

◆ Load()

virtual bool Load ( const std::map< std::string, std::string > &  _params = {})
overridevirtual

Load any necessary resources to set up render-engine. This should called before any other function.

Parameters
[in]_paramsParameters to be passed to the underlying rendering engine.
Returns
True if the render-engine was successfully loaded

Implements RenderEngine.

◆ LoadImpl()

virtual bool LoadImpl ( const std::map< std::string, std::string > &  _params)
protectedpure virtual

Engine implementation of Load function.

Parameters
[in]_paramsParameters to be passed to the render engine.

Implemented in Ogre2RenderEngine, and OgreRenderEngine.

◆ NextSceneId()

virtual unsigned int NextSceneId ( )
protectedvirtual

◆ PrepareScene()

virtual void PrepareScene ( ScenePtr  _scene)
protectedvirtual

◆ RenderPassSystem()

virtual RenderPassSystemPtr RenderPassSystem ( ) const
overridevirtual

Get the render pass system for this engine.

Implements RenderEngine.

◆ SceneById()

virtual ScenePtr SceneById ( unsigned int  _id) const
overridevirtual

Get the scene with the given ID. If no scenes exist with the given ID, NULL will be returned.

Parameters
[in]_idID of scene to be retrieved
Returns
The specified scene

Implements RenderEngine.

◆ SceneByIndex()

virtual ScenePtr SceneByIndex ( unsigned int  _index) const
overridevirtual

Get the scene at the given index. If no scenes exist at the given index, NULL will be returned.

Parameters
[in]_indexIndex of scene, which is a number from 0 to SceneCount() - 1. Note that the index for a specific scene might change as other scenes are destroyed.
Returns
The specified scene

Implements RenderEngine.

◆ SceneByName()

virtual ScenePtr SceneByName ( const std::string _name) const
overridevirtual

Get the scene with the given name. If no scenes exist with the given name, NULL will be returned.

Parameters
[in]_nameName of scene to be retrieved
Returns
The specified scene

Implements RenderEngine.

◆ SceneCount()

virtual unsigned int SceneCount ( ) const
overridevirtual

Get the number of scenes actively managed by this render-engine.

Returns
The number of active scenes

Implements RenderEngine.

◆ Scenes()

virtual SceneStorePtr Scenes ( ) const
protectedpure virtual

Implemented in Ogre2RenderEngine, and OgreRenderEngine.

◆ SetHeadless()

virtual void SetHeadless ( bool  _headless)
overridevirtual

Set headless mode Only available in OGRE 2.2, which makes use of EGL.

Parameters
[in]_headlessSet to true to enable headless mode.

Implements RenderEngine.

Member Data Documentation

◆ initialized

bool initialized = false
protected

◆ isHeadless

bool isHeadless = false
protected

◆ loaded

bool loaded = false
protected

◆ nextSceneId

unsigned int nextSceneId
protected

◆ renderPassSystem

RenderPassSystemPtr renderPassSystem
protected

Render pass system for this render engine.

◆ resourcePaths

std::vector<std::string> resourcePaths
protected

a list of paths that render engines use to locate their resources

◆ winID

std::string winID = ""
protected

ID from a external window.


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