Gazebo Rendering

API Reference

3.7.2
gz/rendering/OrbitViewController.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_ORBITVIEWCONTROLLER_HH_
18 #define GZ_RENDERING_ORBITVIEWCONTROLLER_HH_
19 
20 #include <memory>
21 
22 #include <gz/common/SuppressWarning.hh>
23 
24 #include <gz/math/Vector3.hh>
25 
26 #include "gz/rendering/config.hh"
27 #include "gz/rendering/Camera.hh"
29 
30 namespace ignition
31 {
32  namespace rendering
33  {
34  inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
35  //
36  // forward declarations
37  class OrbitViewControllerPrivate;
38 
42  class IGNITION_RENDERING_VISIBLE OrbitViewController
43  : public virtual ViewController
44  {
46  public: OrbitViewController();
47 
49  public: explicit OrbitViewController(const CameraPtr &_camera);
50 
52  public: virtual ~OrbitViewController();
53 
56  public: virtual void SetCamera(const CameraPtr &_camera);
57 
60  public: virtual CameraPtr Camera() const;
61 
64  public: virtual void SetTarget(const math::Vector3d &_target);
65 
68  public: virtual math::Vector3d Target() const;
69 
72  public: virtual void Zoom(const double _value);
73 
76  public: virtual void Pan(const math::Vector2d &_value);
77 
80  public: virtual void Orbit(const math::Vector2d &_value);
81 
86  };
87  }
88  }
89 }
90 #endif
virtual void SetCamera(const CameraPtr &_camera)
Set the camera that will be controlled by this view controller.
virtual void Zoom(const double _value)
Set zoom amount.
STL class.
#define IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
virtual ~OrbitViewController()
Deconstructor.
std::unique_ptr< OrbitViewControllerPrivate > dataPtr
Private data pointer.
Definition: gz/rendering/OrbitViewController.hh:84
Posable camera used for rendering the scene graph.
Definition: gz/rendering/Camera.hh:40
A camera view controller.
Definition: gz/rendering/ViewController.hh:35
virtual CameraPtr Camera() const
Get the camera that is controlled by this view controller.
virtual void Pan(const math::Vector2d &_value)
Set camera pan (translational movement) around target point.
A camera view controller.
Definition: gz/rendering/OrbitViewController.hh:42
virtual void SetTarget(const math::Vector3d &_target)
Set target point for pan, zoom, oribit.
virtual math::Vector3d Target() const
Get target point for pan, zoom, oribit.
virtual void Orbit(const math::Vector2d &_value)
Set camera orbit (rotational movement) around target point.
#define IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING