Gazebo Rendering

API Reference

6.6.3
Object Class Referenceabstract

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()

virtual ~Object ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ Destroy()

virtual void 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 Ogre2RenderTarget, OgreRenderTarget, Ogre2RenderWindow, Ogre2RenderTexture, BaseSubMesh< T >, BaseSubMesh< Ogre2Object >, BaseSubMesh< OgreObject >, BaseNode< T >, BaseNode< Ogre2Object >, BaseNode< OgreObject >, OgreRenderTexture, Ogre2Camera, Ogre2SubMesh, OgreCamera, BaseMesh< T >, OgreSubMesh, BaseMesh< Ogre2Geometry >, BaseMesh< OgreGeometry >, Ogre2Light, BaseVisual< T >, BaseVisual< Ogre2Node >, BaseVisual< OgreNode >, OgreThermalCamera, OgreLight, Ogre2GpuRays, OgreGpuRays, Ogre2ThermalCamera, Ogre2Material, Ogre2RenderPass, Ogre2SegmentationCamera, Ogre2BoundingBoxCamera, BaseGeometry< T >, BaseGeometry< Ogre2Object >, BaseGeometry< OgreObject >, BaseJointVisual< T >, OgreDistortionPass, Ogre2Mesh, BaseJointVisual< OgreVisual >, BaseJointVisual< Ogre2Visual >, Ogre2COMVisual, Ogre2InertiaVisual, Ogre2Node, OgreGaussianNoisePass, OgreMesh, OgreLidarVisual, Ogre2Capsule, OgreCapsule, Ogre2LidarVisual, OgreMarker, Ogre2Marker, OgreNode, OgreRenderPass, BaseLidarVisual< T >, BaseLidarVisual< OgreVisual >, BaseLidarVisual< Ogre2Visual >, BaseMarker< T >, OgreMaterial, BaseMarker< Ogre2Geometry >, BaseMarker< OgreGeometry >, BaseText< T >, BaseText< OgreGeometry >, BaseArrowVisual< T >, Ogre2ParticleEmitter, BaseArrowVisual< OgreVisual >, BaseArrowVisual< Ogre2Visual >, BaseAxisVisual< T >, BaseHeightmap< T >, BaseAxisVisual< OgreVisual >, BaseAxisVisual< Ogre2Visual >, BaseHeightmap< Ogre2Geometry >, BaseHeightmap< OgreGeometry >, OgreRenderWindow, BaseGrid< T >, BaseGrid< Ogre2Geometry >, BaseGrid< OgreGeometry >, BaseWireBox< T >, BaseWireBox< Ogre2Geometry >, and BaseWireBox< OgreGeometry >.

◆ Id()

virtual unsigned int Id ( ) const
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

◆ Name()

virtual std::string Name ( ) const
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

◆ PostRender()

◆ PreRender()

virtual void 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, OgreMaterial, BaseNode< T >, BaseNode< Ogre2Object >, BaseNode< OgreObject >, BaseSubMesh< T >, BaseSubMesh< Ogre2Object >, BaseSubMesh< OgreObject >, OgreRenderTexture, BaseVisual< T >, BaseVisual< Ogre2Node >, BaseVisual< OgreNode >, BaseMesh< T >, BaseMesh< Ogre2Geometry >, BaseMesh< OgreGeometry >, Ogre2RenderTarget, OgreThermalCamera, BaseCamera< T >, BaseCamera< Ogre2Sensor >, BaseCamera< OgreSensor >, Ogre2GpuRays, OgreGpuRays, Ogre2ThermalCamera, OgreRenderTarget, Ogre2Heightmap, Ogre2SegmentationCamera, Ogre2BoundingBoxCamera, OgreHeightmap, Ogre2Capsule, OgreCapsule, BaseGizmoVisual< T >, OgreWireBox, BaseGizmoVisual< OgreVisual >, BaseGizmoVisual< Ogre2Visual >, Ogre2WireBox, OgreCOMVisual, OgreInertiaVisual, OgreLightVisual, OgreText, BaseJointVisual< T >, OgreDistortionPass, BaseJointVisual< OgreVisual >, BaseJointVisual< Ogre2Visual >, Ogre2COMVisual, Ogre2InertiaVisual, Ogre2LightVisual, OgreGaussianNoisePass, BaseCOMVisual< T >, BaseParticleEmitter< T >, OgreLidarVisual, BaseCOMVisual< OgreVisual >, BaseCOMVisual< Ogre2Visual >, BaseParticleEmitter< OgreVisual >, BaseParticleEmitter< Ogre2Visual >, Ogre2LidarVisual, BaseInertiaVisual< T >, BaseLightVisual< T >, OgreMarker, Ogre2GaussianNoisePass, BaseInertiaVisual< OgreVisual >, BaseInertiaVisual< Ogre2Visual >, BaseLightVisual< OgreVisual >, BaseLightVisual< Ogre2Visual >, Ogre2Marker, BaseLidarVisual< T >, BaseLidarVisual< OgreVisual >, BaseLidarVisual< Ogre2Visual >, BaseMarker< T >, BaseRenderTarget< T >, BaseMarker< Ogre2Geometry >, BaseMarker< OgreGeometry >, BaseRenderTarget< Ogre2Object >, BaseRenderTarget< OgreObject >, BaseText< T >, BaseText< OgreGeometry >, BaseHeightmap< T >, BaseHeightmap< Ogre2Geometry >, BaseHeightmap< OgreGeometry >, OgreGrid, Ogre2Grid, BaseGrid< T >, BaseGrid< Ogre2Geometry >, BaseGrid< OgreGeometry >, BaseWireBox< T >, BaseWireBox< Ogre2Geometry >, and BaseWireBox< OgreGeometry >.

Referenced by BaseCamera< OgreSensor >::PreRender(), and BaseSubMesh< OgreObject >::PreRender().

◆ Scene()

virtual ScenePtr Scene ( ) const
pure virtual

Get the Scene that created this object.

Returns
The parent scene

The documentation for this class was generated from the following file: