gz/rendering/RenderEngine.hh
virtual void DestroySceneByName(const std::string &_name)=0
Destroy the scene with the given name. If no scenes exist with the given name, no work will be done.
STL class.
virtual bool HasSceneId(unsigned int _id) const =0
Determine if this render-engine manages a scene with the given ID.
virtual void DestroySceneById(unsigned int _id)=0
Destroy the scene with the given ID. If no scenes exist with the given ID, no work will be done.
virtual bool IsLoaded() const =0
Determines if the render-engine has been loaded.
virtual ~RenderEngine()
Deconstructor.
Definition: gz/rendering/RenderEngine.hh:39
virtual ScenePtr CreateScene(const std::string &_name)=0
Create a new scene with the given name. The given name should be unique across all scenes managed by ...
virtual ScenePtr SceneByIndex(unsigned int _index) const =0
Get the scene at the given index. If no scenes exist at the given index, NULL will be returned.
virtual std::string Name() const =0
Get name of the render-engine.
shared_ptr< const Scene > ConstScenePtr
Definition: gz/rendering/RenderTypes.hh:321
virtual bool HasSceneName(const std::string &_name) const =0
Determine if this render-engine manages a scene with the given name.
shared_ptr< RenderPassSystem > RenderPassSystemPtr
Shared pointer to RenderPassSystem.
Definition: gz/rendering/RenderTypes.hh:179
virtual ScenePtr SceneById(unsigned int _id) const =0
Get the scene with the given ID. If no scenes exist with the given ID, NULL will be returned.
virtual void Destroy()=0
Destroys all scenes created by render-engine and releases all loaded resources. This should be called...
STL class.
virtual bool IsInitialized() const =0
Determines if the render-engine has been initialized.
virtual RenderPassSystemPtr RenderPassSystem() const =0
Get the render pass system for this engine.
virtual bool IsEnabled() const =0
Determines if the render-engine can be used. Despite loading and initializing the render-engine,...
virtual void DestroyScenes()=0
Destroy all scenes managed by this render-engine.
virtual void AddResourcePath(const std::string &_path)=0
Add path to media resource location.
virtual void DestroySceneByIndex(unsigned int _index)=0
Destroy the scene at the given index. If no scenes exist at the given index, no work will be done.
virtual void DestroyScene(ScenePtr _scene)=0
Destroy the given scene. If the given scene is not managed by this render-engine, no work will be don...
virtual unsigned int SceneCount() const =0
Get the number of scenes actively managed by this render-engine.
shared_ptr< Scene > ScenePtr
Shared pointer to Scene.
Definition: gz/rendering/RenderTypes.hh:194
An abstract interface to a concrete render-engine. A RenderEngine is responsible for initializing a r...
Definition: gz/rendering/RenderEngine.hh:36
virtual bool Load(const std::map< std::string, std::string > &_params={})=0
Load any necessary resources to set up render-engine. This should called before any other function.
virtual bool Init()=0
Initialize the render-engine. This should be called immediately after a successful call to Load.
virtual bool Fini()=0
virtual bool HasScene(ConstScenePtr _scene) const =0
Determine if the given scene is actively managed by this render-engine.
virtual ScenePtr SceneByName(const std::string &_name) const =0
Get the scene with the given name. If no scenes exist with the given name, NULL will be returned.