Gazebo Rendering

API Reference

3.7.2
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
BaseScene Class Referenceabstract

#include <BaseScene.hh>

Public Member Functions

virtual ~BaseScene ()
 
virtual math::Color BackgroundColor () const override
 
virtual void Clear () 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 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 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 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 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 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 void Destroy () 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 void Fini () 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 PreRender () 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 (const math::Color &_color) override=0
 
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 SetGradientBackgroundColor (const std::array< math::Color, 4 > &_colors) override
 
virtual void SetSimTime (const common::Time &_time) override
 
virtual common::Time SimTime () 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

 BaseScene (unsigned int _id, const std::string &_name)
 
virtual ArrowVisualPtr CreateArrowVisualImpl (unsigned int _id, const std::string &_name)=0
 
virtual AxisVisualPtr CreateAxisVisualImpl (unsigned int _id, const std::string &_name)=0
 
virtual GeometryPtr CreateBoxImpl (unsigned int _id, const std::string &_name)=0
 
virtual CameraPtr CreateCameraImpl (unsigned int _id, const std::string &_name)=0
 
virtual GeometryPtr CreateConeImpl (unsigned int _id, const std::string &_name)=0
 
virtual GeometryPtr CreateCylinderImpl (unsigned int _id, const std::string &_name)=0
 
virtual DepthCameraPtr CreateDepthCameraImpl (unsigned int _id, const std::string &_name)=0
 
virtual DirectionalLightPtr CreateDirectionalLightImpl (unsigned int _id, const std::string &_name)=0
 
virtual GizmoVisualPtr CreateGizmoVisualImpl (unsigned int _id, const std::string &_name)
 Implementation for creating a GizmoVisual. More...
 
virtual GpuRaysPtr CreateGpuRaysImpl (unsigned int _id, const std::string &_name)
 Implementation for creating GpuRays sensor. More...
 
virtual GridPtr CreateGridImpl (unsigned int _id, const std::string &_name)=0
 Implementation for creating a grid geometry object. More...
 
virtual MarkerPtr CreateMarkerImpl (unsigned int _id, const std::string &_name)=0
 Implementation for creating a marker geometry object. More...
 
virtual MaterialPtr CreateMaterialImpl (unsigned int _id, const std::string &_name)=0
 
virtual MeshPtr CreateMeshImpl (unsigned int _id, const std::string &_name, const MeshDescriptor &_desc)=0
 
virtual unsigned int CreateObjectId ()
 
virtual std::string CreateObjectName (unsigned int _id, const std::string &_prefix)
 
virtual GeometryPtr CreatePlaneImpl (unsigned int _id, const std::string &_name)=0
 
virtual PointLightPtr CreatePointLightImpl (unsigned int _id, const std::string &_name)=0
 
virtual RayQueryPtr CreateRayQueryImpl (unsigned int _id, const std::string &_name)=0
 
virtual RenderTexturePtr CreateRenderTextureImpl (unsigned int _id, const std::string &_name)=0
 
virtual RenderWindowPtr CreateRenderWindowImpl (unsigned int _id, const std::string &_name)=0
 Render engine specific implementation for creating a render window. More...
 
virtual GeometryPtr CreateSphereImpl (unsigned int _id, const std::string &_name)=0
 
virtual SpotLightPtr CreateSpotLightImpl (unsigned int _id, const std::string &_name)=0
 
virtual TextPtr CreateTextImpl (unsigned int _id, const std::string &_name)
 Implementation for creating a text's geometry object. More...
 
virtual ThermalCameraPtr CreateThermalCameraImpl (unsigned int _id, const std::string &_name)
 Implementation for creating a thermal camera. More...
 
virtual VisualPtr CreateVisualImpl (unsigned int _id, const std::string &_name)=0
 
virtual bool InitImpl ()=0
 
virtual LightStorePtr Lights () const =0
 
virtual bool LoadImpl ()=0
 
virtual MaterialMapPtr Materials () const =0
 
virtual bool RegisterLight (LightPtr _light)
 
virtual bool RegisterSensor (SensorPtr _vensor)
 
virtual bool RegisterVisual (VisualPtr _visual)
 
virtual SensorStorePtr Sensors () const =0
 
virtual VisualStorePtr Visuals () const =0
 

Protected Attributes

math::Color backgroundColor
 Scene background color. Default should be black. 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
 

Constructor & Destructor Documentation

◆ BaseScene()

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

◆ ~BaseScene()

virtual ~BaseScene ( )
virtual

Member Function Documentation

◆ BackgroundColor()

virtual math::Color BackgroundColor ( ) const
overridevirtual

◆ Clear()

virtual void Clear ( )
overridevirtual

Reimplemented in Ogre2Scene, and OgreScene.

◆ CreateArrowVisual() [1/4]

virtual ArrowVisualPtr CreateArrowVisual ( )
overridevirtual

◆ CreateArrowVisual() [2/4]

virtual ArrowVisualPtr CreateArrowVisual ( const std::string &  _name)
overridevirtual

◆ CreateArrowVisual() [3/4]

virtual ArrowVisualPtr CreateArrowVisual ( unsigned int  _id)
overridevirtual

◆ CreateArrowVisual() [4/4]

virtual ArrowVisualPtr CreateArrowVisual ( unsigned int  _id,
const std::string &  _name 
)
overridevirtual

◆ CreateArrowVisualImpl()

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

Implemented in Ogre2Scene, and OgreScene.

◆ CreateAxisVisual() [1/4]

virtual AxisVisualPtr CreateAxisVisual ( )
overridevirtual

◆ CreateAxisVisual() [2/4]

virtual AxisVisualPtr CreateAxisVisual ( const std::string &  _name)
overridevirtual

◆ CreateAxisVisual() [3/4]

virtual AxisVisualPtr CreateAxisVisual ( unsigned int  _id)
overridevirtual

◆ CreateAxisVisual() [4/4]

virtual AxisVisualPtr CreateAxisVisual ( unsigned int  _id,
const std::string &  _name 
)
overridevirtual

◆ CreateAxisVisualImpl()

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

Implemented in Ogre2Scene, and OgreScene.

◆ CreateBox()

virtual GeometryPtr CreateBox ( )
overridevirtual

◆ CreateBoxImpl()

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

Implemented in Ogre2Scene, and OgreScene.

◆ CreateCamera() [1/4]

virtual CameraPtr CreateCamera ( )
overridevirtual

◆ CreateCamera() [2/4]

virtual CameraPtr CreateCamera ( const std::string &  _name)
overridevirtual

◆ CreateCamera() [3/4]

virtual CameraPtr CreateCamera ( unsigned int  _id)
overridevirtual

◆ CreateCamera() [4/4]

virtual CameraPtr CreateCamera ( unsigned int  _id,
const std::string &  _name 
)
overridevirtual

◆ CreateCameraImpl()

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

Implemented in Ogre2Scene, and OgreScene.

◆ CreateCone()

virtual GeometryPtr CreateCone ( )
overridevirtual

◆ CreateConeImpl()

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

Implemented in Ogre2Scene, and OgreScene.

◆ CreateCylinder()

virtual GeometryPtr CreateCylinder ( )
overridevirtual

◆ CreateCylinderImpl()

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

Implemented in Ogre2Scene, and OgreScene.

◆ CreateDepthCamera() [1/4]

virtual DepthCameraPtr CreateDepthCamera ( )
overridevirtual

◆ CreateDepthCamera() [2/4]

virtual DepthCameraPtr CreateDepthCamera ( const std::string &  _name)
overridevirtual

◆ CreateDepthCamera() [3/4]

virtual DepthCameraPtr CreateDepthCamera ( const unsigned int  _id)
overridevirtual

◆ CreateDepthCamera() [4/4]

virtual DepthCameraPtr CreateDepthCamera ( const unsigned int  _id,
const std::string &  _name 
)
overridevirtual

◆ CreateDepthCameraImpl()

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

Implemented in Ogre2Scene, and OgreScene.

◆ CreateDirectionalLight() [1/4]

virtual DirectionalLightPtr CreateDirectionalLight ( )
overridevirtual

◆ CreateDirectionalLight() [2/4]

virtual DirectionalLightPtr CreateDirectionalLight ( const std::string &  _name)
overridevirtual

◆ CreateDirectionalLight() [3/4]

virtual DirectionalLightPtr CreateDirectionalLight ( unsigned int  _id)
overridevirtual

◆ CreateDirectionalLight() [4/4]

virtual DirectionalLightPtr CreateDirectionalLight ( unsigned int  _id,
const std::string &  _name 
)
overridevirtual

◆ CreateDirectionalLightImpl()

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

Implemented in Ogre2Scene, and OgreScene.

◆ CreateGizmoVisual() [1/4]

virtual GizmoVisualPtr CreateGizmoVisual ( )
overridevirtual

◆ CreateGizmoVisual() [2/4]

virtual GizmoVisualPtr CreateGizmoVisual ( const std::string &  _name)
overridevirtual

◆ CreateGizmoVisual() [3/4]

virtual GizmoVisualPtr CreateGizmoVisual ( unsigned int  _id)
overridevirtual

◆ CreateGizmoVisual() [4/4]

virtual GizmoVisualPtr CreateGizmoVisual ( unsigned int  _id,
const std::string &  _name 
)
overridevirtual

◆ CreateGizmoVisualImpl()

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

Implementation for creating a GizmoVisual.

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

Reimplemented in Ogre2Scene, and OgreScene.

References std::endl(), and ignerr.

◆ CreateGpuRays() [1/4]

virtual GpuRaysPtr CreateGpuRays ( )
overridevirtual

◆ CreateGpuRays() [2/4]

virtual GpuRaysPtr CreateGpuRays ( const std::string &  _name)
overridevirtual

◆ CreateGpuRays() [3/4]

virtual GpuRaysPtr CreateGpuRays ( const unsigned int  _id)
overridevirtual

◆ CreateGpuRays() [4/4]

virtual GpuRaysPtr CreateGpuRays ( const unsigned int  _id,
const std::string &  _name 
)
overridevirtual

◆ CreateGpuRaysImpl()

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

Implementation for creating GpuRays sensor.

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

Reimplemented in Ogre2Scene, and OgreScene.

References std::endl(), and ignerr.

◆ CreateGrid()

virtual GridPtr CreateGrid ( )
overridevirtual

◆ CreateGridImpl()

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

Implementation for creating a grid geometry object.

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

Implemented in Ogre2Scene, and OgreScene.

◆ CreateMarker()

virtual MarkerPtr CreateMarker ( )
overridevirtual

◆ CreateMarkerImpl()

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

Implementation for creating a marker geometry object.

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

Implemented in Ogre2Scene, and OgreScene.

◆ CreateMaterial() [1/2]

virtual MaterialPtr CreateMaterial ( const common::Material &  _material)
overridevirtual

◆ CreateMaterial() [2/2]

virtual MaterialPtr CreateMaterial ( const std::string &  _name = "")
overridevirtual

◆ CreateMaterialImpl()

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

Implemented in Ogre2Scene, and OgreScene.

◆ CreateMesh() [1/3]

virtual MeshPtr CreateMesh ( const common::Mesh *  _mesh)
overridevirtual

◆ CreateMesh() [2/3]

virtual MeshPtr CreateMesh ( const MeshDescriptor &  _desc)
overridevirtual

◆ CreateMesh() [3/3]

virtual MeshPtr CreateMesh ( const std::string &  _meshName)
overridevirtual

◆ CreateMeshImpl()

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

Implemented in Ogre2Scene, and OgreScene.

◆ CreateObjectId()

virtual unsigned int CreateObjectId ( )
protectedvirtual

◆ CreateObjectName()

virtual std::string CreateObjectName ( unsigned int  _id,
const std::string &  _prefix 
)
protectedvirtual

◆ CreatePlane()

virtual GeometryPtr CreatePlane ( )
overridevirtual

◆ CreatePlaneImpl()

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

Implemented in Ogre2Scene, and OgreScene.

◆ CreatePointLight() [1/4]

virtual PointLightPtr CreatePointLight ( )
overridevirtual

◆ CreatePointLight() [2/4]

virtual PointLightPtr CreatePointLight ( const std::string &  _name)
overridevirtual

◆ CreatePointLight() [3/4]

virtual PointLightPtr CreatePointLight ( unsigned int  _id)
overridevirtual

◆ CreatePointLight() [4/4]

virtual PointLightPtr CreatePointLight ( unsigned int  _id,
const std::string &  _name 
)
overridevirtual

◆ CreatePointLightImpl()

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

Implemented in Ogre2Scene, and OgreScene.

◆ CreateRayQuery()

virtual RayQueryPtr CreateRayQuery ( )
overridevirtual

◆ CreateRayQueryImpl()

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

Implemented in Ogre2Scene, and OgreScene.

◆ CreateRenderTexture()

virtual RenderTexturePtr CreateRenderTexture ( )
overridevirtual

◆ CreateRenderTextureImpl()

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

Implemented in Ogre2Scene, and OgreScene.

◆ CreateRenderWindow()

virtual RenderWindowPtr CreateRenderWindow ( )
overridevirtual

◆ CreateRenderWindowImpl()

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

Render engine specific implementation for creating a render window.

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

Implemented in Ogre2Scene, and OgreScene.

◆ CreateSphere()

virtual GeometryPtr CreateSphere ( )
overridevirtual

◆ CreateSphereImpl()

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

Implemented in Ogre2Scene, and OgreScene.

◆ CreateSpotLight() [1/4]

virtual SpotLightPtr CreateSpotLight ( )
overridevirtual

◆ CreateSpotLight() [2/4]

virtual SpotLightPtr CreateSpotLight ( const std::string &  _name)
overridevirtual

◆ CreateSpotLight() [3/4]

virtual SpotLightPtr CreateSpotLight ( unsigned int  _id)
overridevirtual

◆ CreateSpotLight() [4/4]

virtual SpotLightPtr CreateSpotLight ( unsigned int  _id,
const std::string &  _name 
)
overridevirtual

◆ CreateSpotLightImpl()

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

Implemented in Ogre2Scene, and OgreScene.

◆ CreateText()

virtual TextPtr CreateText ( )
overridevirtual

◆ CreateTextImpl()

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

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 in Ogre2Scene, and OgreScene.

◆ CreateThermalCamera() [1/4]

virtual ThermalCameraPtr CreateThermalCamera ( )
overridevirtual

◆ CreateThermalCamera() [2/4]

virtual ThermalCameraPtr CreateThermalCamera ( const std::string &  _name)
overridevirtual

◆ CreateThermalCamera() [3/4]

virtual ThermalCameraPtr CreateThermalCamera ( const unsigned int  _id)
overridevirtual

◆ CreateThermalCamera() [4/4]

virtual ThermalCameraPtr CreateThermalCamera ( const unsigned int  _id,
const std::string &  _name 
)
overridevirtual

◆ CreateThermalCameraImpl()

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

Implementation for creating a thermal camera.

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

Reimplemented in Ogre2Scene, and OgreScene.

References std::endl(), and ignerr.

◆ CreateVisual() [1/4]

virtual VisualPtr CreateVisual ( )
overridevirtual

◆ CreateVisual() [2/4]

virtual VisualPtr CreateVisual ( const std::string &  _name)
overridevirtual

◆ CreateVisual() [3/4]

virtual VisualPtr CreateVisual ( unsigned int  _id)
overridevirtual

◆ CreateVisual() [4/4]

virtual VisualPtr CreateVisual ( unsigned int  _id,
const std::string &  _name 
)
overridevirtual

◆ CreateVisualImpl()

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

Implemented in Ogre2Scene, and OgreScene.

◆ Destroy()

virtual void Destroy ( )
overridevirtual

Reimplemented in Ogre2Scene, and OgreScene.

◆ DestroyLight()

virtual void DestroyLight ( LightPtr  _light,
bool  _recursive = false 
)
overridevirtual

◆ DestroyLightById()

virtual void DestroyLightById ( unsigned int  _id)
overridevirtual

◆ DestroyLightByIndex()

virtual void DestroyLightByIndex ( unsigned int  _index)
overridevirtual

◆ DestroyLightByName()

virtual void DestroyLightByName ( const std::string &  _name)
overridevirtual

◆ DestroyLights()

virtual void DestroyLights ( )
overridevirtual

◆ DestroyMaterial()

virtual void DestroyMaterial ( MaterialPtr  _material)
overridevirtual

◆ DestroyMaterials()

virtual void DestroyMaterials ( )
overridevirtual

◆ DestroyNode()

virtual void DestroyNode ( NodePtr  _node,
bool  _recursive = false 
)
overridevirtual

◆ DestroyNodeById()

virtual void DestroyNodeById ( unsigned int  _id)
overridevirtual

◆ DestroyNodeByIndex()

virtual void DestroyNodeByIndex ( unsigned int  _index)
overridevirtual

◆ DestroyNodeByName()

virtual void DestroyNodeByName ( const std::string &  _name)
overridevirtual

◆ DestroyNodes()

virtual void DestroyNodes ( )
overridevirtual

◆ DestroySensor()

virtual void DestroySensor ( SensorPtr  _sensor,
bool  _recursive = false 
)
overridevirtual

◆ DestroySensorById()

virtual void DestroySensorById ( unsigned int  _id)
overridevirtual

◆ DestroySensorByIndex()

virtual void DestroySensorByIndex ( unsigned int  _index)
overridevirtual

◆ DestroySensorByName()

virtual void DestroySensorByName ( const std::string &  _name)
overridevirtual

◆ DestroySensors()

virtual void DestroySensors ( )
overridevirtual

◆ DestroyVisual()

virtual void DestroyVisual ( VisualPtr  _visual,
bool  _recursive = false 
)
overridevirtual

◆ DestroyVisualById()

virtual void DestroyVisualById ( unsigned int  _id)
overridevirtual

◆ DestroyVisualByIndex()

virtual void DestroyVisualByIndex ( unsigned int  _index)
overridevirtual

◆ DestroyVisualByName()

virtual void DestroyVisualByName ( const std::string &  _name)
overridevirtual

◆ DestroyVisuals()

virtual void DestroyVisuals ( )
overridevirtual

◆ Fini()

virtual void Fini ( )
overridevirtual

Reimplemented in Ogre2Scene, and OgreScene.

◆ GradientBackgroundColor()

virtual std::array<math::Color, 4> GradientBackgroundColor ( ) const
overridevirtual

◆ HasLight()

virtual bool HasLight ( ConstLightPtr  _light) const
overridevirtual

◆ HasLightId()

virtual bool HasLightId ( unsigned int  _id) const
overridevirtual

◆ HasLightName()

virtual bool HasLightName ( const std::string &  _name) const
overridevirtual

◆ HasNode()

virtual bool HasNode ( ConstNodePtr  _node) const
overridevirtual

◆ HasNodeId()

virtual bool HasNodeId ( unsigned int  _id) const
overridevirtual

◆ HasNodeName()

virtual bool HasNodeName ( const std::string &  _name) const
overridevirtual

◆ HasSensor()

virtual bool HasSensor ( ConstSensorPtr  _sensor) const
overridevirtual

◆ HasSensorId()

virtual bool HasSensorId ( unsigned int  _id) const
overridevirtual

◆ HasSensorName()

virtual bool HasSensorName ( const std::string &  _name) const
overridevirtual

◆ HasVisual()

virtual bool HasVisual ( ConstVisualPtr  _visual) const
overridevirtual

◆ HasVisualId()

virtual bool HasVisualId ( unsigned int  _id) const
overridevirtual

◆ HasVisualName()

virtual bool HasVisualName ( const std::string &  _name) const
overridevirtual

◆ Id()

virtual unsigned int Id ( ) const
overridevirtual

◆ Init()

virtual void Init ( )
overridevirtual

◆ InitImpl()

virtual bool InitImpl ( )
protectedpure virtual

Implemented in Ogre2Scene, and OgreScene.

◆ IsGradientBackgroundColor()

virtual bool IsGradientBackgroundColor ( ) const
overridevirtual

◆ IsInitialized()

virtual bool IsInitialized ( ) const
overridevirtual

◆ IsLoaded()

virtual bool IsLoaded ( ) const
virtual

◆ LightById()

virtual LightPtr LightById ( unsigned int  _id) const
overridevirtual

◆ LightByIndex()

virtual LightPtr LightByIndex ( unsigned int  _index) const
overridevirtual

◆ LightByName()

virtual LightPtr LightByName ( const std::string &  _name) const
overridevirtual

◆ LightCount()

virtual unsigned int LightCount ( ) const
overridevirtual

◆ Lights()

virtual LightStorePtr Lights ( ) const
protectedpure virtual

Implemented in Ogre2Scene, and OgreScene.

◆ Load()

virtual void Load ( )
overridevirtual

◆ LoadImpl()

virtual bool LoadImpl ( )
protectedpure virtual

Implemented in Ogre2Scene, and OgreScene.

◆ Material()

virtual MaterialPtr Material ( const std::string &  _name) const
overridevirtual

◆ MaterialRegistered()

virtual bool MaterialRegistered ( const std::string &  _name) const
overridevirtual

◆ Materials()

virtual MaterialMapPtr Materials ( ) const
protectedpure virtual

Implemented in Ogre2Scene, and OgreScene.

◆ Name()

virtual std::string Name ( ) const
overridevirtual

◆ NodeById()

virtual NodePtr NodeById ( unsigned int  _id) const
overridevirtual

◆ NodeByIndex()

virtual NodePtr NodeByIndex ( unsigned int  _index) const
overridevirtual

◆ NodeByName()

virtual NodePtr NodeByName ( const std::string &  _name) const
overridevirtual

◆ NodeCount()

virtual unsigned int NodeCount ( ) const
overridevirtual

◆ PreRender()

virtual void PreRender ( )
overridevirtual

Reimplemented in Ogre2Scene, and OgreScene.

◆ RegisterLight()

virtual bool RegisterLight ( LightPtr  _light)
protectedvirtual

◆ RegisterMaterial()

virtual void RegisterMaterial ( const std::string &  _name,
MaterialPtr  _material 
)
overridevirtual

◆ RegisterSensor()

virtual bool RegisterSensor ( SensorPtr  _vensor)
protectedvirtual

◆ RegisterVisual()

virtual bool RegisterVisual ( VisualPtr  _visual)
protectedvirtual

◆ RemoveGradientBackgroundColor()

virtual void RemoveGradientBackgroundColor ( )
overridevirtual

Reimplemented in OgreScene.

◆ SensorById()

virtual SensorPtr SensorById ( unsigned int  _id) const
overridevirtual

◆ SensorByIndex()

virtual SensorPtr SensorByIndex ( unsigned int  _index) const
overridevirtual

◆ SensorByName()

virtual SensorPtr SensorByName ( const std::string &  _name) const
overridevirtual

◆ SensorCount()

virtual unsigned int SensorCount ( ) const
overridevirtual

◆ Sensors()

virtual SensorStorePtr Sensors ( ) const
protectedpure virtual

Implemented in Ogre2Scene, and OgreScene.

◆ SetAmbientLight() [1/2]

virtual void SetAmbientLight ( const math::Color &  _color)
overridepure virtual

Implemented in Ogre2Scene, and OgreScene.

◆ SetAmbientLight() [2/2]

virtual void SetAmbientLight ( double  _r,
double  _g,
double  _b,
double  _a = 1.0 
)
overridevirtual

◆ SetBackgroundColor() [1/2]

virtual void SetBackgroundColor ( const math::Color &  _color)
overridevirtual

Reimplemented in OgreScene.

◆ SetBackgroundColor() [2/2]

virtual void SetBackgroundColor ( double  _r,
double  _g,
double  _b,
double  _a = 1.0 
)
overridevirtual

◆ SetGradientBackgroundColor()

virtual void SetGradientBackgroundColor ( const std::array< math::Color, 4 > &  _colors)
overridevirtual

Reimplemented in OgreScene.

◆ SetSimTime()

virtual void SetSimTime ( const common::Time &  _time)
overridevirtual

◆ SimTime()

virtual common::Time SimTime ( ) const
overridevirtual

◆ UnregisterMaterial()

virtual void UnregisterMaterial ( const std::string &  _name)
overridevirtual

◆ UnregisterMaterials()

virtual void UnregisterMaterials ( )
overridevirtual

◆ VisualAt()

virtual VisualPtr VisualAt ( const CameraPtr &  _camera,
const gz::math::Vector2i &  _mousePos 
)
overridevirtual

◆ VisualById()

virtual VisualPtr VisualById ( unsigned int  _id) const
overridevirtual

◆ VisualByIndex()

virtual VisualPtr VisualByIndex ( unsigned int  _index) const
overridevirtual

◆ VisualByName()

virtual VisualPtr VisualByName ( const std::string &  _name) const
overridevirtual

◆ VisualCount()

virtual unsigned int VisualCount ( ) const
overridevirtual

◆ Visuals()

virtual VisualStorePtr Visuals ( ) const
protectedpure virtual

Implemented in Ogre2Scene, and OgreScene.

Member Data Documentation

◆ backgroundColor

math::Color backgroundColor
protected

Scene background color. Default should be black.

◆ gradientBackgroundColor

std::array<math::Color, 4> gradientBackgroundColor
protected

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.

◆ id

unsigned int id
protected

◆ initialized

bool initialized
protected

◆ isGradientBackgroundColor

bool isGradientBackgroundColor = false
protected

Whether the scene has a gradient background.

◆ loaded

bool loaded
protected

◆ name

std::string name
protected

◆ simTime

common::Time simTime
protected
The documentation for this class was generated from the following file: