RenderingSensor Class Reference

a rendering sensor class More...

#include <RenderingSensor.hh>

Public Member Functions
virtual	~RenderingSensor ()
	destructor More...
bool	ManualSceneUpdate () const
	Get whether the scene graph is updated manually. Defaults to false. More...
void	Render ()
	Render update. This performs the actual render operation. More...
rendering::ScenePtr	Scene () const
	Get the rendering scene. More...
void	SetManualSceneUpdate (bool _manual)
	Set whether to update the scene graph manually. If set to true, it is expected that rendering::Scene::PreRender is called manually before calling Render() More...
virtual void	SetScene (rendering::ScenePtr _scene)
	Set the rendering scene. More...
Public Member Functions inherited from Sensor
virtual	~Sensor ()
	destructor More...
void	AddSequence (gz::msgs::Header *_msg, const std::string &_seqKey="default")
	Add a sequence number to an gz::msgs::Header. This function can be called by a sensor that wants to add a sequence number to a sensor message in order to have improved accountability for generated sensor data. More...
bool	EnableMetrics () const
	Get flag state for enabling performance metrics publication. More...
std::string	FrameId () const
	FrameId. More...
SensorId	Id () const
	Get the sensor's ID. More...
virtual bool	Init ()
	Initialize values in the sensor This will set the next update time to zero. This is particularly useful if simulation time has jumped backward, for example during a seek backward in a log file. More...
bool	IsActive () const
	Get whether the sensor is enabled or not. More...
virtual bool	Load (const sdf::Sensor &_sdf)
	Load the sensor based on data from an sdf::Sensor object. More...
virtual bool	Load (sdf::ElementPtr _sdf)
	Load the sensor with SDF parameters. More...
std::string	Name () const
	Get name. More...
std::chrono::steady_clock::duration	NextDataUpdateTime () const
	Return the next time the sensor will generate data. More...
std::string	Parent () const
	Get parent link of the sensor. More...
gz::math::Pose3d	Pose () const
	Get the current pose. More...
void	PublishMetrics (const std::chrono::duration< double > &_now)
	Publishes information about the performance of the sensor. This method is called by Update(). More...
sdf::ElementPtr	SDF () const
	Get the SDF used to load this sensor. More...
void	SetActive (bool _active)
	Enable or disable the sensor. Disabled sensors will not generate or publish data unless Update is called with the '_force' argument set to true. More...
void	SetEnableMetrics (bool _enableMetrics)
	Set flag to enable publishing performance metrics. More...
void	SetFrameId (const std::string &_frameId)
	Set Frame ID of the sensor. More...
virtual void	SetParent (const std::string &_parent)
	Set the parent of the sensor. More...
void	SetPose (const gz::math::Pose3d &_pose)
	Update the pose of the sensor. More...
bool	SetTopic (const std::string &_topic)
	Set topic where sensor data is published. More...
void	SetUpdateRate (const double _hz)
	Set the update rate of the sensor. An update rate of zero means that the sensor is updated every cycle. It's zero by default. \detail Negative rates become zero. More...
std::string	Topic () const
	Get topic where sensor data is published. More...
virtual bool	Update (const std::chrono::steady_clock::duration &_now)=0
	Force the sensor to generate data. More...
bool	Update (const std::chrono::steady_clock::duration &_now, const bool _force)
	Update the sensor. More...
double	UpdateRate () const
	Get the update rate of the sensor. More...

Protected Member Functions
	RenderingSensor ()
	constructor More...
void	AddSensor (rendering::SensorPtr _sensor)
	Add a rendering::Sensor. Its render updates will be handled by this base class. More...
Protected Member Functions inherited from Sensor
	Sensor ()
	constructor More...

Detailed Description

a rendering sensor class

This class is a base for all rendering sensor classes. It provides interface to ignition rendering objects

Constructor & Destructor Documentation

RenderingSensor()

RenderingSensor ( )

protected

constructor

~RenderingSensor()

virtual ~RenderingSensor ( )

virtual

destructor

Member Function Documentation

AddSensor()

void AddSensor ( rendering::SensorPtr  _sensor )

protected

Add a rendering::Sensor. Its render updates will be handled by this base class.

Parameters

[in]

_sensor

Sensor to add.

ManualSceneUpdate()

bool ManualSceneUpdate

(

)

const

Get whether the scene graph is updated manually. Defaults to false.

Returns

True if manual scene graph update is enabled, false otherwise

See also

SetManualSceneUpdate

Render()

void Render

(

)

Render update. This performs the actual render operation.

Scene()

rendering::ScenePtr Scene

(

)

const

Get the rendering scene.

SetManualSceneUpdate()

void SetManualSceneUpdate

(

bool

_manual

)

Set whether to update the scene graph manually. If set to true, it is expected that rendering::Scene::PreRender is called manually before calling Render()

Parameters

[in]

_manual

True to enable manual scene graph update

SetScene()

virtual void SetScene ( rendering::ScenePtr  _scene )

virtual

Set the rendering scene.

Parameters

[in]

_scene

Pointer to the scene

---

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

• gz/sensors/RenderingSensor.hh