Gazebo Rendering

API Reference

6.6.3

Ogre2.x implementation of the scene class. More...

#include <Ogre2Scene.hh>

Public Member Functions

virtual ~Ogre2Scene ()
 Destructor. More...
 
virtual math::Color AmbientLight () const override
 
virtual uint8_t CameraPassCountPerGpuFlush () const override
 
virtual void Clear () override
 
void ClearMaterialsCache (const std::string &_name)
 Remove internal material cache for a specific material. More...
 
virtual void Destroy () override
 
virtual RenderEngineEngine () const override
 
virtual void Fini () override
 
const std::vector< std::weak_ptr< Ogre2Heightmap > > & Heightmaps () const
 
virtual bool LegacyAutoGpuFlush () const override
 
virtual Ogre::SceneManager * OgreSceneManager () const
 Get a pointer to the ogre scene manager. More...
 
virtual void PostRender () override
 
virtual void PreRender () override
 
virtual VisualPtr RootVisual () const override
 
virtual void SetAmbientLight (const math::Color &_color) override
 
virtual void SetCameraPassCountPerGpuFlush (uint8_t _numPass) override
 
virtual void SetSkyEnabled (bool _enabled) override
 
virtual void SetTime (const std::chrono::steady_clock::duration &_time) override
 
virtual bool SkyEnabled () const override
 
void UpdateAllHeightmaps (Ogre::Camera *_camera)
 
- Public Member Functions inherited from BaseScene
virtual ~BaseScene ()
 
virtual math::Color BackgroundColor () const override
 
virtual MaterialPtr BackgroundMaterial () const override
 
virtual ArrowVisualPtr CreateArrowVisual () override
 
virtual ArrowVisualPtr CreateArrowVisual (const std::string &_name) override
 
virtual ArrowVisualPtr CreateArrowVisual (unsigned int _id) override
 
virtual ArrowVisualPtr CreateArrowVisual (unsigned int _id, const std::string &_name) override
 
virtual AxisVisualPtr CreateAxisVisual () override
 
virtual AxisVisualPtr CreateAxisVisual (const std::string &_name) override
 
virtual AxisVisualPtr CreateAxisVisual (unsigned int _id) override
 
virtual AxisVisualPtr CreateAxisVisual (unsigned int _id, const std::string &_name) override
 
virtual BoundingBoxCameraPtr CreateBoundingBoxCamera () override
 
virtual BoundingBoxCameraPtr CreateBoundingBoxCamera (const std::string &_name) override
 
virtual BoundingBoxCameraPtr CreateBoundingBoxCamera (const unsigned int _id) override
 
virtual BoundingBoxCameraPtr CreateBoundingBoxCamera (const unsigned int _id, const std::string &_name) override
 
virtual GeometryPtr CreateBox () override
 
virtual CameraPtr CreateCamera () override
 
virtual CameraPtr CreateCamera (const std::string &_name) override
 
virtual CameraPtr CreateCamera (unsigned int _id) override
 
virtual CameraPtr CreateCamera (unsigned int _id, const std::string &_name) override
 
virtual CapsulePtr CreateCapsule () override
 
virtual COMVisualPtr CreateCOMVisual () override
 
virtual COMVisualPtr CreateCOMVisual (const std::string &_name) override
 
virtual COMVisualPtr CreateCOMVisual (unsigned int _id) override
 
virtual COMVisualPtr CreateCOMVisual (unsigned int _id, const std::string &_name) override
 
virtual GeometryPtr CreateCone () override
 
virtual GeometryPtr CreateCylinder () override
 
virtual DepthCameraPtr CreateDepthCamera () override
 
virtual DepthCameraPtr CreateDepthCamera (const std::string &_name) override
 
virtual DepthCameraPtr CreateDepthCamera (const unsigned int _id) override
 
virtual DepthCameraPtr CreateDepthCamera (const unsigned int _id, const std::string &_name) override
 
virtual DirectionalLightPtr CreateDirectionalLight () override
 
virtual DirectionalLightPtr CreateDirectionalLight (const std::string &_name) override
 
virtual DirectionalLightPtr CreateDirectionalLight (unsigned int _id) override
 
virtual DirectionalLightPtr CreateDirectionalLight (unsigned int _id, const std::string &_name) override
 
virtual GizmoVisualPtr CreateGizmoVisual () override
 
virtual GizmoVisualPtr CreateGizmoVisual (const std::string &_name) override
 
virtual GizmoVisualPtr CreateGizmoVisual (unsigned int _id) override
 
virtual GizmoVisualPtr CreateGizmoVisual (unsigned int _id, const std::string &_name) override
 
virtual GpuRaysPtr CreateGpuRays () override
 
virtual GpuRaysPtr CreateGpuRays (const std::string &_name) override
 
virtual GpuRaysPtr CreateGpuRays (const unsigned int _id) override
 
virtual GpuRaysPtr CreateGpuRays (const unsigned int _id, const std::string &_name) override
 
virtual GridPtr CreateGrid () override
 
virtual HeightmapPtr CreateHeightmap (const HeightmapDescriptor &_desc) override
 
virtual InertiaVisualPtr CreateInertiaVisual () override
 
virtual InertiaVisualPtr CreateInertiaVisual (const std::string &_name) override
 
virtual InertiaVisualPtr CreateInertiaVisual (unsigned int _id) override
 
virtual InertiaVisualPtr CreateInertiaVisual (unsigned int _id, const std::string &_name) override
 
virtual JointVisualPtr CreateJointVisual () override
 
virtual JointVisualPtr CreateJointVisual (const std::string &_name) override
 
virtual JointVisualPtr CreateJointVisual (unsigned int _id) override
 
virtual JointVisualPtr CreateJointVisual (unsigned int _id, const std::string &_name) override
 
virtual LidarVisualPtr CreateLidarVisual () override
 
virtual LidarVisualPtr CreateLidarVisual (const std::string &_name) override
 
virtual LidarVisualPtr CreateLidarVisual (unsigned int _id) override
 
virtual LidarVisualPtr CreateLidarVisual (unsigned int _id, const std::string &_name) override
 
virtual LightVisualPtr CreateLightVisual () override
 
virtual LightVisualPtr CreateLightVisual (const std::string &_name) override
 
virtual LightVisualPtr CreateLightVisual (unsigned int _id) override
 
virtual LightVisualPtr CreateLightVisual (unsigned int _id, const std::string &_name) override
 
virtual MarkerPtr CreateMarker () override
 
virtual MaterialPtr CreateMaterial (const common::Material &_material) override
 
virtual MaterialPtr CreateMaterial (const std::string &_name="") override
 
virtual MeshPtr CreateMesh (const common::Mesh *_mesh) override
 
virtual MeshPtr CreateMesh (const MeshDescriptor &_desc) override
 
virtual MeshPtr CreateMesh (const std::string &_meshName) override
 
virtual ParticleEmitterPtr CreateParticleEmitter () override
 
virtual ParticleEmitterPtr CreateParticleEmitter (const std::string &_name) override
 
virtual ParticleEmitterPtr CreateParticleEmitter (unsigned int _id) override
 
virtual ParticleEmitterPtr CreateParticleEmitter (unsigned int _id, const std::string &_name) override
 
virtual GeometryPtr CreatePlane () override
 
virtual PointLightPtr CreatePointLight () override
 
virtual PointLightPtr CreatePointLight (const std::string &_name) override
 
virtual PointLightPtr CreatePointLight (unsigned int _id) override
 
virtual PointLightPtr CreatePointLight (unsigned int _id, const std::string &_name) override
 
virtual RayQueryPtr CreateRayQuery () override
 
virtual RenderTexturePtr CreateRenderTexture () override
 
virtual RenderWindowPtr CreateRenderWindow () override
 
virtual SegmentationCameraPtr CreateSegmentationCamera () override
 
virtual SegmentationCameraPtr CreateSegmentationCamera (const std::string &_name) override
 
virtual SegmentationCameraPtr CreateSegmentationCamera (const unsigned int _id) override
 
virtual SegmentationCameraPtr CreateSegmentationCamera (const unsigned int _id, const std::string &_name) override
 
virtual GeometryPtr CreateSphere () override
 
virtual SpotLightPtr CreateSpotLight () override
 
virtual SpotLightPtr CreateSpotLight (const std::string &_name) override
 
virtual SpotLightPtr CreateSpotLight (unsigned int _id) override
 
virtual SpotLightPtr CreateSpotLight (unsigned int _id, const std::string &_name) override
 
virtual TextPtr CreateText () override
 
virtual ThermalCameraPtr CreateThermalCamera () override
 
virtual ThermalCameraPtr CreateThermalCamera (const std::string &_name) override
 
virtual ThermalCameraPtr CreateThermalCamera (const unsigned int _id) override
 
virtual ThermalCameraPtr CreateThermalCamera (const unsigned int _id, const std::string &_name) override
 
virtual VisualPtr CreateVisual () override
 
virtual VisualPtr CreateVisual (const std::string &_name) override
 
virtual VisualPtr CreateVisual (unsigned int _id) override
 
virtual VisualPtr CreateVisual (unsigned int _id, const std::string &_name) override
 
virtual WireBoxPtr CreateWireBox () override
 
virtual void DestroyLight (LightPtr _light, bool _recursive=false) override
 
virtual void DestroyLightById (unsigned int _id) override
 
virtual void DestroyLightByIndex (unsigned int _index) override
 
virtual void DestroyLightByName (const std::string &_name) override
 
virtual void DestroyLights () override
 
virtual void DestroyMaterial (MaterialPtr _material) override
 
virtual void DestroyMaterials () override
 
virtual void DestroyNode (NodePtr _node, bool _recursive=false) override
 
virtual void DestroyNodeById (unsigned int _id) override
 
virtual void DestroyNodeByIndex (unsigned int _index) override
 
virtual void DestroyNodeByName (const std::string &_name) override
 
virtual void DestroyNodes () override
 
virtual void DestroySensor (SensorPtr _sensor, bool _recursive=false) override
 
virtual void DestroySensorById (unsigned int _id) override
 
virtual void DestroySensorByIndex (unsigned int _index) override
 
virtual void DestroySensorByName (const std::string &_name) override
 
virtual void DestroySensors () override
 
virtual void DestroyVisual (VisualPtr _visual, bool _recursive=false) override
 
virtual void DestroyVisualById (unsigned int _id) override
 
virtual void DestroyVisualByIndex (unsigned int _index) override
 
virtual void DestroyVisualByName (const std::string &_name) override
 
virtual void DestroyVisuals () override
 
virtual std::array< math::Color, 4 > GradientBackgroundColor () const override
 
virtual bool HasLight (ConstLightPtr _light) const override
 
virtual bool HasLightId (unsigned int _id) const override
 
virtual bool HasLightName (const std::string &_name) const override
 
virtual bool HasNode (ConstNodePtr _node) const override
 
virtual bool HasNodeId (unsigned int _id) const override
 
virtual bool HasNodeName (const std::string &_name) const override
 
virtual bool HasSensor (ConstSensorPtr _sensor) const override
 
virtual bool HasSensorId (unsigned int _id) const override
 
virtual bool HasSensorName (const std::string &_name) const override
 
virtual bool HasVisual (ConstVisualPtr _visual) const override
 
virtual bool HasVisualId (unsigned int _id) const override
 
virtual bool HasVisualName (const std::string &_name) const override
 
virtual unsigned int Id () const override
 
virtual void Init () override
 
virtual bool IsGradientBackgroundColor () const override
 
virtual bool IsInitialized () const override
 
virtual bool IsLoaded () const
 
virtual LightPtr LightById (unsigned int _id) const override
 
virtual LightPtr LightByIndex (unsigned int _index) const override
 
virtual LightPtr LightByName (const std::string &_name) const override
 
virtual unsigned int LightCount () const override
 
virtual void Load () override
 
virtual MaterialPtr Material (const std::string &_name) const override
 
virtual bool MaterialRegistered (const std::string &_name) const override
 
virtual std::string Name () const override
 
virtual NodePtr NodeById (unsigned int _id) const override
 
virtual NodePtr NodeByIndex (unsigned int _index) const override
 
virtual NodePtr NodeByName (const std::string &_name) const override
 
virtual unsigned int NodeCount () const override
 
virtual void RegisterMaterial (const std::string &_name, MaterialPtr _material) override
 
virtual void RemoveGradientBackgroundColor () override
 
virtual SensorPtr SensorById (unsigned int _id) const override
 
virtual SensorPtr SensorByIndex (unsigned int _index) const override
 
virtual SensorPtr SensorByName (const std::string &_name) const override
 
virtual unsigned int SensorCount () const override
 
virtual void SetAmbientLight (double _r, double _g, double _b, double _a=1.0) override
 
virtual void SetBackgroundColor (const math::Color &_color) override
 
virtual void SetBackgroundColor (double _r, double _g, double _b, double _a=1.0) override
 
virtual void SetBackgroundMaterial (MaterialPtr _material) override
 
virtual void SetGradientBackgroundColor (const std::array< math::Color, 4 > &_colors) override
 
virtual void SetSimTime (const common::Time &_time) override
 
virtual common::Time SimTime () const override
 
virtual std::chrono::steady_clock::duration Time () const override
 
virtual void UnregisterMaterial (const std::string &_name) override
 
virtual void UnregisterMaterials () override
 
virtual VisualPtr VisualAt (const CameraPtr &_camera, const gz::math::Vector2i &_mousePos) override
 
virtual VisualPtr VisualById (unsigned int _id) const override
 
virtual VisualPtr VisualByIndex (unsigned int _index) const override
 
virtual VisualPtr VisualByName (const std::string &_name) const override
 
virtual unsigned int VisualCount () const override
 

Protected Member Functions

 Ogre2Scene (unsigned int _id, const std::string &_name)
 Constructor. More...
 
virtual ArrowVisualPtr CreateArrowVisualImpl (unsigned int _id, const std::string &_name) override
 
virtual AxisVisualPtr CreateAxisVisualImpl (unsigned int _id, const std::string &_name) override
 
virtual BoundingBoxCameraPtr CreateBoundingBoxCameraImpl (unsigned int _id, const std::string &_name) override
 Implementation for creating a BoundingBox camera. More...
 
virtual GeometryPtr CreateBoxImpl (unsigned int _id, const std::string &_name) override
 
virtual CameraPtr CreateCameraImpl (unsigned int _id, const std::string &_name) override
 
virtual CapsulePtr CreateCapsuleImpl (unsigned int _id, const std::string &_name) override
 Implementation for creating a capsule geometry object. More...
 
virtual COMVisualPtr CreateCOMVisualImpl (unsigned int _id, const std::string &_name) override
 Implementation for creating CoM visual. More...
 
virtual GeometryPtr CreateConeImpl (unsigned int _id, const std::string &_name) override
 
virtual GeometryPtr CreateCylinderImpl (unsigned int _id, const std::string &_name) override
 
virtual DepthCameraPtr CreateDepthCameraImpl (unsigned int _id, const std::string &_name) override
 
virtual DirectionalLightPtr CreateDirectionalLightImpl (unsigned int _id, const std::string &_name) override
 
virtual GizmoVisualPtr CreateGizmoVisualImpl (unsigned int _id, const std::string &_name) override
 Implementation for creating a GizmoVisual. More...
 
virtual GpuRaysPtr CreateGpuRaysImpl (unsigned int _id, const std::string &_name) override
 Implementation for creating GpuRays sensor. More...
 
virtual GridPtr CreateGridImpl (unsigned int _id, const std::string &_name) override
 Implementation for creating a grid geometry object. More...
 
virtual HeightmapPtr CreateHeightmapImpl (unsigned int _id, const std::string &_name, const HeightmapDescriptor &_desc) override
 Implementation for creating a heightmap geometry. More...
 
virtual InertiaVisualPtr CreateInertiaVisualImpl (unsigned int _id, const std::string &_name) override
 Implementation for creating Inertia visual. More...
 
virtual JointVisualPtr CreateJointVisualImpl (unsigned int _id, const std::string &_name) override
 Implementation for creating Joint visual. More...
 
virtual LidarVisualPtr CreateLidarVisualImpl (unsigned int _id, const std::string &_name) override
 Implementation for creating a lidar visual. More...
 
virtual LightVisualPtr CreateLightVisualImpl (unsigned int _id, const std::string &_name) override
 Implementation for creating Light visual. More...
 
virtual MarkerPtr CreateMarkerImpl (unsigned int _id, const std::string &_name) override
 Implementation for creating a marker geometry object. More...
 
virtual MaterialPtr CreateMaterialImpl (unsigned int _id, const std::string &_name) override
 
virtual MeshPtr CreateMeshImpl (unsigned int _id, const std::string &_name, const MeshDescriptor &_desc) override
 
virtual MeshPtr CreateMeshImpl (unsigned int _id, const std::string &_name, const std::string &_meshName)
 Create a mesh object based on its name. More...
 
virtual ParticleEmitterPtr CreateParticleEmitterImpl (unsigned int _id, const std::string &_name) override
 Implementation for creating a ParticleEmitter. More...
 
virtual GeometryPtr CreatePlaneImpl (unsigned int _id, const std::string &_name) override
 
virtual PointLightPtr CreatePointLightImpl (unsigned int _id, const std::string &_name) override
 
virtual RayQueryPtr CreateRayQueryImpl (unsigned int _id, const std::string &_name) override
 
virtual RenderTexturePtr CreateRenderTextureImpl (unsigned int _id, const std::string &_name) override
 
virtual RenderWindowPtr CreateRenderWindowImpl (unsigned int _id, const std::string &_name) override
 Render engine specific implementation for creating a render window. More...
 
virtual SegmentationCameraPtr CreateSegmentationCameraImpl (unsigned int _id, const std::string &_name) override
 Implementation for creating a segmentation camera. More...
 
virtual GeometryPtr CreateSphereImpl (unsigned int _id, const std::string &_name) override
 
virtual SpotLightPtr CreateSpotLightImpl (unsigned int _id, const std::string &_name) override
 
virtual TextPtr CreateTextImpl (unsigned int _id, const std::string &_name) override
 Implementation for creating a text's geometry object. More...
 
virtual ThermalCameraPtr CreateThermalCameraImpl (unsigned int _id, const std::string &_name) override
 Implementation for creating a thermal camera. More...
 
virtual VisualPtr CreateVisualImpl (unsigned int _id, const std::string &_name) override
 
virtual WireBoxPtr CreateWireBoxImpl (unsigned int _id, const std::string &_name) override
 Implementation for creating a wire box geometry. More...
 
virtual bool InitImpl () override
 
virtual bool InitObject (Ogre2ObjectPtr _object, unsigned int _id, const std::string &_name)
 Helper function to initialize an ogre2 object. More...
 
virtual LightStorePtr Lights () const override
 
virtual bool LoadImpl () override
 
virtual MaterialMapPtr Materials () const override
 
virtual SensorStorePtr Sensors () const override
 
void UpdateShadowNode ()
 Create a compositor shadow node with the same number of shadow textures as the number of shadow casting lights. More...
 
virtual VisualStorePtr Visuals () const override
 
- Protected Member Functions inherited from BaseScene
 BaseScene (unsigned int _id, const std::string &_name)
 
virtual unsigned int CreateObjectId ()
 
virtual std::string CreateObjectName (unsigned int _id, const std::string &_prefix)
 
virtual bool RegisterLight (LightPtr _light)
 
virtual bool RegisterSensor (SensorPtr _vensor)
 
virtual bool RegisterVisual (VisualPtr _visual)
 

Protected Attributes

std::vector< std::weak_ptr< Ogre2Heightmap > > heightmaps
 A list of ogre heightmaps. More...
 
Ogre2LightStorePtr lights
 A list of ogre lights. More...
 
Ogre2MaterialMapPtr materials
 A list of ogre materials. More...
 
Ogre2MeshFactoryPtr meshFactory
 Mesh factory for generating ogre meshes. More...
 
Ogre::SceneManager * ogreSceneManager = nullptr
 Pointer to the ogre scene manager. More...
 
Ogre2VisualPtr rootVisual
 Root visual in the scene. More...
 
Ogre2SensorStorePtr sensors
 A list of ogre sensors, e.g. cameras. More...
 
Ogre2VisualStorePtr visuals
 A list of ogre visuals. More...
 
- Protected Attributes inherited from BaseScene
math::Color backgroundColor
 Scene background color. Default should be black. More...
 
MaterialPtr backgroundMaterial
 Scene background material. More...
 
std::array< math::Color, 4 > gradientBackgroundColor
 The four corners of the gradient background color. Next is the description of how to interpret each value of the array: 0: Top left corner color. 1: Bottom left corner color. 2: Top right corner color. 3: Bottom right corner color. Default should be black. More...
 
unsigned int id
 
bool initialized
 
bool isGradientBackgroundColor = false
 Whether the scene has a gradient background. More...
 
bool loaded
 
std::string name
 
common::Time simTime
 
std::chrono::steady_clock::duration time
 

Detailed Description

Ogre2.x implementation of the scene class.

Constructor & Destructor Documentation

◆ Ogre2Scene()

Ogre2Scene ( unsigned int  _id,
const std::string _name 
)
protected

Constructor.

Parameters
[in]_idUnique scene Id
[in]_nameScene name

◆ ~Ogre2Scene()

virtual ~Ogre2Scene ( )
virtual

Destructor.

Member Function Documentation

◆ AmbientLight()

virtual math::Color AmbientLight ( ) const
overridevirtual

◆ CameraPassCountPerGpuFlush()

virtual uint8_t CameraPassCountPerGpuFlush ( ) const
overridevirtual

Reimplemented from BaseScene.

◆ Clear()

virtual void Clear ( )
overridevirtual

Reimplemented from BaseScene.

◆ ClearMaterialsCache()

void ClearMaterialsCache ( const std::string _name)

Remove internal material cache for a specific material.

Parameters
[in]_nameName of the template material to remove.

◆ CreateArrowVisualImpl()

virtual ArrowVisualPtr CreateArrowVisualImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implements BaseScene.

◆ CreateAxisVisualImpl()

virtual AxisVisualPtr CreateAxisVisualImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implements BaseScene.

◆ CreateBoundingBoxCameraImpl()

virtual BoundingBoxCameraPtr CreateBoundingBoxCameraImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implementation for creating a BoundingBox camera.

Parameters
[in]_idUnique id
[in]_nameName of BoundingBox camera
Returns
Pointer to BoundingBox camera

Reimplemented from BaseScene.

◆ CreateBoxImpl()

virtual GeometryPtr CreateBoxImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implements BaseScene.

◆ CreateCameraImpl()

virtual CameraPtr CreateCameraImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implements BaseScene.

◆ CreateCapsuleImpl()

virtual CapsulePtr CreateCapsuleImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implementation for creating a capsule geometry object.

Parameters
[in]_idunique object id.
[in]_nameunique object name.
Returns
Pointer to a capsule geometry object

Implements BaseScene.

◆ CreateCOMVisualImpl()

virtual COMVisualPtr CreateCOMVisualImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implementation for creating CoM visual.

Parameters
[in]_idUnique id
[in]_nameName of CoM visual
Returns
Pointer to a CoM visual object

Implements BaseScene.

◆ CreateConeImpl()

virtual GeometryPtr CreateConeImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implements BaseScene.

◆ CreateCylinderImpl()

virtual GeometryPtr CreateCylinderImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implements BaseScene.

◆ CreateDepthCameraImpl()

virtual DepthCameraPtr CreateDepthCameraImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implements BaseScene.

◆ CreateDirectionalLightImpl()

virtual DirectionalLightPtr CreateDirectionalLightImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implements BaseScene.

◆ CreateGizmoVisualImpl()

virtual GizmoVisualPtr CreateGizmoVisualImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implementation for creating a GizmoVisual.

Parameters
[in]_idUnique id
[in]_nameName of GizmoVisual

Reimplemented from BaseScene.

◆ CreateGpuRaysImpl()

virtual GpuRaysPtr CreateGpuRaysImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implementation for creating GpuRays sensor.

Parameters
[in]_idUnique id
[in]_nameName of GpuRays sensor

Reimplemented from BaseScene.

◆ CreateGridImpl()

virtual GridPtr CreateGridImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implementation for creating a grid geometry object.

Parameters
[in]_idunique object id.
[in]_nameunique object name.
Returns
Pointer to a grid geometry object

Implements BaseScene.

◆ CreateHeightmapImpl()

virtual HeightmapPtr CreateHeightmapImpl ( unsigned int  _id,
const std::string _name,
const HeightmapDescriptor _desc 
)
overrideprotectedvirtual

Implementation for creating a heightmap geometry.

Parameters
[in]_idUnique object id.
[in]_nameUnique object name.
[in]_descHeightmap descriptor.
Returns
Pointer to a heightmap geometry.

Implements BaseScene.

◆ CreateInertiaVisualImpl()

virtual InertiaVisualPtr CreateInertiaVisualImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implementation for creating Inertia visual.

Parameters
[in]_idUnique id
[in]_nameName of inertia visual
Returns
Pointer to a inertia visual object

Implements BaseScene.

◆ CreateJointVisualImpl()

virtual JointVisualPtr CreateJointVisualImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implementation for creating Joint visual.

Parameters
[in]_idUnique id
[in]_nameName of Joint visual
Returns
Pointer to a joint visual object

Implements BaseScene.

◆ CreateLidarVisualImpl()

virtual LidarVisualPtr CreateLidarVisualImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implementation for creating a lidar visual.

Parameters
[in]_idunique object id.
[in]_nameunique object name.
Returns
Pointer to a lidar visual

Implements BaseScene.

◆ CreateLightVisualImpl()

virtual LightVisualPtr CreateLightVisualImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implementation for creating Light visual.

Parameters
[in]_idUnique id
[in]_nameName of light visual
Returns
Pointer to a light visual object

Implements BaseScene.

◆ CreateMarkerImpl()

virtual MarkerPtr CreateMarkerImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implementation for creating a marker geometry object.

Parameters
[in]_idunique object id.
[in]_nameunique object name.
Returns
Pointer to a marker geometry object

Implements BaseScene.

◆ CreateMaterialImpl()

virtual MaterialPtr CreateMaterialImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implements BaseScene.

◆ CreateMeshImpl() [1/2]

virtual MeshPtr CreateMeshImpl ( unsigned int  _id,
const std::string _name,
const MeshDescriptor _desc 
)
overrideprotectedvirtual

Implements BaseScene.

◆ CreateMeshImpl() [2/2]

virtual MeshPtr CreateMeshImpl ( unsigned int  _id,
const std::string _name,
const std::string _meshName 
)
protectedvirtual

Create a mesh object based on its name.

Parameters
[in]_idUnique Id to assign to the mesh
[in]_nameName to assign to the mesh
[in]_meshNameName of the mesh to create

◆ CreateParticleEmitterImpl()

virtual ParticleEmitterPtr CreateParticleEmitterImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implementation for creating a ParticleEmitter.

Parameters
[in]_idUnique id.
[in]_nameName of ParticleEmitter.
Returns
Pointer to the created particle emitter.

Reimplemented from BaseScene.

◆ CreatePlaneImpl()

virtual GeometryPtr CreatePlaneImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implements BaseScene.

◆ CreatePointLightImpl()

virtual PointLightPtr CreatePointLightImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implements BaseScene.

◆ CreateRayQueryImpl()

virtual RayQueryPtr CreateRayQueryImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implements BaseScene.

◆ CreateRenderTextureImpl()

virtual RenderTexturePtr CreateRenderTextureImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implements BaseScene.

◆ CreateRenderWindowImpl()

virtual RenderWindowPtr CreateRenderWindowImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Render engine specific implementation for creating a render window.

Parameters
[in]_idunique object id
[in]_nameobject name
Returns
Pointer to the created render window.

Implements BaseScene.

◆ CreateSegmentationCameraImpl()

virtual SegmentationCameraPtr CreateSegmentationCameraImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implementation for creating a segmentation camera.

Parameters
[in]_idUnique id
[in]_nameName of segmentation camera
Returns
Pointer to segmentation camera

Reimplemented from BaseScene.

◆ CreateSphereImpl()

virtual GeometryPtr CreateSphereImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implements BaseScene.

◆ CreateSpotLightImpl()

virtual SpotLightPtr CreateSpotLightImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implements BaseScene.

◆ CreateTextImpl()

virtual TextPtr CreateTextImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implementation for creating a text's geometry object.

Parameters
[in]_idunique object id.
[in]_nameunique object name.
Returns
Pointer to a text geometry object

Reimplemented from BaseScene.

◆ CreateThermalCameraImpl()

virtual ThermalCameraPtr CreateThermalCameraImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implementation for creating a thermal camera.

Parameters
[in]_idUnique id
[in]_nameName of thermal camera

Reimplemented from BaseScene.

◆ CreateVisualImpl()

virtual VisualPtr CreateVisualImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implements BaseScene.

◆ CreateWireBoxImpl()

virtual WireBoxPtr CreateWireBoxImpl ( unsigned int  _id,
const std::string _name 
)
overrideprotectedvirtual

Implementation for creating a wire box geometry.

Parameters
[in]_idunique object id.
[in]_nameunique object name.
Returns
Pointer to a wire box geometry object

Implements BaseScene.

◆ Destroy()

virtual void Destroy ( )
overridevirtual

Reimplemented from BaseScene.

◆ Engine()

virtual RenderEngine* Engine ( ) const
overridevirtual

◆ Fini()

virtual void Fini ( )
overridevirtual

Reimplemented from BaseScene.

◆ Heightmaps()

const std::vector<std::weak_ptr<Ogre2Heightmap> >& Heightmaps ( ) const

◆ InitImpl()

virtual bool InitImpl ( )
overrideprotectedvirtual

Implements BaseScene.

◆ InitObject()

virtual bool InitObject ( Ogre2ObjectPtr  _object,
unsigned int  _id,
const std::string _name 
)
protectedvirtual

Helper function to initialize an ogre2 object.

Parameters
[in]_objectOgre2 object that will be initialized
[in]_idUnique Id to assign to the object
[in]_nameName to assign to the object

◆ LegacyAutoGpuFlush()

virtual bool LegacyAutoGpuFlush ( ) const
overridevirtual

Reimplemented from BaseScene.

◆ Lights()

virtual LightStorePtr Lights ( ) const
overrideprotectedvirtual

Implements BaseScene.

◆ LoadImpl()

virtual bool LoadImpl ( )
overrideprotectedvirtual

Implements BaseScene.

◆ Materials()

virtual MaterialMapPtr Materials ( ) const
overrideprotectedvirtual

Implements BaseScene.

◆ OgreSceneManager()

virtual Ogre::SceneManager* OgreSceneManager ( ) const
virtual

Get a pointer to the ogre scene manager.

Returns
Pointer to the ogre scene manager

◆ PostRender()

virtual void PostRender ( )
overridevirtual

Reimplemented from BaseScene.

◆ PreRender()

virtual void PreRender ( )
overridevirtual

Reimplemented from BaseScene.

◆ RootVisual()

virtual VisualPtr RootVisual ( ) const
overridevirtual

◆ Sensors()

virtual SensorStorePtr Sensors ( ) const
overrideprotectedvirtual

Implements BaseScene.

◆ SetAmbientLight()

virtual void SetAmbientLight ( const math::Color _color)
overridevirtual

Implements BaseScene.

◆ SetCameraPassCountPerGpuFlush()

virtual void SetCameraPassCountPerGpuFlush ( uint8_t  _numPass)
overridevirtual

Reimplemented from BaseScene.

◆ SetSkyEnabled()

virtual void SetSkyEnabled ( bool  _enabled)
overridevirtual

Reimplemented from BaseScene.

◆ SetTime()

virtual void SetTime ( const std::chrono::steady_clock::duration &  _time)
overridevirtual

Reimplemented from BaseScene.

◆ SkyEnabled()

virtual bool SkyEnabled ( ) const
overridevirtual

Reimplemented from BaseScene.

◆ UpdateAllHeightmaps()

void UpdateAllHeightmaps ( Ogre::Camera *  _camera)

◆ UpdateShadowNode()

void UpdateShadowNode ( )
protected

Create a compositor shadow node with the same number of shadow textures as the number of shadow casting lights.

◆ Visuals()

virtual VisualStorePtr Visuals ( ) const
overrideprotectedvirtual

Implements BaseScene.

Member Data Documentation

◆ heightmaps

std::vector<std::weak_ptr<Ogre2Heightmap> > heightmaps
protected

A list of ogre heightmaps.

◆ lights

Ogre2LightStorePtr lights
protected

A list of ogre lights.

◆ materials

Ogre2MaterialMapPtr materials
protected

A list of ogre materials.

◆ meshFactory

Ogre2MeshFactoryPtr meshFactory
protected

Mesh factory for generating ogre meshes.

◆ ogreSceneManager

Ogre::SceneManager* ogreSceneManager = nullptr
protected

Pointer to the ogre scene manager.

◆ rootVisual

Ogre2VisualPtr rootVisual
protected

Root visual in the scene.

◆ sensors

Ogre2SensorStorePtr sensors
protected

A list of ogre sensors, e.g. cameras.

◆ visuals

Ogre2VisualStorePtr visuals
protected

A list of ogre visuals.


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