EntityMaker.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012-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_ENTITYMAKER_HH_
18 #define _GAZEBO_ENTITYMAKER_HH_
19 
20 #include <boost/function.hpp>
21 #include <ignition/math/Vector3.hh>
22 
24 
25 namespace gazebo
26 {
29  namespace gui
30  {
31  class EntityMakerPrivate;
32 
35 
37  class GZ_GUI_VISIBLE EntityMaker
38  {
40  public: virtual ~EntityMaker();
41 
43  public: virtual void Start();
44 
46  public: virtual void Stop();
47 
50  public: virtual void OnMouseRelease(const common::MouseEvent &_event);
51 
54  public: virtual void OnMouseMove(const common::MouseEvent &_event);
55 
58  public: virtual ignition::math::Vector3d EntityPosition() const;
59 
62  protected: virtual void SetEntityPosition(
63  const ignition::math::Vector3d &_pos);
64 
67  protected: EntityMaker(EntityMakerPrivate &_dataPtr);
68 
70  protected: virtual void CreateTheEntity() = 0;
71 
74  protected: EntityMakerPrivate *dataPtr;
75  };
76  }
77 }
78 #endif
79 
80 
Generic description of a mouse event.
Definition: MouseEvent.hh:35
EntityMakerPrivate * dataPtr
Definition: EntityMaker.hh:74
Forward declarations for transport.
To make an entity, base class.
Definition: EntityMaker.hh:37