Represents an object present in the scene graph. This includes sub-meshes, materials, render targets, as well as posable nodes. More...
#include <gz/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 |
Destructor.
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 Ogre2RenderTarget, OgreRenderTarget, Ogre2WideAngleCamera, Ogre2ThermalCamera, Ogre2SegmentationCamera, Ogre2RenderWindow, Ogre2RenderTexture, Ogre2RenderPass, Ogre2ParticleEmitter, Ogre2Node, Ogre2SubMesh, Ogre2Mesh, Ogre2Material, Ogre2Marker, Ogre2Light, Ogre2LidarVisual, Ogre2LensFlarePass, Ogre2InertiaVisual, Ogre2Heightmap, Ogre2GpuRays, Ogre2DepthCamera, Ogre2COMVisual, Ogre2Capsule, Ogre2Camera, Ogre2BoundingBoxCamera, OgreWideAngleCamera, OgreThermalCamera, OgreRenderTexture, OgreRenderPass, OgreNode, OgreSubMesh, OgreMesh, OgreMaterial, OgreMarker, OgreLight, OgreLidarVisual, OgreLensFlarePass, OgreGpuRays, OgreGaussianNoisePass, OgreDistortionPass, OgreDepthCamera, OgreCapsule, OgreCamera, BaseVisual< T >, BaseVisual< Ogre2Node >, BaseVisual< OgreNode >, BaseText< T >, BaseText< OgreGeometry >, BaseNode< T >, BaseNode< Ogre2Object >, BaseNode< OgreObject >, BaseSubMesh< T >, BaseSubMesh< Ogre2Object >, BaseSubMesh< OgreObject >, BaseMesh< T >, BaseMesh< Ogre2Geometry >, BaseMesh< OgreGeometry >, BaseMarker< T >, BaseMarker< Ogre2Geometry >, BaseMarker< OgreGeometry >, BaseLidarVisual< T >, BaseLidarVisual< OgreVisual >, BaseLidarVisual< Ogre2Visual >, BaseJointVisual< T >, BaseJointVisual< OgreVisual >, BaseJointVisual< Ogre2Visual >, BaseHeightmap< T >, BaseHeightmap< Ogre2Geometry >, BaseHeightmap< OgreGeometry >, BaseGeometry< T >, BaseGeometry< Ogre2Object >, BaseGeometry< OgreObject >, BaseAxisVisual< T >, BaseAxisVisual< OgreVisual >, BaseAxisVisual< Ogre2Visual >, BaseArrowVisual< T >, BaseArrowVisual< OgreVisual >, BaseArrowVisual< Ogre2Visual >, OgreRenderWindow, BaseWireBox< T >, BaseWireBox< Ogre2Geometry >, BaseWireBox< OgreGeometry >, BaseGrid< T >, BaseGrid< Ogre2Geometry >, and BaseGrid< OgreGeometry >.
◆ 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
◆ 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
◆ PostRender()
|
pure virtual |
Post process this object and any of its children after rendering.
Implemented in Camera, Ogre2WideAngleCamera, Ogre2ThermalCamera, Ogre2SegmentationCamera, Ogre2RenderTexture, Ogre2RenderTarget, Ogre2LensFlarePass, Ogre2GpuRays, Ogre2DepthCamera, Ogre2BoundingBoxCamera, OgreWideAngleCamera, OgreThermalCamera, OgreRenderTexture, OgreRenderTarget, OgreLensFlarePass, OgreGpuRays, OgreDepthCamera, BaseRenderTarget< T >, BaseRenderTarget< Ogre2Object >, BaseRenderTarget< OgreObject >, BaseCamera< T >, BaseCamera< Ogre2Sensor >, and BaseCamera< OgreSensor >.
Referenced by BaseCamera< T >::PostRender().
◆ 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 Ogre2WireBox, Ogre2WideAngleCamera, Ogre2ThermalCamera, Ogre2SegmentationCamera, Ogre2RenderTexture, Ogre2RenderTarget, Ogre2Projector, Ogre2ParticleEmitter, Ogre2Material, Ogre2Marker, Ogre2LightVisual, Ogre2LidarVisual, Ogre2InertiaVisual, Ogre2Heightmap, Ogre2GpuRays, Ogre2GaussianNoisePass, Ogre2DepthCamera, Ogre2COMVisual, Ogre2Capsule, Ogre2BoundingBoxCamera, OgreWireBox, OgreWideAngleCamera, OgreThermalCamera, OgreText, OgreRenderTexture, OgreRenderTarget, OgreProjector, OgreMaterial, OgreMarker, OgreLightVisual, OgreLidarVisual, OgreInertiaVisual, OgreHeightmap, OgreGpuRays, OgreGaussianNoisePass, OgreDistortionPass, OgreDepthCamera, OgreCOMVisual, OgreCapsule, BaseVisual< T >, BaseVisual< Ogre2Node >, BaseVisual< OgreNode >, BaseText< T >, BaseText< OgreGeometry >, BaseRenderTarget< T >, BaseRenderTarget< Ogre2Object >, BaseRenderTarget< OgreObject >, BaseParticleEmitter< T >, BaseParticleEmitter< OgreVisual >, BaseParticleEmitter< Ogre2Visual >, BaseNode< T >, BaseNode< Ogre2Object >, BaseNode< OgreObject >, BaseSubMesh< T >, BaseSubMesh< Ogre2Object >, BaseSubMesh< OgreObject >, BaseMesh< T >, BaseMesh< Ogre2Geometry >, BaseMesh< OgreGeometry >, BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, BaseMarker< T >, BaseMarker< Ogre2Geometry >, BaseMarker< OgreGeometry >, BaseLightVisual< T >, BaseLightVisual< OgreVisual >, BaseLightVisual< Ogre2Visual >, BaseLidarVisual< T >, BaseLidarVisual< OgreVisual >, BaseLidarVisual< Ogre2Visual >, BaseJointVisual< T >, BaseJointVisual< OgreVisual >, BaseJointVisual< Ogre2Visual >, BaseInertiaVisual< T >, BaseInertiaVisual< OgreVisual >, BaseInertiaVisual< Ogre2Visual >, BaseHeightmap< T >, BaseHeightmap< Ogre2Geometry >, BaseHeightmap< OgreGeometry >, BaseGizmoVisual< T >, BaseGizmoVisual< OgreVisual >, BaseGizmoVisual< Ogre2Visual >, BaseCOMVisual< T >, BaseCOMVisual< OgreVisual >, BaseCOMVisual< Ogre2Visual >, BaseCamera< T >, BaseCamera< Ogre2Sensor >, BaseCamera< OgreSensor >, Ogre2Grid, OgreGrid, BaseWireBox< T >, BaseWireBox< Ogre2Geometry >, BaseWireBox< OgreGeometry >, BaseGrid< T >, BaseGrid< Ogre2Geometry >, and BaseGrid< OgreGeometry >.
Referenced by BaseSubMesh< T >::PreRender().
◆ Scene()
Get the Scene that created this object.
- Returns
- The parent scene
The documentation for this class was generated from the following file: