Ignition Gazebo

API Reference

6.1.0
VideoRecorder.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2019 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 IGNITION_GAZEBO_GUI_VIDEORECORDER_HH_
19 #define IGNITION_GAZEBO_GUI_VIDEORECORDER_HH_
20 
21 #include <memory>
22 
24 
25 namespace ignition
26 {
27 namespace gazebo
28 {
29  class VideoRecorderPrivate;
30 
33  {
34  Q_OBJECT
35 
37  public: VideoRecorder();
38 
40  public: ~VideoRecorder() override;
41 
42  // Documentation inherited
43  public: void LoadConfig(const tinyxml2::XMLElement *_pluginElem) override;
44 
45  // Documentation inherited
46  public: void Update(const UpdateInfo &_info, EntityComponentManager &_ecm)
47  override;
48 
49  // Documentation inherited
50  public: bool eventFilter(QObject *_obj, QEvent *_event) override;
51 
54  public slots: void OnStart(const QString &_format);
55 
57  public slots: void OnStop();
58 
61  public slots: void OnSave(const QString &_url);
62 
64  public slots: void OnCancel();
65 
69  };
70 }
71 }
72 
73 #endif
void LoadConfig(const tinyxml2::XMLElement *_pluginElem) override
void OnStop()
Callback when video record stop request is received.
Information passed to systems on the update callback.
Definition: Types.hh:38
Provides video recording cababilities to the 3D scene.
Definition: VideoRecorder.hh:32
The EntityComponentManager constructs, deletes, and returns components and entities. A component can be of any class which inherits from components::BaseComponent.
Definition: EntityComponentManager.hh:66
void OnCancel()
Callback when user cancels saving the recorded video.
bool eventFilter(QObject *_obj, QEvent *_event) override
void Update(const UpdateInfo &_info, EntityComponentManager &_ecm) override
Update callback called every time the system is stepped. This is called at an Ignition transport thre...
This library is part of the Ignition Robotics project.
Base class for a GUI System.
Definition: GuiSystem.hh:44
void OnSave(const QString &_url)
Callback when user selects a path to save the recorded video.
void OnStart(const QString &_format)
Callback when video record start request is received.
~VideoRecorder() override
Destructor.