WRMBranch.h

//---------------------------------------------------------------------------
//
// Project: OpenWalnut ( http://www.openwalnut.org )
//
// Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
// For more information see http://www.openwalnut.org/copying
//
// This file is part of OpenWalnut.
//
// OpenWalnut 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.
//
// OpenWalnut 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 Lesser General Public License
// along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
//
//---------------------------------------------------------------------------
 
#ifndef WRMBRANCH_H
#define WRMBRANCH_H
 
#include <algorithm>
#include <list>
#include <memory>
#include <shared_mutex>
#include <string>
#include <vector>
 
#include "../common/WProperties.h"
#include "../graphicsEngine/WROI.h"
 
class WROIManager;
 
/**
 * implements a branch in the tree like structure for rois
 */
class  WRMBranch : public std::enable_shared_from_this< WRMBranch >
{
public:
    /**
     * Convenience type for a shared pointer of this type
     */
    typedef std::shared_ptr< WRMBranch > SPtr;
 
    /**
     * Convenience type for a const shared pointer of this type
     */
    typedef std::shared_ptr< const WRMBranch > ConstSPtr;
 
    /**
     * construtor
     * \param roiManager
     */
    explicit WRMBranch( std::shared_ptr< WROIManager > roiManager );
 
    /**
     * destructor
     */
    ~WRMBranch();
 
    /**
     * Get name property.
     *
     * \return  name property
     */
    WPropString nameProperty();
 
    /**
     * Get the "not" property.
     *
     * \return the property
     */
    WPropBool invertProperty();
 
    /**
     * The branch color property.
     *
     * \return the color property
     */
    WPropColor colorProperty();
 
    /**
     * Get the properties of this branch as group.
     *
     * \return branch property group
     */
    WPropertyGroup::SPtr getProperties() const;
 
    /**
     * adds a roi to the branch
     *
     * \param roi
     */
    void addRoi( osg::ref_ptr< WROI > roi );
 
    /**
     * removes a roi from the branch
     *
     * \param roi
     */
    void removeRoi( osg::ref_ptr< WROI > roi );
 
    /**
     * removes all rois from the branch
     *
     */
    void removeAllRois();
 
    /**
     * getter for dirty flag
     *
     * \param reset when true the dirty flag will be set to false
     * \return the dirty flag
     */
    bool dirty( bool reset = false );
 
    /**
     * sets dirty flag true and notifies the branch
     */
    void setDirty();
 
    /**
     * returns whether the branch is empty.
     *
     * \return true if empty.
     */
    bool empty();
 
    /**
     * checks wether a roi is in this branch
     * \param roi
     * \return true if the roi is in the branch, false otherwise
     */
    bool contains( osg::ref_ptr< WROI > roi );
 
    /**
     * returns a pointer to the first roi in the branch
     *
     * \return the roi
     */
    osg::ref_ptr< WROI > getFirstRoi();
 
    /**
     * getter for roi manager pointer
     *
     * \return the roi manager
     */
    std::shared_ptr< WROIManager > getRoiManager();
 
    /**
     * returns the properties object.
     *
     * \return the properties of this branch
     */
    std::shared_ptr< WProperties > getProperties();
 
    /**
     * getter for the NOT flag
     * \return flag
     */
    bool isNot();
 
    /**
     * add all the rois in this branch to a given vector
     * \param roiVec the vector to fill
     */
    void getRois( std::vector< osg::ref_ptr< WROI > >& roiVec ); //NOLINT
 
    /**
     * Create a list of ROIs of the current point in time.
     *
     * \return the ROIs
     */
    std::vector< osg::ref_ptr< WROI > > getRois() const;
 
    /**
     * Add a specified notifier to the list of default notifiers which get connected to each branch
     *
     * \param notifier  the notifier function
     */
    void addChangeNotifier( std::shared_ptr< boost::function< void() > > notifier );
 
    /**
     * Remove a specified notifier from the list of default notifiers which get connected to each branch
     *
     * \param notifier  the notifier function
     */
    void removeChangeNotifier( std::shared_ptr< boost::function< void() > > notifier );
 
    /**
     * Resorts the ROIs using the specified comparator from its begin to its end.
     *
     * \tparam Comparator the comparator type. Usually a boost::function or class providing the operator<().
     *
     * \param comp the comparator
     */
    template < typename Comparator >
    void sort( Comparator comp );
 
protected:
    /**
     * initializes properties
     */
    void properties();
 
    /**
     * slot gets called when a property has changed
     *
     */
    void propertyChanged();
private:
    std::shared_ptr< WROIManager > m_roiManager; //!< stores a pointer to the roi manager
 
    std::vector< osg::ref_ptr< WROI > > m_rois; //!< list of rois in this this branch,
                                                  // first in the list is the main roi
    /**
     * the property object for the module
     */
    std::shared_ptr< WProperties > m_properties;
 
    WPropBool m_dirty; //!< dirty flag to indicate if anything has changed within the branch
 
    /**
     * indicates if the branch is negated
     */
    WPropBool m_isNot;
 
    /**
     * The color used when in isosurface mode for blending.
     */
    WPropColor m_bundleColor;
 
    /**
     * Name property.
     */
    WPropString m_name;
 
    /**
     * The notifiers connected to added rois by default.
     */
    std::list< std::shared_ptr< boost::function< void() > > > m_changeNotifiers;
 
    std::shared_ptr< boost::function< void() > > m_changeRoiSignal; //!< Signal that can be used to update the ROImanager branch
 
    /**
     * Lock for associated notifiers set.
     */
    std::shared_mutex m_associatedNotifiersLock;
};
 
inline bool WRMBranch::empty()
{
    return m_rois.empty();
}
 
inline bool WRMBranch::dirty( bool reset )
{
    bool ret = m_dirty->get();
    if( reset )
    {
        m_dirty->set( false );
    }
    return ret;
}
 
inline bool WRMBranch::isNot()
{
    return m_isNot->get();
}
 
template < typename Comparator >
void WRMBranch::sort( Comparator comp )
{
    // NOTE: technically, we need not setDirty here as the order of the ROIs has no influence
    return std::sort( m_rois.begin(), m_rois.end(), comp );
}
 
#endif  // WRMBRANCH_H