OpenWalnut  1.4.0
WCrosshair.h
00001 //---------------------------------------------------------------------------
00002 //
00003 // Project: OpenWalnut ( http://www.openwalnut.org )
00004 //
00005 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
00006 // For more information see http://www.openwalnut.org/copying
00007 //
00008 // This file is part of OpenWalnut.
00009 //
00010 // OpenWalnut is free software: you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as published by
00012 // the Free Software Foundation, either version 3 of the License, or
00013 // (at your option) any later version.
00014 //
00015 // OpenWalnut is distributed in the hope that it will be useful,
00016 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00018 // GNU Lesser General Public License for more details.
00019 //
00020 // You should have received a copy of the GNU Lesser General Public License
00021 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
00022 //
00023 //---------------------------------------------------------------------------
00024 
00025 #ifndef WCROSSHAIR_H
00026 #define WCROSSHAIR_H
00027 
00028 #include <boost/shared_ptr.hpp>
00029 #include "../common/math/linearAlgebra/WPosition.h"
00030 
00031 
00032 
00033 /**
00034  * This class stores the position of the crossing navigation slices,
00035  * which is also represented as crosshairs in the navigation widgets.
00036  * It can be used for placing things. An example are the ROIBoxes which
00037  * are placed at the crosshairs position at the moment I am writing this.
00038  */
00039 class  WCrosshair
00040 {
00041 public:
00042     /**
00043      * Get the position of the crosshair.
00044      *
00045      * \return the position
00046      */
00047     WPosition getPosition();
00048 
00049     /**
00050      * Set the position of the crosshair for updating it.
00051      *
00052      * \param position The new position.
00053      */
00054     void setPosition( WPosition position );
00055 
00056 protected:
00057 private:
00058     WPosition m_position; //!< Stores the current position of the crosshair.
00059 };
00060 
00061 #endif  // WCROSSHAIR_H