Salome HOME
Updated copyright comment
[modules/gui.git] / src / SUIT / SUIT_SelectionMgr.cxx
old mode 100755 (executable)
new mode 100644 (file)
index b8916f8..3e68c42
+// Copyright (C) 2007-2024  CEA, EDF, OPEN CASCADE
+//
+// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+//
+// This library 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 2.1 of the License, or (at your option) any later version.
+//
+// This library 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 this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
 #include "SUIT_SelectionMgr.h"
 
-SUIT_SelectionMgr::SUIT_SelectionMgr( const bool Feedback )
-: myIterations( Feedback ? 1 : 0 ),
+#include "SUIT_Selector.h"
+#include "SUIT_SelectionFilter.h"
+
+/*!\class SUIT_SelectionMgr
+ * Provide selection manager. Manipulate by selection filters, modes, data owners.
+ */
+
+/*!constructor. initialize myIterations and myIsSelChangeEnabled.*/
+SUIT_SelectionMgr::SUIT_SelectionMgr( const bool Feedback, QObject* p )
+: QObject( p ),
+myIterations( Feedback ? 1 : 0 ),
+myAutoDelFilter( false ),
 myIsSelChangeEnabled( true )
 {
 }
 
+/*!destructor. mySelectors auto delete.*/
 SUIT_SelectionMgr::~SUIT_SelectionMgr()
 {
+  while( !mySelectors.empty() ) {
+    SelectorList::iterator it = mySelectors.begin();
+    delete *it;
+  }
 }
 
+/*!Add selector \a sel to selectors list,if it's not exists in list.*/
 void SUIT_SelectionMgr::installSelector( SUIT_Selector* sel )
 {
   if ( sel && !mySelectors.contains( sel ) )
     mySelectors.append( sel );
 }
 
+/*!Remove selector \a sel from list.*/
 void SUIT_SelectionMgr::removeSelector( SUIT_Selector* sel )
 {
-  mySelectors.remove( sel );
+  mySelectors.removeAll( sel );
 }
 
-void SUIT_SelectionMgr::selectors( QPtrList<SUIT_Selector>& lst ) const
+/*!Gets selectors list to \a lst.*/
+void SUIT_SelectionMgr::selectors( QList<SUIT_Selector*>& lst ) const
 {
   lst.clear();
-  for ( SelectorListIterator it( mySelectors ); it.current(); ++it )
-    lst.append( it.current() );
+  for ( SelectorList::const_iterator it = mySelectors.begin(); it != mySelectors.end(); ++it )
+    lst.append( *it );
 }
 
-void SUIT_SelectionMgr::selectors( const QString& typ, QPtrList<SUIT_Selector>& lst ) const
+/*!Gets selectors list to \a lst with type \a typ.*/
+void SUIT_SelectionMgr::selectors( const QString& typ, QList<SUIT_Selector*>& lst ) const
 {
   lst.clear();
-  for ( SelectorListIterator it( mySelectors ); it.current(); ++it )
+  for ( SelectorList::const_iterator it = mySelectors.begin(); it != mySelectors.end(); ++it )
   {
-    if ( it.current()->type() == typ )
-      lst.append( it.current() );
+    if ( (*it)->type() == typ )
+      lst.append( *it );
   }
 }
 
+/*! Sets ebabled to \a on for all data owners with type \a typ.
+*/
 void SUIT_SelectionMgr::setEnabled( const bool on, const QString& typ )
 {
-  for ( SelectorListIterator it( mySelectors ); it.current(); ++it )
+  for ( SelectorList::const_iterator it = mySelectors.begin(); it != mySelectors.end(); ++it )
   {
-    if ( typ.isEmpty() || it.current()->type() == typ )
-      it.current()->setEnabled( on );
+    if ( typ.isEmpty() || (*it)->type() == typ )
+      (*it)->setEnabled( on );
   }
 }
 
-void SUIT_SelectionMgr::selected( SUIT_DataOwnerPtrList& lst, const QString& type ) const
+/*! Gets selected data owners from list with type \a type to list \a lst.
+*/
+void SUIT_SelectionMgr::selected( SUIT_DataOwnerPtrList& lst, const QString& type, const bool onlyOne ) const
 {
   lst.clear();
 
-  QMap<const SUIT_DataOwner*, int> map;
-  for ( SelectorListIterator it( mySelectors ); it.current(); ++it )
+  for ( SelectorList::const_iterator it = mySelectors.begin(); it != mySelectors.end(); ++it )
   {
-    if ( !type.isEmpty() && it.current()->type() != type )
+    if ( !(*it)->isEnabled() )
+      continue;
+    if ( !type.isEmpty() && (*it)->type() != type )
       continue;
-    SUIT_DataOwnerPtrList curList;
-    it.current()->selected( curList );
-    for ( SUIT_DataOwnerPtrList::const_iterator itr = curList.begin(); itr != curList.end(); ++itr )
+
+    SUIT_DataOwnerPtrList curList( /*skipAllEqual=*/false );
+    (*it)->selected( curList );
+    if ( onlyOne )
+    {
+      for ( SUIT_DataOwnerPtrList::const_iterator itr = curList.begin(); itr != curList.end(); ++itr )
+      {
+        lst.append( *itr );
+        if ( lst.count() > 1 )
+        {
+          lst.clear();
+          return;
+        }
+      }
+    }
+    else
     {
-      const SUIT_DataOwnerPtr& ptr = *itr;
-      if ( !map.contains( ptr.operator->() ) )
-        lst.append( ptr );
-      map.insert( ptr.operator->(), 0 );
+      for ( SUIT_DataOwnerPtrList::const_iterator itr = curList.begin(); itr != curList.end(); ++itr )
+        lst.append( *itr );
     }
   }
 }
 
+/*! Sets selected data owners from \a lst and append to list, if \a append - true.
+*/
 void SUIT_SelectionMgr::setSelected( const SUIT_DataOwnerPtrList& lst, const bool append )
 {
   SUIT_DataOwnerPtrList owners;
   filterOwners( lst, owners );
 
-  for ( SelectorListIterator it( mySelectors ); it.current(); ++it )
+  for ( SelectorList::const_iterator it = mySelectors.begin(); it != mySelectors.end(); ++it )
   {
     if ( append )
     {
       SUIT_DataOwnerPtrList current;
-      it.current()->selected( current );
+      (*it)->selected( current );
       for ( SUIT_DataOwnerPtrList::const_iterator it = current.begin(); it != current.end(); ++it )
         owners.append( *it );
     }
-    it.current()->setSelected( owners );
+    (*it)->setSelected( owners );
   }
 }
 
+/*! Clear selected data owners.
+*/
 void SUIT_SelectionMgr::clearSelected()
 {
   setSelected( SUIT_DataOwnerPtrList() );
 }
 
+/*! On selection \a sel changed.
+*/
 void SUIT_SelectionMgr::selectionChanged( SUIT_Selector* sel )
 {
   if ( !sel || !myIsSelChangeEnabled || !sel->isEnabled() )
@@ -106,11 +169,11 @@ void SUIT_SelectionMgr::selectionChanged( SUIT_Selector* sel )
 
   for ( int i = 0; i < myIterations; i++ )
   {
-    for ( SUIT_Selector* aSel = mySelectors.first(); aSel; aSel = mySelectors.next() )
+    for ( SelectorList::iterator it = mySelectors.begin(); it != mySelectors.end(); ++it )
     {
       // Temporary action(to avoid selection of the objects which don't pass the filters):
-      //if ( aSel != sel )
-       aSel->setSelected( newOwners );
+      //if ( *it != sel )
+        (*it)->setSelected( newOwners );
     }
   }
   myIsSelChangeEnabled = true;
@@ -118,62 +181,87 @@ void SUIT_SelectionMgr::selectionChanged( SUIT_Selector* sel )
   emit selectionChanged();
 }
 
+/*!
+  Returns true if selection manger is in synchronising mode
+  (during synchonisation of the selectors selection).
+*/
+bool SUIT_SelectionMgr::isSynchronizing() const
+{
+  return !myIsSelChangeEnabled;
+}
+
+/*! Checks: Is selection manager has selection mode \a mode?
+*/
 bool SUIT_SelectionMgr::hasSelectionMode( const int mode ) const
 {
   return mySelModes.contains( mode );
 }
 
-void SUIT_SelectionMgr::selectionModes( QValueList<int>& vals ) const
+/*! Gets selection modes to list \a vals.
+*/
+void SUIT_SelectionMgr::selectionModes( QList<int>& vals ) const
 {
   vals = mySelModes;
 }
 
+/*! Set selection mode \a mode to list of selection modes.
+*/
 void SUIT_SelectionMgr::setSelectionModes( const int mode )
 {
-  QValueList<int> lst;
+  QList<int> lst;
   lst.append( mode );
   setSelectionModes( lst );
 }
 
-void SUIT_SelectionMgr::setSelectionModes( const QValueList<int>& lst )
+/*! Sets selection modes list from \a lst.
+*/
+void SUIT_SelectionMgr::setSelectionModes( const QList<int>& lst )
 {
   mySelModes = lst;
 }
 
+/*! Append selection mode \a mode to list of selection modes.
+*/
 void SUIT_SelectionMgr::appendSelectionModes( const int mode )
 {
-  QValueList<int> lst;
+  QList<int> lst;
   lst.append( mode );
   appendSelectionModes( lst );
 }
 
-void SUIT_SelectionMgr::appendSelectionModes( const QValueList<int>& lst )
+/*! Append selection modes \a lst list.
+*/
+void SUIT_SelectionMgr::appendSelectionModes( const QList<int>& lst )
 {
   QMap<int, int> map;
-  for ( QValueList<int>::const_iterator it = mySelModes.begin(); it != mySelModes.end(); ++it )
+  for ( QList<int>::const_iterator it = mySelModes.begin(); it != mySelModes.end(); ++it )
     map.insert( *it, 0 );
 
-  for ( QValueList<int>::const_iterator itr = lst.begin(); itr != lst.end(); ++itr )
+  for ( QList<int>::const_iterator itr = lst.begin(); itr != lst.end(); ++itr )
   {
     if ( !map.contains( *itr ) )
       mySelModes.append( *itr );
   }
 }
 
+/*! Remove selection mode \a mode from list.
+*/
 void SUIT_SelectionMgr::removeSelectionModes( const int mode )
 {
-  QValueList<int> lst;
+  QList<int> lst;
   lst.append( mode );
   removeSelectionModes( lst );
 }
 
-void SUIT_SelectionMgr::removeSelectionModes( const QValueList<int>& lst )
+/*! Remove selection modea \a lst from list.
+*/
+void SUIT_SelectionMgr::removeSelectionModes( const QList<int>& lst )
 {
   QMap<int, int> map;
-  for ( QValueList<int>::const_iterator it = mySelModes.begin(); it != mySelModes.end(); ++it )
+  for ( QList<int>::const_iterator it = mySelModes.begin(); it != mySelModes.end(); ++it )
     map.insert( *it, 0 );
 
-  for ( QValueList<int>::const_iterator itr = lst.begin(); itr != lst.end(); ++itr )
+  for ( QList<int>::const_iterator itr = lst.begin(); itr != lst.end(); ++itr )
     map.remove( *itr );
 
   mySelModes.clear();
@@ -181,18 +269,22 @@ void SUIT_SelectionMgr::removeSelectionModes( const QValueList<int>& lst )
     mySelModes.append( iter.key() );
 }
 
+/*! Checks data owner is ok?
+*/
 bool SUIT_SelectionMgr::isOk( const SUIT_DataOwner* owner ) const
 {
   if ( !owner )
     return false;
 
   bool ok = true;
-  for ( SelFilterListIterator it( myFilters ); it.current() && ok; ++it )
-    ok = it.current()->isOk( owner );
+  for ( SelFilterList::const_iterator it = myFilters.begin(); it != myFilters.end() && ok; ++it )
+    ok = (*it)->isOk( owner );
 
   return ok;
 }
 
+/*! Checks data owner pointer is ok?
+*/
 bool SUIT_SelectionMgr::isOk( const SUIT_DataOwnerPtr& ptr ) const
 {
   if ( ptr.isNull() )
@@ -201,11 +293,15 @@ bool SUIT_SelectionMgr::isOk( const SUIT_DataOwnerPtr& ptr ) const
   return isOk( ptr.operator->() );
 }
 
+/*! Checks selection manager has filter \a f?
+*/
 bool SUIT_SelectionMgr::hasFilter( SUIT_SelectionFilter* f ) const
 {
   return myFilters.contains( f );
 }
 
+/*! Install filter \a f and set selected, if \a update = true.
+*/
 void SUIT_SelectionMgr::installFilter( SUIT_SelectionFilter* f, const bool updateSelection )
 {
   if ( !hasFilter( f ) )
@@ -221,26 +317,48 @@ void SUIT_SelectionMgr::installFilter( SUIT_SelectionFilter* f, const bool updat
   }
 }
 
+/*! Remove filter \a f from filters list.
+*/
 void SUIT_SelectionMgr::removeFilter( SUIT_SelectionFilter* f )
 {
-  myFilters.remove( f );
+  if ( !myFilters.contains( f ) )
+    return;
+
+  myFilters.removeAll( f );
+
+  if ( autoDeleteFilter() )
+    delete f;
 }
 
+/*! Clear filters list.
+*/
 void SUIT_SelectionMgr::clearFilters()
 {
+  if ( autoDeleteFilter() )
+  {
+    for ( SelFilterList::const_iterator it = myFilters.begin(); it != myFilters.end(); ++it )
+      delete *it;
+  }
+
   myFilters.clear();
 }
 
+/*! Sets auto delete filter.
+*/
 bool SUIT_SelectionMgr::autoDeleteFilter() const
 {
-  return myFilters.autoDelete();
+  return myAutoDelFilter;
 }
 
+/*! Sets auto delete filter to \a on.
+*/
 void SUIT_SelectionMgr::setAutoDeleteFilter( const bool on )
 {
-  myFilters.setAutoDelete( on );
+  myAutoDelFilter = on;
 }
 
+/*! Gets good data owners list to \a out from \a in.
+*/
 void SUIT_SelectionMgr::filterOwners( const SUIT_DataOwnerPtrList& in, SUIT_DataOwnerPtrList& out ) const
 {
   out.clear();
@@ -249,4 +367,4 @@ void SUIT_SelectionMgr::filterOwners( const SUIT_DataOwnerPtrList& in, SUIT_Data
     if ( isOk( *it ) )
       out.append( *it );
   }
-}
+}
\ No newline at end of file