OpenWalnut  1.4.0
WGELayoutableItem.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 WGELAYOUTABLEITEM_H
00026 #define WGELAYOUTABLEITEM_H
00027 
00028 #include <osg/Vec3>
00029 
00030 /**
00031  * This class builds the base for graphical items that can be layouted using WGEItemLayouter instances. The layoutable item needs to overwrite
00032  * the getAnchor method, telling the layout algorithm where the items anchor point is situated. Depending on the layout, the item is placed there
00033  * or somewhere else with a leader-line to the anchor point.
00034  */
00035 class WGELayoutableItem
00036 {
00037 public:
00038     /**
00039      * Default constructor.
00040      */
00041     WGELayoutableItem();
00042 
00043     /**
00044      * Destructor.
00045      */
00046     virtual ~WGELayoutableItem();
00047 
00048     /**
00049      * Gets the current anchor point of the item.
00050      *
00051      * \return the anchor.
00052      */
00053     virtual osg::Vec3 getAnchor() const = 0;
00054 
00055 protected:
00056 private:
00057 };
00058 
00059 #endif  // WGELAYOUTABLEITEM_H
00060