Gazebo Rendering

API Reference

3.7.2
gz/rendering/ViewController.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2017 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 GZ_RENDERING_VIEWCONTROLLER_HH_
18 #define GZ_RENDERING_VIEWCONTROLLER_HH_
19 
20 #include <gz/math/Vector2.hh>
21 #include <gz/math/Vector3.hh>
22 
23 #include "gz/rendering/config.hh"
24 #include "gz/rendering/Camera.hh"
25 
26 namespace ignition
27 {
28  namespace rendering
29  {
30  inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
31  //
35  class IGNITION_RENDERING_VISIBLE ViewController
36  {
38  public: virtual ~ViewController() { }
39 
42  public: virtual void SetCamera(const CameraPtr &_camera) = 0;
43 
46  public: virtual void SetTarget(const math::Vector3d &_target) = 0;
47 
50  public: virtual void Zoom(const double _value) = 0;
51 
54  public: virtual void Pan(const math::Vector2d &_value) = 0;
55 
58  public: virtual void Orbit(const math::Vector2d &_value) = 0;
59  };
60  }
61  }
62 }
63 #endif
STL class.
virtual void Orbit(const math::Vector2d &_value)=0
Set camera orbit (rotational movement) around target point.
virtual ~ViewController()
Deconstructor.
Definition: gz/rendering/ViewController.hh:38
A camera view controller.
Definition: gz/rendering/ViewController.hh:35
virtual void Pan(const math::Vector2d &_value)=0
Set camera pan (translational movement) around target point.
virtual void SetTarget(const math::Vector3d &_target)=0
Set target point for pan, zoom, oribit.
virtual void SetCamera(const CameraPtr &_camera)=0
Set the camera that will be controlled by this view controller.
virtual void Zoom(const double _value)=0
Set zoom amount.