Ignition Sensors

API Reference

5.0.0

#include <RenderingEvents.hh>

Static Public Member Functions

static ignition::common::ConnectionPtr ConnectSceneChangeCallback (std::function< void(const ignition::rendering::ScenePtr &)> _callback)
 Set a callback to be called when the scene is changed. More...
 

Static Public Attributes

static ignition::common::EventT< void(const ignition::rendering::ScenePtr &)> sceneEvent
 Event that is used to trigger callbacks when the scene is changed. More...
 

Member Function Documentation

◆ ConnectSceneChangeCallback()

static ignition::common::ConnectionPtr ConnectSceneChangeCallback ( std::function< void(const ignition::rendering::ScenePtr &)>  _callback)
static

Set a callback to be called when the scene is changed.

Parameters
[in]_callbackThis callback will be called every time the scene is changed.
Remarks
Do not block inside of the callback.
Returns
A connection pointer that must remain in scope. When the connection pointer falls out of scope, the connection is broken.

Member Data Documentation

◆ sceneEvent

ignition::common::EventT< void(const ignition::rendering::ScenePtr &)> sceneEvent
static

Event that is used to trigger callbacks when the scene is changed.


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