Gazebo Gui

API Reference

6.8.0
CameraFps.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2023 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16 */
17 
18 #ifndef GZ_GUI_PLUGINS_CAMERAFPS_HH_
19 #define GZ_GUI_PLUGINS_CAMERAFPS_HH_
20 
21 #include <memory>
22 
23 #include "gz/gui/Plugin.hh"
24 
25 namespace ignition
26 {
27 namespace gui
28 {
29 namespace plugins
30 {
31  class CameraFpsPrivate;
32 
34  class CameraFps : public Plugin
35  {
36  Q_OBJECT
37 
39  Q_PROPERTY(
41  READ CameraFpsValue
42  WRITE SetCameraFpsValue
44  )
45 
46 
47  public: CameraFps();
48 
50  public: virtual ~CameraFps();
51 
52  // Documentation inherited
53  public: virtual void LoadConfig(const tinyxml2::XMLElement *_pluginElem)
54  override;
55 
58  public: Q_INVOKABLE void SetCameraFpsValue(const QString &_value);
59 
62  public: Q_INVOKABLE QString CameraFpsValue() const;
63 
65  signals: void CameraFpsValueChanged();
66 
68  private: void OnRender();
69 
70  // Documentation inherited
71  private: bool eventFilter(QObject *_obj, QEvent *_event) override;
72 
75  private: std::unique_ptr<CameraFpsPrivate> dataPtr;
76  };
77 }
78 }
79 }
80 #endif
QString cameraFPSValue
Camera frames per second.
Definition: CameraFps.hh:44
void CameraFpsValueChanged()
Notify that camera FPS value has changed.
virtual void LoadConfig(const tinyxml2::XMLElement *_pluginElem) override
Load the plugin with a configuration file. Override this on custom plugins to handle custom configura...
Q_INVOKABLE void SetCameraFpsValue(const QString &_value)
Set the camera FPS value string.
Q_INVOKABLE QString CameraFpsValue() const
Get the camera FPS value string.
Base class for Gazebo GUI plugins.
Definition: gz/gui/Plugin.hh:54
STL namespace.
Definition: gz/gui/Application.hh:35
This plugin displays the GUI camera's Framerate Per Second (FPS)
Definition: CameraFps.hh:34