Developer Documentation

PickingInterface.hh
Go to the documentation of this file.
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4 * Copyright (c) 2001-2015, RWTH-Aachen University *
5 * Department of Computer Graphics and Multimedia *
6 * All rights reserved. *
7 * www.openflipper.org *
8 * *
9 *---------------------------------------------------------------------------*
10 * This file is part of OpenFlipper. *
11 *---------------------------------------------------------------------------*
12 * *
13 * Redistribution and use in source and binary forms, with or without *
14 * modification, are permitted provided that the following conditions *
15 * are met: *
16 * *
17 * 1. Redistributions of source code must retain the above copyright notice, *
18 * this list of conditions and the following disclaimer. *
19 * *
20 * 2. Redistributions in binary form must reproduce the above copyright *
21 * notice, this list of conditions and the following disclaimer in the *
22 * documentation and/or other materials provided with the distribution. *
23 * *
24 * 3. Neither the name of the copyright holder nor the names of its *
25 * contributors may be used to endorse or promote products derived from *
26 * this software without specific prior written permission. *
27 * *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41
42 #pragma once
43
44 #include <OpenFlipper/common/Types.hh>
45 #include <QToolBar>
46
62 class PickingInterface {
63 signals :
68 virtual void addPickMode( const std::string& _mode) {};
69
78 virtual void addHiddenPickMode( const std::string& _mode ) {};
79
87 virtual void setPickModeCursor( const std::string& _mode , QCursor _cursor ) {};
88
97 virtual void setPickModeMouseTracking( const std::string& _mode , bool _mouseTracking ) {};
98
106 virtual void setPickModeToolbar( const std::string& _mode , QToolBar * _toolbar ) {};
107
114 virtual void removePickModeToolbar( const std::string& _mode ) {};
115
116
117 private slots:
123 virtual void slotPickModeChanged( const std::string& _mode) {};
124
125 public :
126
128 virtual ~PickingInterface() {};
129
130 };
131
234 Q_DECLARE_INTERFACE(PickingInterface,"OpenFlipper.PickingInterface/1.1")
235
PickingInterface::setPickModeToolbar
virtual void setPickModeToolbar(const std::string &_mode, QToolBar *_toolbar)
Set the additional toolbar of the given PickMode.
Definition: PickingInterface.hh:106
PickingInterface::~PickingInterface
virtual ~PickingInterface()
Destructor.
Definition: PickingInterface.hh:128
PickingInterface::setPickModeCursor
virtual void setPickModeCursor(const std::string &_mode, QCursor _cursor)
Set the cursor of the given PickMode.
Definition: PickingInterface.hh:87
PickingInterface
Allow access to picking functions.
Definition: PickingInterface.hh:62
PickingInterface::slotPickModeChanged
virtual void slotPickModeChanged(const std::string &_mode)
The pickingMode has changed.
Definition: PickingInterface.hh:123
Types.hh
PickingInterface::addPickMode
virtual void addPickMode(const std::string &_mode)
Add a new picking mode to the examiner.
Definition: PickingInterface.hh:68
PickingInterface::addHiddenPickMode
virtual void addHiddenPickMode(const std::string &_mode)
Add a new picking mode to the examiner which will be invisible.
Definition: PickingInterface.hh:78
PickingInterface::setPickModeMouseTracking
virtual void setPickModeMouseTracking(const std::string &_mode, bool _mouseTracking)
Set mouse tracking for the given PickMode.
Definition: PickingInterface.hh:97
PickingInterface::removePickModeToolbar
virtual void removePickModeToolbar(const std::string &_mode)
Removes the additional toolbar of the given PickMode.
Definition: PickingInterface.hh:114