ViewController.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012 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_RENDERING_VIEWCONTROLLER_HH_
18 #define GAZEBO_RENDERING_VIEWCONTROLLER_HH_
19 
20 #include <string>
21 
22 #include <ignition/math/Vector3.hh>
23 
24 #include "gazebo/math/Vector3.hh"
26 #include "gazebo/util/system.hh"
27 
28 namespace gazebo
29 {
30  namespace common
31  {
32  class MouseEvent;
33  }
34 
35  namespace rendering
36  {
39 
42  class GZ_RENDERING_VISIBLE ViewController
43  {
46  public: explicit ViewController(UserCameraPtr _camera);
47 
49  public: virtual ~ViewController();
50 
52  public: virtual void Init() = 0;
53 
59  public: virtual void Init(const math::Vector3 &_focalPoint,
60  const double _yaw = 0, const double _pitch = 0) GAZEBO_DEPRECATED(8.0);
61 
66  public: virtual void Init(const ignition::math::Vector3d &_focalPoint,
67  const double _yaw = 0, const double _pitch = 0);
68 
71  public: virtual void Update() = 0;
72 
76  public: virtual void Resize(const unsigned int _width,
77  const unsigned int _height);
78 
81  public: void SetEnabled(bool _value);
82 
85  public: virtual void HandleMouseEvent(
86  const common::MouseEvent &_event) = 0;
87 
90  public: virtual void HandleKeyReleaseEvent(const std::string &_key) = 0;
91 
94  public: virtual void HandleKeyPressEvent(const std::string &_key) = 0;
95 
98  public: std::string GetTypeString() const;
99 
101  protected: UserCameraPtr camera;
102 
104  protected: bool enabled;
105 
107  protected: std::string typeString;
108  };
110  }
111 }
112 #endif
std::string typeString
Type of view controller.
Definition: ViewController.hh:107
Generic description of a mouse event.
Definition: MouseEvent.hh:35
boost::shared_ptr< UserCamera > UserCameraPtr
Definition: RenderTypes.hh:93
Forward declarations for the common classes.
Definition: Animation.hh:33
The Vector3 class represents the generic vector containing 3 elements.
Definition: Vector3.hh:44
bool enabled
True if enabled.
Definition: ViewController.hh:104
#define GAZEBO_DEPRECATED(version)
Definition: system.hh:302
GAZEBO_VISIBLE void Init(google::protobuf::Message &_message, const std::string &_id="")
Initialize a message.
Base class for view controllers.
Definition: ViewController.hh:42
UserCameraPtr camera
Pointer to the camera to control.
Definition: ViewController.hh:101