Gazebo Rendering

API Reference

6.6.3
gz/rendering/OrthoViewController.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2021 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 IGNITION_RENDERING_ORTHOVIEWCONTROLLER_HH_
18 #define IGNITION_RENDERING_ORTHOVIEWCONTROLLER_HH_
19 
20 #include <memory>
21 #include <string>
22 #include <ignition/math/Vector2.hh>
23 
25 
26 namespace ignition
27 {
28  namespace rendering
29  {
30  inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
31  //
32  // Forward declare private data pointer.
33  class OrthoViewControllerPrivate;
34 
37  class IGNITION_RENDERING_VISIBLE OrthoViewController
38  : public virtual ViewController
39  {
41  public: OrthoViewController();
42 
45  public: explicit OrthoViewController(const CameraPtr &_camera);
46 
48  public: virtual ~OrthoViewController();
49 
52  public: virtual void SetCamera(const CameraPtr &_camera);
53 
56  public: virtual CameraPtr Camera() const;
57 
60  public: virtual void SetTarget(const math::Vector3d &_target);
61 
64  public: virtual const math::Vector3d &Target() const;
65 
68  public: virtual void Zoom(const double _value);
69 
72  public: virtual void Pan(const math::Vector2d &_value);
73 
76  public: virtual void Orbit(const math::Vector2d &_value);
77 
81  private: virtual void Resize(const unsigned int _width,
82  const unsigned int _height);
83 
88  };
89  }
90  }
91 }
92 #endif
STL class.
#define IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
virtual void SetCamera(const CameraPtr &_camera)
Set the camera that will be controlled by this view controller.
Posable camera used for rendering the scene graph.
Definition: gz/rendering/Camera.hh:49
A camera view controller.
Definition: gz/rendering/ViewController.hh:35
virtual void Zoom(const double _value)
Set zoom amount.
virtual CameraPtr Camera() const
Get the camera that is controlled by this view controller.
std::unique_ptr< OrthoViewControllerPrivate > dataPtr
Private data pointer.
Definition: gz/rendering/OrthoViewController.hh:86
virtual void Orbit(const math::Vector2d &_value)
Set camera orbit (rotational movement) around target point.
virtual void SetTarget(const math::Vector3d &_target)
Set target point for pan, zoom, oribit.
virtual void Pan(const math::Vector2d &_value)
Set camera pan (translational movement) around target point.
Orthographic view controller.
Definition: gz/rendering/OrthoViewController.hh:37
virtual const math::Vector3d & Target() const
Get target point for pan, zoom, oribit.
#define IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING