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 () |
| Destructor. 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 | PostRender ()=0 |
| Post process this object and any of its children after rendering. 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 |
Destructor.
References Object::Destroy(), Object::Id(), Object::Name(), Object::PostRender(), 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 OgreRenderWindow, BaseSubMesh< T >, BaseSubMesh< OgreObject >, BaseNode< T >, BaseNode< OgreObject >, OgreRenderTexture, OgreDepthCamera, OgreCamera, BaseMesh< T >, OgreSubMesh, BaseMesh< OgreGeometry >, BaseVisual< T >, BaseVisual< OgreNode >, OgreThermalCamera, OgreLight, OgreRenderTarget, OgreGpuRays, BaseGeometry< T >, BaseGeometry< OgreObject >, BaseJointVisual< T >, OgreDistortionPass, BaseJointVisual< OgreVisual >, OgreGaussianNoisePass, OgreMesh, OgreLidarVisual, OgreCapsule, OgreMarker, OgreNode, OgreRenderPass, BaseLidarVisual< T >, BaseLidarVisual< OgreVisual >, BaseMarker< T >, OgreMaterial, BaseMarker< OgreGeometry >, BaseGrid< T >, BaseText< T >, BaseGrid< OgreGeometry >, BaseText< OgreGeometry >, BaseArrowVisual< T >, BaseWireBox< T >, BaseArrowVisual< OgreVisual >, BaseWireBox< OgreGeometry >, BaseAxisVisual< T >, BaseHeightmap< T >, BaseAxisVisual< OgreVisual >, and BaseHeightmap< OgreGeometry >.
Referenced by BaseAxisVisual< OgreVisual >::Destroy(), BaseArrowVisual< OgreVisual >::Destroy(), and 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
Referenced by BaseNode< OgreObject >::AddChild(), and 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
Referenced by Object::~Object().
◆ PostRender()
|
pure virtual |
Post process this object and any of its children after rendering.
Implemented in Camera, OgreRenderTexture, BaseCamera< T >, BaseCamera< OgreSensor >, OgreDepthCamera, OgreGpuRays, OgreThermalCamera, OgreRenderTarget, BaseRenderTarget< T >, and BaseRenderTarget< OgreObject >.
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 BaseMaterial< T >, BaseMaterial< OgreObject >, OgreMaterial, BaseNode< T >, BaseNode< OgreObject >, BaseSubMesh< T >, BaseSubMesh< OgreObject >, OgreRenderTexture, BaseVisual< T >, BaseVisual< OgreNode >, OgreDepthCamera, BaseMesh< T >, BaseMesh< OgreGeometry >, OgreThermalCamera, BaseCamera< T >, BaseCamera< OgreSensor >, OgreGpuRays, OgreRenderTarget, OgreHeightmap, OgreCapsule, BaseGizmoVisual< T >, OgreGrid, OgreWireBox, BaseGizmoVisual< OgreVisual >, OgreCOMVisual, OgreInertiaVisual, OgreLightVisual, OgreText, BaseJointVisual< T >, OgreDistortionPass, BaseJointVisual< OgreVisual >, OgreGaussianNoisePass, BaseCOMVisual< T >, BaseParticleEmitter< T >, OgreLidarVisual, BaseCOMVisual< OgreVisual >, BaseParticleEmitter< OgreVisual >, BaseInertiaVisual< T >, BaseLightVisual< T >, OgreMarker, BaseInertiaVisual< OgreVisual >, BaseLightVisual< OgreVisual >, BaseLidarVisual< T >, BaseLidarVisual< OgreVisual >, BaseMarker< T >, BaseRenderTarget< T >, BaseMarker< OgreGeometry >, BaseRenderTarget< OgreObject >, BaseGrid< T >, BaseText< T >, BaseGrid< OgreGeometry >, BaseText< OgreGeometry >, BaseWireBox< T >, BaseWireBox< OgreGeometry >, BaseHeightmap< T >, and BaseHeightmap< OgreGeometry >.
Referenced by Object::~Object().
◆ Scene()
Get the Scene that created this object.
- Returns
- The parent scene
Referenced by BaseRenderTarget< OgreObject >::BackgroundColor(), BaseCapsule< OgreGeometry >::Clone(), BaseMesh< OgreGeometry >::Clone(), BaseVisual< OgreNode >::Clone(), BaseJointVisual< OgreVisual >::CreateAxis(), BaseGizmoVisual< OgreVisual >::CreateMaterials(), BaseLidarVisual< OgreVisual >::CreateMaterials(), BaseJointVisual< OgreVisual >::CreateParentAxis(), BaseCamera< OgreSensor >::CreateRenderWindow(), BaseGizmoVisual< OgreVisual >::CreateRotationVisual(), BaseGizmoVisual< OgreVisual >::CreateScaleVisual(), BaseGizmoVisual< OgreVisual >::CreateTranslationVisual(), BaseMesh< OgreGeometry >::Destroy(), BaseSubMesh< OgreObject >::Destroy(), BaseAxisVisual< OgreVisual >::Init(), BaseJointVisual< OgreVisual >::Init(), BaseArrowVisual< OgreVisual >::Init(), BaseGeometry< OgreObject >::SetMaterial(), BaseVisual< OgreNode >::SetMaterial(), BaseMesh< OgreGeometry >::SetMaterial(), BaseSubMesh< OgreObject >::SetMaterial(), BaseMesh< OgreGeometry >::SetSkeletonWeights(), BaseVisual< OgreNode >::SetVisible(), BaseVisual< OgreNode >::SetWireframe(), BaseCamera< OgreSensor >::Update(), and Object::~Object().
The documentation for this class was generated from the following file: