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. | |
| virtual void | Destroy ()=0 |
| Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. | |
| 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. | |
| 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. | |
| virtual void | PostRender ()=0 |
| Post process this object and any of its children after rendering. | |
| 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. | |
| virtual ScenePtr | Scene () const =0 |
| Get the Scene that created this object. | |
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 BaseGrid< T >, BaseGrid< Ogre2Geometry >, BaseGrid< OgreGeometry >, BaseWireBox< T >, BaseWireBox< Ogre2Geometry >, BaseWireBox< OgreGeometry >, OgreRenderWindow, BaseArrowVisual< T >, BaseArrowVisual< Ogre2Visual >, BaseArrowVisual< OgreVisual >, BaseAxisVisual< T >, BaseAxisVisual< Ogre2Visual >, BaseAxisVisual< OgreVisual >, BaseGeometry< T >, BaseGeometry< Ogre2Object >, BaseGeometry< OgreObject >, BaseHeightmap< T >, BaseHeightmap< Ogre2Geometry >, BaseHeightmap< OgreGeometry >, BaseJointVisual< T >, BaseJointVisual< Ogre2Visual >, BaseJointVisual< OgreVisual >, BaseLidarVisual< T >, BaseLidarVisual< Ogre2Visual >, BaseLidarVisual< OgreVisual >, BaseMarker< T >, BaseMarker< Ogre2Geometry >, BaseMarker< OgreGeometry >, BaseMesh< T >, BaseMesh< Ogre2Geometry >, BaseMesh< OgreGeometry >, BaseSubMesh< T >, BaseSubMesh< Ogre2Object >, BaseSubMesh< OgreObject >, BaseNode< T >, BaseNode< Ogre2Object >, BaseNode< OgreObject >, BaseText< T >, BaseText< OgreGeometry >, BaseVisual< T >, BaseVisual< Ogre2Node >, BaseVisual< OgreNode >, OgreCamera, OgreCapsule, OgreDepthCamera, OgreDistortionPass, OgreGaussianNoisePass, OgreGpuRays, OgreLensFlarePass, OgreLidarVisual, OgreLight, OgreMarker, OgreMaterial, OgreMesh, OgreSubMesh, OgreNode, OgreRenderPass, OgreRenderTexture, OgreThermalCamera, OgreWideAngleCamera, Ogre2BoundingBoxCamera, Ogre2Camera, Ogre2Capsule, Ogre2COMVisual, Ogre2DepthCamera, Ogre2GpuRays, Ogre2Heightmap, Ogre2InertiaVisual, Ogre2LensFlarePass, Ogre2LidarVisual, Ogre2Light, Ogre2Marker, Ogre2Material, Ogre2Mesh, Ogre2SubMesh, Ogre2Node, Ogre2ParticleEmitter, Ogre2RenderPass, Ogre2RenderTexture, Ogre2RenderWindow, Ogre2SegmentationCamera, Ogre2ThermalCamera, Ogre2WideAngleCamera, OgreRenderTarget, and Ogre2RenderTarget.
◆ 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 BaseCamera< T >, BaseCamera< Ogre2Sensor >, BaseCamera< OgreSensor >, BaseRenderTarget< T >, BaseRenderTarget< Ogre2Object >, BaseRenderTarget< OgreObject >, OgreDepthCamera, OgreGpuRays, OgreLensFlarePass, OgreRenderTarget, OgreRenderTexture, OgreThermalCamera, OgreWideAngleCamera, Ogre2BoundingBoxCamera, Ogre2DepthCamera, Ogre2GpuRays, Ogre2LensFlarePass, Ogre2RenderTarget, Ogre2RenderTexture, Ogre2SegmentationCamera, Ogre2ThermalCamera, Ogre2WideAngleCamera, and Camera.
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 BaseGrid< T >, BaseGrid< Ogre2Geometry >, BaseGrid< OgreGeometry >, BaseWireBox< T >, BaseWireBox< Ogre2Geometry >, BaseWireBox< OgreGeometry >, OgreGrid, Ogre2Grid, BaseCamera< T >, BaseCamera< Ogre2Sensor >, BaseCamera< OgreSensor >, BaseCOMVisual< T >, BaseCOMVisual< Ogre2Visual >, BaseCOMVisual< OgreVisual >, BaseGizmoVisual< T >, BaseGizmoVisual< Ogre2Visual >, BaseGizmoVisual< OgreVisual >, BaseHeightmap< T >, BaseHeightmap< Ogre2Geometry >, BaseHeightmap< OgreGeometry >, BaseInertiaVisual< T >, BaseInertiaVisual< Ogre2Visual >, BaseInertiaVisual< OgreVisual >, BaseJointVisual< T >, BaseJointVisual< Ogre2Visual >, BaseJointVisual< OgreVisual >, BaseLidarVisual< T >, BaseLidarVisual< Ogre2Visual >, BaseLidarVisual< OgreVisual >, BaseLightVisual< T >, BaseLightVisual< Ogre2Visual >, BaseLightVisual< OgreVisual >, BaseMarker< T >, BaseMarker< Ogre2Geometry >, BaseMarker< OgreGeometry >, BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, BaseMesh< T >, BaseMesh< Ogre2Geometry >, BaseMesh< OgreGeometry >, BaseSubMesh< T >, BaseSubMesh< Ogre2Object >, BaseSubMesh< OgreObject >, BaseNode< T >, BaseNode< Ogre2Object >, BaseNode< OgreObject >, BaseParticleEmitter< T >, BaseParticleEmitter< Ogre2Visual >, BaseParticleEmitter< OgreVisual >, BaseRenderTarget< T >, BaseRenderTarget< Ogre2Object >, BaseRenderTarget< OgreObject >, BaseText< T >, BaseText< OgreGeometry >, BaseVisual< T >, BaseVisual< Ogre2Node >, BaseVisual< OgreNode >, OgreCapsule, OgreCOMVisual, OgreDepthCamera, OgreDistortionPass, OgreGaussianNoisePass, OgreGpuRays, OgreHeightmap, OgreInertiaVisual, OgreLidarVisual, OgreLightVisual, OgreMarker, OgreMaterial, OgreProjector, OgreRenderTarget, OgreRenderTexture, OgreText, OgreThermalCamera, OgreWideAngleCamera, OgreWireBox, Ogre2BoundingBoxCamera, Ogre2Capsule, Ogre2COMVisual, Ogre2DepthCamera, Ogre2GpuRays, Ogre2Heightmap, Ogre2InertiaVisual, Ogre2LidarVisual, Ogre2LightVisual, Ogre2Marker, Ogre2Material, Ogre2ParticleEmitter, Ogre2Projector, Ogre2RenderTarget, Ogre2RenderTexture, Ogre2SegmentationCamera, Ogre2ThermalCamera, Ogre2WideAngleCamera, Ogre2WireBox, and RenderTarget.
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: