TransporterPlugin.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015-2016 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_TRANSPORTER_PLUGIN_HH_
18 #define _GAZEBO_TRANSPORTER_PLUGIN_HH_
19 
20 #include <gazebo/common/Plugin.hh>
21 #include <gazebo/util/system.hh>
22 
23 namespace gazebo
24 {
25  // Forward declare private data class
26  class TransporterPluginPrivate;
27 
39 
86  {
88  public: TransporterPlugin();
89 
91  public: virtual ~TransporterPlugin();
92 
93  // Documentation inherited
94  public: virtual void Load(physics::WorldPtr _world, sdf::ElementPtr _sdf);
95 
98  private: void Update();
99 
103  private: void OnActivation(ConstGzStringPtr &_msg);
104 
106  private: TransporterPluginPrivate *dataPtr;
107  };
108 }
109 #endif
boost::shared_ptr< World > WorldPtr
Definition: PhysicsTypes.hh:89
A plugin with access to physics::World.
Definition: Plugin.hh:220
A plugin that allows models to transport (teleport) to a new location.
Definition: TransporterPlugin.hh:85
#define GAZEBO_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system.hh:59