KeysToCmdVelPlugin.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2018 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 GAZEBO_PLUGINS_KEYSTOCMDVELPLUGIN_HH_
19 #define GAZEBO_PLUGINS_KEYSTOCMDVELPLUGIN_HH_
20 
21 #include <memory>
22 #include <string>
23 #include <vector>
24 #include <ignition/transport/Node.hh>
25 
26 #include <gazebo/common/Plugin.hh>
27 #include <gazebo/transport/Node.hh>
28 
29 namespace gazebo
30 {
31  class CmdVelKeyboardControls;
32  class KeysToCmdVelPluginPrivate;
33 
68 
69 class GZ_PLUGIN_VISIBLE KeysToCmdVelPlugin : public ModelPlugin
70  {
72  public: KeysToCmdVelPlugin();
73 
75  public: ~KeysToCmdVelPlugin();
76 
77  // Documentation inherited
78  public: void Load(physics::ModelPtr _model, sdf::ElementPtr _sdf) override;
79 
80  // Documentation inherited
81  public: void Init() override;
82 
83  // Documentation inherited
84  public: void Reset() override;
85 
88  protected: virtual void OnKeyPress(ConstAnyPtr &_msg);
89 
92  private: std::unique_ptr<KeysToCmdVelPluginPrivate> dataPtr;
93  };
94 }
95 #endif
Forward declarations for the common classes.
Definition: Animation.hh:26
Send velocity commands to a model based on keypress messages received.
Definition: KeysToCmdVelPlugin.hh:69
boost::shared_ptr< Model > ModelPtr
Definition: PhysicsTypes.hh:94
GAZEBO_VISIBLE void Init(google::protobuf::Message &_message, const std::string &_id="")
Initialize a message.
A plugin with access to physics::Model.
Definition: Plugin.hh:303