orbit_view_controller.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2009, Willow Garage, Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Willow Garage, Inc. nor the names of its
14  * contributors may be used to endorse or promote products derived from
15  * this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #ifndef RVIZ_ORBIT_VIEW_CONTROLLER_H
31 #define RVIZ_ORBIT_VIEW_CONTROLLER_H
32 
34 
35 #include <QCursor>
36 
38 
39 namespace rviz
40 {
41 class BoolProperty;
42 class FloatProperty;
43 class Shape;
44 class SceneNode;
45 class VectorProperty;
46 
62 {
63  Q_OBJECT
64 public:
66  ~OrbitViewController() override;
67 
71  void onInitialize() override;
72 
78  void zoom(float amount);
79  void yaw(float angle);
80  void pitch(float angle);
81  void move(float x, float y, float z);
82 
83  void handleMouseEvent(ViewportMouseEvent& evt) override;
84 
85  void lookAt(const Ogre::Vector3& point) override;
86 
87  void reset() override;
88 
94  void mimic(ViewController* source_view) override;
95 
96 protected:
97  void update(float dt, float ros_dt) override;
98  void onTargetFrameChanged(const Ogre::Vector3& old_reference_position,
99  const Ogre::Quaternion& old_reference_orientation) override;
100 
105  void calculatePitchYawFromPosition(const Ogre::Vector3& position);
106 
110  void updateFocalShapeSize();
111 
112  virtual void updateCamera();
113 
121 
123  bool dragging_;
124 };
125 
126 } // namespace rviz
127 
128 #endif // RVIZ_VIEW_CONTROLLER_H
rviz::OrbitViewController::zoom
void zoom(float amount)
Move in/out from the focal point, ie. adjust #distance_ by amount.
Definition: orbit_view_controller.cpp:324
rviz::OrbitViewController::yaw
void yaw(float angle)
Definition: orbit_view_controller.cpp:296
rviz::OrbitViewController::updateFocalShapeSize
void updateFocalShapeSize()
Calculates the focal shape size and update it's geometry.
Definition: orbit_view_controller.cpp:313
rviz::OrbitViewController::focal_point_property_
VectorProperty * focal_point_property_
The point around which the camera "orbits".
Definition: orbit_view_controller.h:118
angle
TFSIMD_FORCE_INLINE tfScalar angle(const Quaternion &q1, const Quaternion &q2)
rviz::OrbitViewController::fov_property_
FloatProperty * fov_property_
The camera's vertical field of view, in radians.
Definition: orbit_view_controller.h:117
rviz::OrbitViewController::OrbitViewController
OrbitViewController()
Definition: orbit_view_controller.cpp:61
rviz::OrbitViewController::distance_property_
FloatProperty * distance_property_
The camera's distance from the focal point.
Definition: orbit_view_controller.h:116
rviz::OrbitViewController::focal_shape_fixed_size_property_
BoolProperty * focal_shape_fixed_size_property_
Whether the focal shape size is fixed or not.
Definition: orbit_view_controller.h:119
rviz::OrbitViewController::onTargetFrameChanged
void onTargetFrameChanged(const Ogre::Vector3 &old_reference_position, const Ogre::Quaternion &old_reference_orientation) override
Override to implement the change in properties which nullifies the change in target frame.
Definition: orbit_view_controller.cpp:257
rviz::BoolProperty
Property specialized to provide getter for booleans.
Definition: bool_property.h:38
rviz::ViewportMouseEvent
Definition: viewport_mouse_event.h:45
rviz::OrbitViewController::onInitialize
void onInitialize() override
Do subclass-specific initialization. Called by ViewController::initialize after context_,...
Definition: orbit_view_controller.cpp:91
rviz::OrbitViewController::focal_shape_size_property_
FloatProperty * focal_shape_size_property_
The focal shape size.
Definition: orbit_view_controller.h:120
rviz::FloatProperty
Property specialized to enforce floating point max/min.
Definition: float_property.h:37
frame_position_tracking_view_controller.h
rviz::OrbitViewController::focal_shape_
Shape * focal_shape_
Definition: orbit_view_controller.h:122
rviz::OrbitViewController::mimic
void mimic(ViewController *source_view) override
Configure the settings of this view controller to give, as much as possible, a similar view as that g...
Definition: orbit_view_controller.cpp:212
rviz::OrbitViewController::pitch_property_
FloatProperty * pitch_property_
The camera's pitch (rotation around the x-axis), in radians.
Definition: orbit_view_controller.h:115
rviz::OrbitViewController::calculatePitchYawFromPosition
void calculatePitchYawFromPosition(const Ogre::Vector3 &position)
Calculates pitch and yaw values given a new position and the current focal point.
Definition: orbit_view_controller.cpp:306
rviz::OrbitViewController::~OrbitViewController
~OrbitViewController() override
Definition: orbit_view_controller.cpp:103
rviz::OrbitViewController::update
void update(float dt, float ros_dt) override
Called at 30Hz by ViewManager::update() while this view is active. Override with code that needs to r...
Definition: orbit_view_controller.cpp:241
rviz
Definition: add_display_dialog.cpp:54
rviz::OrbitViewController::pitch
void pitch(float angle)
Definition: orbit_view_controller.cpp:301
rviz::OrbitViewController::updateCamera
virtual void updateCamera()
Definition: orbit_view_controller.cpp:263
ogre_vector.h
rviz::OrbitViewController
An orbital camera, controlled by yaw, pitch, distance, and focal point.
Definition: orbit_view_controller.h:61
rviz::OrbitViewController::yaw_property_
FloatProperty * yaw_property_
The camera's yaw (rotation around the y-axis), in radians.
Definition: orbit_view_controller.h:114
rviz::OrbitViewController::dragging_
bool dragging_
Definition: orbit_view_controller.h:123
rviz::OrbitViewController::handleMouseEvent
void handleMouseEvent(ViewportMouseEvent &evt) override
Definition: orbit_view_controller.cpp:121
rviz::ViewController
Definition: view_controller.h:55
rviz::FramePositionTrackingViewController
Base class of ViewControllers which have a "Target Frame" which is a TF frame whose position they tra...
Definition: frame_position_tracking_view_controller.h:45
rviz::Shape
Definition: shape.h:51
rviz::VectorProperty
Definition: vector_property.h:39
rviz::OrbitViewController::move
void move(float x, float y, float z)
Definition: orbit_view_controller.cpp:330
rviz::OrbitViewController::lookAt
void lookAt(const Ogre::Vector3 &point) override
This should be implemented in each subclass to aim the camera at the given point in space (relative t...
Definition: orbit_view_controller.cpp:247
rviz::OrbitViewController::reset
void reset() override
Definition: orbit_view_controller.cpp:108


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust, William Woodall
autogenerated on Fri Aug 2 2024 08:43:10