PickingInterface.hh 5.93 KB
Newer Older
 Jan Möbius committed Aug 05, 2009 1 /*===========================================================================*\  Jan Möbius committed Nov 25, 2010 2 3 * * * OpenFlipper *  Jan Möbius committed Jan 26, 2011 4 * Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen *  Jan Möbius committed Nov 25, 2010 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 * www.openflipper.org * * * *--------------------------------------------------------------------------- * * This file is part of OpenFlipper. * * * * OpenFlipper is free software: you can redistribute it and/or modify * * it under the terms of the GNU Lesser General Public License as * * published by the Free Software Foundation, either version 3 of * * the License, or (at your option) any later version with the * * following exceptions: * * * * If other files instantiate templates or use macros * * or inline functions from this file, or you compile this file and * * link it with other files to produce an executable, this file does * * not by itself cause the resulting executable to be covered by the * * GNU Lesser General Public License. This exception does not however * * invalidate any other reasons why the executable file might be * * covered by the GNU Lesser General Public License. * * * * OpenFlipper is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * * GNU Lesser General Public License for more details. * * * * You should have received a copy of the GNU LesserGeneral Public * * License along with OpenFlipper. If not, * * see . * * *  Jan Möbius committed Aug 05, 2009 33 34 35 \*===========================================================================*/ /*===========================================================================*\  Jan Möbius committed Nov 25, 2010 36 37 38 39 40 * * * $Revision$ * * $LastChangedBy$ * * $Date$ * * *  Jan Möbius committed Aug 05, 2009 41 \*===========================================================================*/  Jan Möbius committed Aug 29, 2008 42   Jan Möbius committed Jan 27, 2009 43 44 #ifndef PICKINGINTERFACE_HH #define PICKINGINTERFACE_HH  Jan Möbius committed Aug 29, 2008 45 46 47 48  #include #include #include  Jan Möbius committed Jan 27, 2009 49   Jan Möbius committed Aug 29, 2008 50  /**  Mike Kremer committed Feb 04, 2009 51 52  * \brief Allow access to picking functions. *  Mike Kremer committed Mar 26, 2009 53 54 55  * Interface Class which allows access to picking functions. * * Read tutorial \ref ex3 for an example of how to use mouse picking.  Jan Möbius committed Aug 29, 2008 56 57 58  */ class PickingInterface { signals :  Jan Möbius committed Jan 27, 2009 59 60  /** \brief Add a new picking mode to the examiner *  Jan Möbius committed Aug 29, 2008 61 62  * @param _mode Identifier of Picking mode or "Separator" to add a Separator */  Dirk Wilden committed Dec 09, 2008 63  virtual void addPickMode( const std::string /*_mode*/) {};  Jan Möbius committed Jan 27, 2009 64   Jan Möbius committed Aug 29, 2008 65  /** \brief Add a new picking mode to the examiner which will be invisible  Jan Möbius committed Jan 27, 2009 66  *  Jan Möbius committed Aug 29, 2008 67 68 69  * The added PickMode will not appear in the context menus Picking menu. * You have to provide a button or menuentry yourself if you want to switch to * the picking mode provided here.  Jan Möbius committed Jan 27, 2009 70  *  Jan Möbius committed Aug 29, 2008 71 72  * @param _mode Identifier of Picking mode or "Separator" to add a Separator */  Jan Möbius committed Jan 27, 2009 73 74  virtual void addHiddenPickMode( const std::string /*_mode*/ ) {};  Dirk Wilden committed Dec 09, 2008 75  /** \brief Set the cursor of the given PickMode  Jan Möbius committed Jan 27, 2009 76  *  Dirk Wilden committed Dec 09, 2008 77  * Set the cursor that should be used inside the pickMode  Jan Möbius committed Jan 27, 2009 78  *  Dirk Wilden committed Dec 09, 2008 79 80  * @param _mode Identifier of Picking mode * @param _cursor the new cursor  Jan Möbius committed Aug 29, 2008 81  */  Dirk Wilden committed Dec 09, 2008 82 83 84  virtual void setPickModeCursor( const std::string /*_mode*/ , QCursor /*_cursor*/ ) {}; /** \brief Set mouse tracking for the given PickMode  Jan Möbius committed Jan 27, 2009 85  *  Dirk Wilden committed Dec 09, 2008 86 87  * 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 88  *  Dirk Wilden committed Dec 09, 2008 89 90  * @param _mode Identifier of Picking mode * @param _mouseTracking new state of mouseTracking  Jan Möbius committed Aug 29, 2008 91  */  Dirk Wilden committed Dec 09, 2008 92 93  virtual void setPickModeMouseTracking( const std::string /*_mode*/ , bool /*_mouseTracking*/ ) {};  Jan Möbius committed May 07, 2009 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110  /** \brief Set the additinal toolbar of the given PickMode * * Set the additional toolbar that should be shown in the pickMode * * @param _mode Identifier of Picking mode * @param _toolbar the toolbar */ virtual void setPickModeToolbar( const std::string /*_mode*/ , QToolBar * /*_toolbar*/ ) {}; /** \brief Removes the additinal toolbar of the given PickMode * * Set the additional toolbar that should be shown in the pickMode * * @param _mode Identifier of Picking mode */ virtual void removePickModeToolbar( const std::string /*_mode*/ ) {};  Jan Möbius committed Oct 12, 2009 111 112  private slots:  Jan Möbius committed Aug 29, 2008 113  /** \brief The pickingMode has changed  Jan Möbius committed Jan 27, 2009 114  *  Jan Möbius committed Aug 29, 2008 115 116 117  * This slot is called if the user changes the current picking mode * @param _mode Identifier of Picking mode */  Dirk Wilden committed Sep 30, 2008 118  virtual void slotPickModeChanged( const std::string& /*_mode*/) {};  Jan Möbius committed Jan 27, 2009 119 120 121  public :  Jan Möbius committed Aug 29, 2008 122 123  /// Destructor virtual ~PickingInterface() {};  Jan Möbius committed Jan 27, 2009 124   Jan Möbius committed Aug 29, 2008 125 126 };  Dirk Wilden committed Dec 09, 2008 127 Q_DECLARE_INTERFACE(PickingInterface,"OpenFlipper.PickingInterface/1.1")  Jan Möbius committed Jan 27, 2009 128   Jan Möbius committed Aug 29, 2008 129 #endif // PICKINGINTERFACE_HH