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 Ogre2RenderWindow, Ogre2RenderTexture, OgreRenderWindow, BaseSubMesh< T >, BaseSubMesh< Ogre2Object >, BaseSubMesh< OgreObject >, BaseNode< T >, OgreRenderTexture, BaseNode< Ogre2Object >, BaseNode< OgreObject >, OgreDepthCamera, OgreSubMesh, BaseVisual< T >, Ogre2Camera, BaseVisual< Ogre2Node >, BaseVisual< OgreNode >, BaseMesh< T >, BaseMesh< Ogre2Geometry >, BaseMesh< OgreGeometry >, OgreCamera, Ogre2Light, OgreThermalCamera, Ogre2RenderTarget, OgreLight, OgreRenderTarget, Ogre2ThermalCamera, OgreGpuRays, Ogre2DepthCamera, Ogre2GpuRays, Ogre2RenderPass, Ogre2Mesh, Ogre2Node, OgreMesh, OgreLidarVisual, Ogre2LidarVisual, OgreGaussianNoisePass, OgreMarker, Ogre2Marker, BaseGeometry< T >, BaseGeometry< Ogre2Object >, BaseGeometry< OgreObject >, BaseObject, OgreRenderPass, BaseLidarVisual< T >, OgreNode, BaseLidarVisual< OgreVisual >, BaseLidarVisual< Ogre2Visual >, Ogre2Material, BaseGrid< T >, BaseText< T >, BaseGrid< Ogre2Geometry >, BaseGrid< OgreGeometry >, BaseText< OgreGeometry >, BaseMarker< T >, BaseWireBox< T >, OgreMaterial, BaseMarker< Ogre2Geometry >, BaseMarker< OgreGeometry >, BaseWireBox< Ogre2Geometry >, BaseWireBox< OgreGeometry >, and Ogre2ParticleEmitter.
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 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
Implemented in BaseObject.
Referenced by Object::~Object().
◆ PostRender()
|
pure virtual |
Post process this object and any of its children after rendering.
Implemented in Ogre2RenderTexture, OgreRenderTexture, Camera, BaseCamera< T >, BaseCamera< Ogre2Sensor >, BaseCamera< OgreSensor >, Ogre2RenderTarget, OgreDepthCamera, Ogre2DepthCamera, OgreThermalCamera, OgreGpuRays, Ogre2GpuRays, Ogre2ThermalCamera, OgreRenderTarget, BaseRenderTarget< T >, BaseRenderTarget< Ogre2Object >, BaseRenderTarget< OgreObject >, and 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 BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, Ogre2RenderTexture, Ogre2Material, BaseNode< T >, BaseNode< Ogre2Object >, BaseNode< OgreObject >, OgreMaterial, OgreRenderTexture, BaseSubMesh< T >, BaseSubMesh< Ogre2Object >, BaseSubMesh< OgreObject >, OgreDepthCamera, BaseVisual< T >, BaseVisual< Ogre2Node >, BaseVisual< OgreNode >, BaseMesh< T >, BaseMesh< Ogre2Geometry >, BaseMesh< OgreGeometry >, OgreThermalCamera, BaseCamera< T >, BaseCamera< Ogre2Sensor >, BaseCamera< OgreSensor >, Ogre2RenderTarget, Ogre2DepthCamera, OgreGpuRays, Ogre2GpuRays, Ogre2ThermalCamera, OgreRenderTarget, OgreGrid, OgreWireBox, Ogre2Grid, Ogre2WireBox, BaseGizmoVisual< T >, BaseGizmoVisual< OgreVisual >, BaseGizmoVisual< Ogre2Visual >, OgreText, BaseParticleEmitter< T >, OgreLidarVisual, Ogre2LidarVisual, BaseParticleEmitter< OgreVisual >, BaseParticleEmitter< Ogre2Visual >, OgreGaussianNoisePass, Ogre2GaussianNoisePass, OgreMarker, Ogre2Marker, BaseLidarVisual< T >, BaseLidarVisual< OgreVisual >, BaseLidarVisual< Ogre2Visual >, BaseRenderTarget< T >, BaseRenderTarget< Ogre2Object >, BaseRenderTarget< OgreObject >, BaseGrid< T >, BaseObject, BaseText< T >, BaseGrid< Ogre2Geometry >, BaseGrid< OgreGeometry >, BaseText< OgreGeometry >, BaseMarker< T >, BaseWireBox< T >, BaseMarker< Ogre2Geometry >, BaseMarker< OgreGeometry >, BaseWireBox< Ogre2Geometry >, and BaseWireBox< OgreGeometry >.
Referenced by Object::~Object().
◆ Scene()
Get the Scene that created this object.
- Returns
- The parent scene
Implemented in Ogre2Object, and OgreObject.
Referenced by BaseRenderTarget< OgreObject >::BackgroundColor(), BaseGizmoVisual< Ogre2Visual >::CreateMaterials(), BaseLidarVisual< Ogre2Visual >::CreateMaterials(), BaseCamera< OgreSensor >::CreateRenderWindow(), BaseGizmoVisual< Ogre2Visual >::CreateRotationVisual(), BaseGizmoVisual< Ogre2Visual >::CreateScaleVisual(), BaseGizmoVisual< Ogre2Visual >::CreateTranslationVisual(), BaseMesh< OgreGeometry >::Destroy(), BaseSubMesh< OgreObject >::Destroy(), BaseAxisVisual< Ogre2Visual >::Init(), BaseArrowVisual< Ogre2Visual >::Init(), BaseGeometry< OgreObject >::SetMaterial(), BaseVisual< OgreNode >::SetMaterial(), BaseMesh< OgreGeometry >::SetMaterial(), BaseSubMesh< OgreObject >::SetMaterial(), BaseMesh< OgreGeometry >::SetSkeletonWeights(), BaseVisual< OgreNode >::SetVisible(), BaseCamera< OgreSensor >::Update(), and Object::~Object().
The documentation for this class was generated from the following file: