PickingInterface.hh 10.1 KB
Newer Older
 Jan Möbius committed Aug 05, 2009 1 /*===========================================================================*\  Jan Möbius committed Nov 25, 2010 2 3 * * * OpenFlipper *  Martin Schultz committed Jul 16, 2015 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38  * Copyright (c) 2001-2015, RWTH-Aachen University * * Department of Computer Graphics and Multimedia * * All rights reserved. * * www.openflipper.org * * * *---------------------------------------------------------------------------* * This file is part of OpenFlipper. * *---------------------------------------------------------------------------* * * * Redistribution and use in source and binary forms, with or without * * modification, are permitted provided that the following conditions * * are met: * * * * 1. Redistributions of source code must retain the above copyright notice, * * this list of conditions and the following disclaimer. * * * * 2. Redistributions in binary form must reproduce the above copyright * * notice, this list of conditions and the following disclaimer in the * * documentation and/or other materials provided with the distribution. * * * * 3. Neither the name of the copyright holder nor the names of its * * contributors may be used to endorse or promote products derived from * * this software without specific prior written permission. * * * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED * * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A * * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER * * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, * * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR * * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF * * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING * * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *  Jan Möbius committed Nov 25, 2010 39 * *  Jan Möbius committed Aug 05, 2009 40 41 \*===========================================================================*/  Jan Möbius committed Jan 08, 2019 42 #pragma once  Jan Möbius committed Mar 16, 2011 43   Jan Möbius committed Jan 08, 2019 44 45 #include #include  Jan Möbius committed Mar 16, 2011 46 47 48 49 50 51 52  /** \file PickingInterface.hh * * Interface Class which allows access to picking functions. \ref pickingInterfacePage */ /** \brief Allow access to picking functions.  Mike Kremer committed Feb 04, 2009 53  *  Jan Möbius committed Mar 16, 2011 54 55 56 57 58  * \ref pickingInterfacePage "Detailed description" * \n * * Using this interface you can add different pick modes to OpenFlipper and * separate different mouse Interactions depending on the current mode.  Mike Kremer committed Mar 26, 2009 59 60  * * Read tutorial \ref ex3 for an example of how to use mouse picking.  Jan Möbius committed Aug 29, 2008 61 62 63  */ class PickingInterface { signals :  Jan Möbius committed Jan 27, 2009 64 65  /** \brief Add a new picking mode to the examiner *  Jan Möbius committed Aug 29, 2008 66 67  * @param _mode Identifier of Picking mode or "Separator" to add a Separator */  Jan Möbius committed Jan 12, 2012 68  virtual void addPickMode( const std::string& _mode) {};  Jan Möbius committed Jan 27, 2009 69   Jan Möbius committed Aug 29, 2008 70  /** \brief Add a new picking mode to the examiner which will be invisible  Jan Möbius committed Jan 27, 2009 71  *  Jan Möbius committed Aug 29, 2008 72  * The added PickMode will not appear in the context menus Picking menu.  Jan Möbius committed Mar 16, 2011 73  * You have to provide a button or menu entry yourself if you want to switch to  Jan Möbius committed Aug 29, 2008 74  * the picking mode provided here.  Jan Möbius committed Jan 27, 2009 75  *  Jan Möbius committed Aug 29, 2008 76 77  * @param _mode Identifier of Picking mode or "Separator" to add a Separator */  Jan Möbius committed Jan 12, 2012 78  virtual void addHiddenPickMode( const std::string& _mode ) {};  Jan Möbius committed Jan 27, 2009 79   Dirk Wilden committed Dec 09, 2008 80  /** \brief Set the cursor of the given PickMode  Jan Möbius committed Jan 27, 2009 81  *  Dirk Wilden committed Dec 09, 2008 82  * Set the cursor that should be used inside the pickMode  Jan Möbius committed Jan 27, 2009 83  *  Dirk Wilden committed Dec 09, 2008 84 85  * @param _mode Identifier of Picking mode * @param _cursor the new cursor  Jan Möbius committed Aug 29, 2008 86  */  Jan Möbius committed Jan 12, 2012 87  virtual void setPickModeCursor( const std::string& _mode , QCursor _cursor ) {};  Dirk Wilden committed Dec 09, 2008 88 89  /** \brief Set mouse tracking for the given PickMode  Jan Möbius committed Jan 27, 2009 90  *  Dirk Wilden committed Dec 09, 2008 91 92  * Enable mouseTracking for the given PickMode. When MouseTracking is enabled * you receive mouseMove events also when no button is pressed (via MouseInterface)  Jan Möbius committed Jan 27, 2009 93  *  Dirk Wilden committed Dec 09, 2008 94 95  * @param _mode Identifier of Picking mode * @param _mouseTracking new state of mouseTracking  Jan Möbius committed Aug 29, 2008 96  */  Jan Möbius committed Jan 12, 2012 97  virtual void setPickModeMouseTracking( const std::string& _mode , bool _mouseTracking ) {};  Dirk Wilden committed Dec 09, 2008 98   Jan Möbius committed Mar 16, 2011 99  /** \brief Set the additional toolbar of the given PickMode  Jan Möbius committed May 07, 2009 100 101 102 103 104 105  * * Set the additional toolbar that should be shown in the pickMode * * @param _mode Identifier of Picking mode * @param _toolbar the toolbar */  Jan Möbius committed Jan 12, 2012 106  virtual void setPickModeToolbar( const std::string& _mode , QToolBar * _toolbar ) {};  Jan Möbius committed May 07, 2009 107   Jan Möbius committed Mar 16, 2011 108  /** \brief Removes the additional toolbar of the given PickMode  Jan Möbius committed May 07, 2009 109 110 111 112 113  * * Set the additional toolbar that should be shown in the pickMode * * @param _mode Identifier of Picking mode */  Jan Möbius committed Jan 12, 2012 114  virtual void removePickModeToolbar( const std::string& _mode ) {};  Jan Möbius committed May 07, 2009 115   Jan Möbius committed Oct 12, 2009 116 117  private slots:  Jan Möbius committed Aug 29, 2008 118  /** \brief The pickingMode has changed  Jan Möbius committed Jan 27, 2009 119  *  Jan Möbius committed Aug 29, 2008 120 121 122  * This slot is called if the user changes the current picking mode * @param _mode Identifier of Picking mode */  Jan Möbius committed Mar 16, 2011 123  virtual void slotPickModeChanged( const std::string& _mode) {};  Jan Möbius committed Jan 27, 2009 124 125 126  public :  Jan Möbius committed Aug 29, 2008 127 128  /// Destructor virtual ~PickingInterface() {};  Jan Möbius committed Jan 27, 2009 129   Jan Möbius committed Aug 29, 2008 130 131 };  Jan Möbius committed Mar 16, 2011 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 /** \page pickingInterfacePage Picking Interface/Mouse Picking/Pick Mode Toolbars \n \image html PickingInterface.png \n \section pickingInterface_functionality Functionality OpenFlipper uses several different ActionModes. These include, Light interaction (Changing lights), Move interaction (navigating through the scene) and the picking interaction. The picking interaction is separated into different pick modes. These modes are usually defined by plugins and are used to restrict the mouse interaction to one plugin. E.g. if the current picking mode is "vertex selection", all other plugins that react on mouse events, but are not responsible for the "vertex selection" will ignore these events. \section pickingInterface_managing Managing Pick Modes Pick modes can be created in your plugin initialization. You can add them as visible pick modes (visible in the context menus of objects) or as hidden pick modes PickingInterface::addHiddenPickMode() ( This should be preferred! ). You can also set a special cursor that will be used when your pick mode is active via PickingInterface::setPickModeCursor(). If you need to enable mouse tracking in your mode, you can use PickingInterface::setPickModeMouseTracking(). This will result in mouse events even if no button is pressed. \code // When the plugin gets initialized void ExamplePlugin::pluginsInitialized() { // Add pick mode emit addPickMode("ExamplePlugin Pick Mode"); } // Triggered when the pick mode got changed. void ExamplePlugin::slotPickModeChanged(const std::string& _mode) { // Enable a button depending on the current pick mode button_->setEnabled(_mode == "ExamplePlugin Pick Mode"); } // From MouseInterface void ExamplePlugin::slotMouseEvent(QMouseEvent* _event) { // Check if your pick mode is currently active if ( PluginFunctions::pickMode() == "ExamplePlugin Pick Mode" && PluginFunctions::actionMode() == Viewer::PickingMode ) { // Do something } } \endcode A change of the current pick mode can be detected by the PickingInterface::slotPickModeChanged() function. \section pickingInterface_toolbars PickMode Toolbars \n \image html PickModeToolbar.png \n Additionally it is possible to show a special toolbar in OpenFlippers viewer when your pick mode is active. This is especially Useful, when you can change the interaction type by buttons in the bar, e.g. select vertices or faces. Every time your pick mode is activated, your toolbar will be visible at the top of the viewer. Use the functions PickingInterface::setPickModeToolbar() and PickingInterface::removePickModeToolbar() for controlling these toolbars. The embedding is fully transparent so that you can manage your toolbar and connect signals and slots as usual. \code // When the plugin gets initialized void ExamplePlugin::pluginsInitialized() { // Global variable QToolBar* pickToolbar_ pickToolbar_ = new QToolBar(tr("Example Pickmode Toolbar")); pickToolbar_->setAttribute(Qt::WA_AlwaysShowToolTips, true); QActionGroup* pickToolBarActions = new QActionGroup(pickToolbar_); QAction* action = new QAction(tr("Action"),pickToolBarActions); action->setStatusTip(tr("Action description")); action->setIcon(QIcon(OpenFlipper::Options::iconDirStr()+OpenFlipper::Options::dirSeparator()+"icon.png") ); action->setCheckable(true); pickToolbar_->addAction(action); // Connect to a local slot. The embedding is transparent, so you can connect all your actions and toolbars as usual. connect(pickToolBarActions, SIGNAL(triggered(QAction*)), this, SLOT(slotPickToolbarAction(QAction*)) ); emit setPickModeToolbar ("ExamplePlugin Pick Mode", pickToolbar_); } \endcode \section pickingInterface_usage Usage To use the PickingInterface:
• include PickingInterface.hh in your plugins header file
• derive your plugin from the class PickingInterface
• add Q_INTERFACES(PickingInterface) to your plugin class
• And add the signals or slots you want to use to your plugin class (You don't need to implement all of them)
*/  Dirk Wilden committed Dec 09, 2008 234 Q_DECLARE_INTERFACE(PickingInterface,"OpenFlipper.PickingInterface/1.1")  Jan Möbius committed Jan 27, 2009 235