OpenWalnut  1.2.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
WCrosshair.h
1 //---------------------------------------------------------------------------
2 //
3 // Project: OpenWalnut ( http://www.openwalnut.org )
4 //
5 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
6 // For more information see http://www.openwalnut.org/copying
7 //
8 // This file is part of OpenWalnut.
9 //
10 // OpenWalnut is free software: you can redistribute it and/or modify
11 // it under the terms of the GNU Lesser General Public License as published by
12 // the Free Software Foundation, either version 3 of the License, or
13 // (at your option) any later version.
14 //
15 // OpenWalnut is distributed in the hope that it will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 // GNU Lesser General Public License for more details.
19 //
20 // You should have received a copy of the GNU Lesser General Public License
21 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
22 //
23 //---------------------------------------------------------------------------
24 
25 #ifndef WCROSSHAIR_H
26 #define WCROSSHAIR_H
27 
28 #include <boost/shared_ptr.hpp>
29 #include "../common/math/linearAlgebra/WLinearAlgebra.h"
30 
31 #include "WExportKernel.h"
32 
33 /**
34  * This class stores the position of the crossing navigation slices,
35  * which is also represented as crosshairs in the navigation widgets.
36  * It can be used for placing things. An example are the ROIBoxes which
37  * are placed at the crosshairs position at the moment I am writing this.
38  */
39 class OWKERNEL_EXPORT WCrosshair
40 {
41 public:
42  /**
43  * Get the position of the crosshair.
44  *
45  * \return the position
46  */
47  WPosition getPosition();
48 
49  /**
50  * Set the position of the crosshair for updating it.
51  *
52  * \param position The new position.
53  */
54  void setPosition( WPosition position );
55 
56 protected:
57 private:
58  WPosition m_position; //!< Stores the current position of the crosshair.
59 };
60 
61 #endif // WCROSSHAIR_H