TransporterPlugin.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015 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 #ifndef GAZEBO_PLUGINS_TRANSPORTERPLUGIN_HH_
18 #define GAZEBO_PLUGINS_TRANSPORTERPLUGIN_HH_
19 
20 #include <memory>
21 
22 #include <gazebo/common/Plugin.hh>
23 #include <gazebo/util/system.hh>
24 
25 namespace gazebo
26 {
27  // Forward declare private data class
28  class TransporterPluginPrivate;
29 
41 
88  {
90  public: TransporterPlugin();
91 
93  public: virtual ~TransporterPlugin();
94 
95  // Documentation inherited
96  public: virtual void Load(physics::WorldPtr _world, sdf::ElementPtr _sdf);
97 
100  private: void Update();
101 
105  private: void OnActivation(ConstGzStringPtr &_msg);
106 
108  private: std::unique_ptr<TransporterPluginPrivate> dataPtr;
109  };
110 }
111 #endif
boost::shared_ptr< World > WorldPtr
Definition: PhysicsTypes.hh:89
Forward declarations for the common classes.
Definition: Animation.hh:33
A plugin with access to physics::World.
Definition: Plugin.hh:235
A plugin that allows models to transport (teleport) to a new location.
Definition: TransporterPlugin.hh:87
#define GAZEBO_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system.hh:58