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
28
29namespace gazebo
30{
31 class CmdVelKeyboardControls;
32 class KeysToCmdVelPluginPrivate;
33
63
65 {
68
71
72 // Documentation inherited
73 public: void Load(physics::ModelPtr _model, sdf::ElementPtr _sdf) override;
74
75 // Documentation inherited
76 public: void Init() override;
77
78 // Documentation inherited
79 public: void Reset() override;
80
83 protected: virtual void OnKeyPress(ConstAnyPtr &_msg);
84
87 private: std::unique_ptr<KeysToCmdVelPluginPrivate> dataPtr;
88 };
89}
90#endif
Send velocity commands to a model based on keypress messages received.
Definition: KeysToCmdVelPlugin.hh:65
KeysToCmdVelPlugin()
Constructor.
void Init() override
Override this method for custom plugin initialization behavior.
void Load(physics::ModelPtr _model, sdf::ElementPtr _sdf) override
Load function.
void Reset() override
Override this method for custom plugin reset behavior.
virtual void OnKeyPress(ConstAnyPtr &_msg)
Callback each time a key message is received.
~KeysToCmdVelPlugin()
Destructor.
A plugin with access to physics::Model.
Definition: Plugin.hh:313
boost::shared_ptr< Model > ModelPtr
Definition: PhysicsTypes.hh:93
Forward declarations for the common classes.
Definition: Animation.hh:27
#define GAZEBO_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system.hh:59