RenderingIface.hh File Reference

#include <list>
#include <map>
#include <string>
#include <vector>
#include "gz/rendering/config.hh"
#include "gz/rendering/Export.hh"
#include "gz/rendering/RenderTypes.hh"

Go to the source code of this file.

Namespaces
	gz
	gz::rendering
	Rendering classes and function useful in robot applications.

Functions
RenderEngine *	engine (const std::string &_name, const std::map< std::string, std::string > &_params={}, const std::string &_path="")
	Get the render-engine registered under the given name. If no render-engine is registered under the given name, NULL will be returned. If the engine is registered, but not loaded, this function will load it. More...
RenderEngine *	engine (const unsigned int _index, const std::map< std::string, std::string > &_params={}, const std::string &_path="")
	Get the render-engine registered at the given index. If no render-engine is registered at the given index, NULL will be returned. If the engine is registered, but not loaded, this function will load it. More...
unsigned int	engineCount ()
	Get the number of available render-engines. More...
bool	fini ()
	Destroy all render-engines and related resources. More...
bool	hasEngine (const std::string &_name)
	Determine if a render-engine is registered under the given name. More...
bool	init ()
	Initialized shared render-engine features. More...
bool	isEngineLoaded (const std::string &_name)
	Determine if a render-engine is already loaded. More...
bool	load ()
	Load shared render-engine resources. More...
std::vector< std::string >	loadedEngines ()
	Get the names of all engines currently loaded. More...
void	registerEngine (const std::string &_name, RenderEngine *_engine)
	Register a new render-engine under the given name. If the given name is already in use, the render-engine will not be registered. More...
ScenePtr	sceneFromFirstRenderEngine ()
	Most applications will only have one rendering engine loaded at a time, and only one scene within that. This helper function gets the first scene that can be found in the first loaded rendering engine. More...
void	setPluginPaths (const std::list< std::string > &_paths)
	Set the plugin paths from which render engines can be loaded. More...
bool	unloadEngine (const std::string &_name)
	Unload the render-engine registered under the given name. More...
void	unregisterEngine (const std::string &_name)
	Unregister a render-engine registered under the given name. If the no render-engine is registered under the given name no work will be done. More...
void	unregisterEngine (const unsigned int _index)
	Unregister a render-engine at the given index. If the no render-engine is registered at the given index, no work will be done. More...
void	unregisterEngine (RenderEngine *_engine)
	Unregister the given render-engine. If the given render-engine is not currently registered, no work will be done. More...