Ignition Rendering

API Reference

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

Member Function Documentation

◆ Destroy()

◆ 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

Referenced by BaseNode< OgreObject >::AddChild(), and Object::~Object().

◆ 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

Referenced by Object::~Object().

◆ 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 >, OgreRenderTexture, BaseSubMesh< Ogre2Object >, BaseSubMesh< OgreObject >, OgreDepthCamera, BaseMesh< T >, BaseMesh< Ogre2Geometry >, BaseMesh< OgreGeometry >, Ogre2RenderTarget, BaseVisual< T >, BaseVisual< Ogre2Node >, BaseVisual< OgreNode >, OgreThermalCamera, BaseCamera< T >, BaseCamera< Ogre2Sensor >, BaseCamera< OgreSensor >, Ogre2GpuRays, Ogre2DepthCamera, OgreGpuRays, Ogre2ThermalCamera, OgreRenderTarget, OgreHeightmap, Ogre2Capsule, OgreCapsule, BaseGizmoVisual< T >, OgreGrid, OgreWireBox, BaseGizmoVisual< OgreVisual >, BaseGizmoVisual< Ogre2Visual >, Ogre2Grid, Ogre2WireBox, OgreLightVisual, OgreText, Ogre2LightVisual, OgreGaussianNoisePass, BaseParticleEmitter< T >, OgreLidarVisual, BaseParticleEmitter< OgreVisual >, BaseParticleEmitter< Ogre2Visual >, Ogre2LidarVisual, BaseLightVisual< T >, OgreMarker, Ogre2GaussianNoisePass, BaseLightVisual< OgreVisual >, BaseLightVisual< Ogre2Visual >, Ogre2Marker, BaseLidarVisual< T >, BaseLidarVisual< OgreVisual >, BaseLidarVisual< Ogre2Visual >, BaseMarker< T >, BaseRenderTarget< T >, BaseMarker< Ogre2Geometry >, BaseMarker< OgreGeometry >, BaseRenderTarget< Ogre2Object >, BaseRenderTarget< OgreObject >, BaseGrid< T >, BaseText< T >, BaseGrid< Ogre2Geometry >, BaseGrid< OgreGeometry >, BaseText< OgreGeometry >, BaseWireBox< T >, BaseWireBox< Ogre2Geometry >, BaseWireBox< OgreGeometry >, BaseHeightmap< T >, and BaseHeightmap< OgreGeometry >.

Referenced by Object::~Object().

◆ Scene()


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