Represents an object present in the scene graph. This includes sub-meshes, materials, render targets, as well as posable nodes. More...
#include <ignition/rendering/Object.hh>
Public Member Functions | |
| virtual | ~Object () |
| Deconstructor. More... | |
| virtual void | Destroy ()=0 |
| Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More... | |
| virtual unsigned int | Id () const =0 |
| Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More... | |
| virtual std::string | Name () const =0 |
| Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More... | |
| virtual void | PreRender ()=0 |
| Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender. More... | |
| virtual ScenePtr | Scene () const =0 |
| Get the Scene that created this object. More... | |
Detailed Description
Represents an object present in the scene graph. This includes sub-meshes, materials, render targets, as well as posable nodes.
Constructor & Destructor Documentation
◆ ~Object()
|
inlinevirtual |
Deconstructor.
References Object::Destroy(), Object::Id(), Object::Name(), Object::PreRender(), and Object::Scene().
Member Function Documentation
◆ Destroy()
|
pure virtual |
Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.
Implemented in BaseVisual< T >, BaseVisual< OgreNode >, OgreRenderWindow, OgreRenderTexture, BaseNode< T >, BaseNode< OgreObject >, OgreSubMesh, OgreLight, OgreRenderTarget, BaseMesh< T >, BaseMesh< OgreGeometry >, BaseGeometry< T >, BaseGeometry< OgreObject >, OgreNode, BaseGrid< T >, BaseGrid< OgreGeometry >, and BaseObject.
Referenced by Object::~Object().
◆ Id()
|
pure virtual |
Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes.
- Returns
- The object ID
Implemented in BaseObject.
Referenced by Object::~Object().
◆ Name()
|
pure virtual |
Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes.
- Returns
- The object name
Implemented in BaseObject.
Referenced by Object::~Object().
◆ PreRender()
|
pure virtual |
Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender.
Implemented in BaseVisual< T >, BaseVisual< OgreNode >, BaseSubMesh< T >, BaseSubMesh< OgreObject >, BaseCamera< T >, BaseCamera< OgreSensor >, BaseMaterial< T >, BaseMaterial< OgreObject >, OgreRenderTarget, BaseMesh< T >, BaseMesh< OgreGeometry >, OgreGrid, BaseGrid< T >, BaseGrid< OgreGeometry >, BaseObject, BaseRenderTarget< T >, and BaseRenderTarget< OgreObject >.
Referenced by Object::~Object().
◆ Scene()
Get the Scene that created this object.
- Returns
- The parent scene
Implemented in OgreObject.
Referenced by BaseRenderTarget< OgreObject >::BackgroundColor(), BaseCamera< OgreSensor >::CreateRenderWindow(), BaseAxisVisual< OgreVisual >::Init(), BaseArrowVisual< OgreVisual >::Init(), BaseGeometry< OgreObject >::SetMaterial(), BaseMesh< OgreGeometry >::SetMaterial(), BaseSubMesh< OgreObject >::SetMaterial(), BaseVisual< OgreNode >::SetMaterial(), BaseCamera< OgreSensor >::Update(), and Object::~Object().
The documentation for this class was generated from the following file: