gz/rendering/base/BaseRenderEngine.hh
virtual SceneStorePtr Scenes() const =0
virtual void Destroy() override
Destroys all scenes created by render-engine and releases all loaded resources. This should be called...
virtual bool InitImpl()=0
STL class.
#define IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
virtual bool IsEnabled() const override
Determines if the render-engine can be used. Despite loading and initializing the render-engine,...
BaseRenderEngine()
virtual bool Fini() override
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.
virtual unsigned int NextSceneId()
bool loaded
Definition: gz/rendering/base/BaseRenderEngine.hh:110
virtual ~BaseRenderEngine()
std::vector< std::string > resourcePaths
a list of paths that render engines use to locate their resources
Definition: gz/rendering/base/BaseRenderEngine.hh:119
virtual bool HasScene(ConstScenePtr _scene) const override
Determine if the given scene is actively managed by this render-engine.
virtual bool IsLoaded() const override
Determines if the render-engine has been loaded.
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 don...
RenderPassSystemPtr renderPassSystem
Render pass system for this render engine.
Definition: gz/rendering/base/BaseRenderEngine.hh:122
virtual RenderPassSystemPtr RenderPassSystem() const override
Get the render pass system for this engine.
bool initialized
Definition: gz/rendering/base/BaseRenderEngine.hh:112
virtual unsigned int SceneCount() const override
Get the number of scenes actively managed by this render-engine.
virtual bool LoadImpl(const std::map< std::string, std::string > &_params)=0
Engine implementation of Load function.
virtual ScenePtr CreateSceneImpl(unsigned int _id, const std::string &_name)=0
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.
virtual bool HasSceneId(unsigned int _id) const override
Determine if this render-engine manages a scene with the given ID.
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.
virtual void AddResourcePath(const std::string &_path) override
Add path to media resource location.
STL class.
virtual void DestroyScenes() override
Destroy all scenes managed by this render-engine.
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.
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.
unsigned int nextSceneId
Definition: gz/rendering/base/BaseRenderEngine.hh:114
virtual bool Init() override
Initialize the render-engine. This should be called immediately after a successful call to Load.
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.
virtual void PrepareScene(ScenePtr _scene)
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.
An abstract interface to a concrete render-engine. A RenderEngine is responsible for initializing a r...
Definition: gz/rendering/RenderEngine.hh:36
A class for creating and managing render passes.
Definition: gz/rendering/RenderPassSystem.hh:56
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 ...
virtual bool IsInitialized() const override
Determines if the render-engine has been initialized.
virtual bool HasSceneName(const std::string &_name) const override
Determine if this render-engine manages a scene with the given name.
Definition: gz/rendering/base/BaseRenderEngine.hh:33
#define IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING