ViewController.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 _VIEWCONTROLLER_HH_
18 #define _VIEWCONTROLLER_HH_
19 
20 #include <string>
23 #include "gazebo/util/system.hh"
24 
25 namespace gazebo
26 {
27  namespace rendering
28  {
31 
34  class GZ_RENDERING_VISIBLE ViewController
35  {
38  public: ViewController(UserCameraPtr _camera);
39 
41  public: virtual ~ViewController();
42 
44  public: virtual void Init() = 0;
45 
50  public: virtual void Init(const math::Vector3 &_focalPoint,
51  const double _yaw = 0, const double _pitch = 0);
52 
55  public: virtual void Update() = 0;
56 
60  public: virtual void Resize(const unsigned int _width,
61  const unsigned int _height);
62 
65  public: void SetEnabled(bool _value);
66 
69  public: virtual void HandleMouseEvent(
70  const common::MouseEvent &_event) = 0;
71 
74  public: virtual void HandleKeyReleaseEvent(const std::string &_key) = 0;
75 
78  public: virtual void HandleKeyPressEvent(const std::string &_key) = 0;
79 
82  public: std::string GetTypeString() const;
83 
85  protected: UserCameraPtr camera;
86 
88  protected: bool enabled;
89 
91  protected: std::string typeString;
92  };
94  }
95 }
96 #endif
std::string typeString
Type of view controller.
Definition: ViewController.hh:91
Generic description of a mouse event.
Definition: MouseEvent.hh:35
boost::shared_ptr< UserCamera > UserCameraPtr
Definition: RenderTypes.hh:92
Forward declarations for the common classes.
Definition: Animation.hh:33
The Vector3 class represents the generic vector containing 3 elements.
Definition: Vector3.hh:39
bool enabled
True if enabled.
Definition: ViewController.hh:88
GAZEBO_VISIBLE void Init(google::protobuf::Message &_message, const std::string &_id="")
Initialize a message.
Base class for view controllers.
Definition: ViewController.hh:34
UserCameraPtr camera
Pointer to the camera to control.
Definition: ViewController.hh:85