src/ModuleBase/ModuleBase_ITreeNode.h

   1 // Copyright (C) 2014-2023  CEA, EDF
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef ModuleBase_ITreeNode_H
  21 #define ModuleBase_ITreeNode_H
  22
  23 #include "ModuleBase.h"
  24 #include "ModuleBase_Definitions.h"
  25
  26 #include <ModelAPI_Object.h>
  27 #include <ModelAPI_Document.h>
  28
  29 #include <QList>
  30 #include <QString>
  31 #include <QIcon>
  32 #include <QVariant>
  33
  34 #ifdef _MSC_VER
  35 #pragma warning(disable: 4100)
  36 #endif
  37
  38 class ModuleBase_ITreeNode;
  39 class ModuleBase_IWorkshop;
  40
  41 typedef QList<ModuleBase_ITreeNode*> QTreeNodesList;
  42
  43 class ModuleBase_ITreeNode
  44 {
  45 public:
  46   enum VisibilityState {
  47     NoneState,
  48     Visible,
  49     SemiVisible,
  50     Hidden
  51   };
  52
  53   /// Default constructor
  54   ModuleBase_ITreeNode(ModuleBase_ITreeNode* theParent = 0) : myParent(theParent) {}
  55
  56   virtual ~ModuleBase_ITreeNode() { deleteChildren(); }
  57
  58   virtual std::string type() const = 0;
  59
  60   /// Returns the node representation according to theRole.
  61   virtual QVariant data(int theColumn, int theRole) const { return QVariant(); }
  62
  63   /// Returns properties flag of the item
  64   virtual Qt::ItemFlags flags(int theColumn) const {
  65     return Qt::ItemIsSelectable | Qt::ItemIsEnabled;
  66   }
  67
  68   /// Returns parent node of the current node
  69   ModuleBase_ITreeNode* parent() const { return myParent; }
  70
  71   /// Returns list of the node children
  72   QTreeNodesList children() const { return myChildren; }
  73
  74   /// Returns a children node according to given row (index)
  75   ModuleBase_ITreeNode* subNode(int theRow) const
  76   {
  77     if ((theRow > -1) && (theRow < myChildren.length()))
  78       return myChildren.at(theRow);
  79     return 0;
  80   }
  81
  82   /// Finds a node which contains the referenced object
  83   /// \param theObj an object to find
  84   /// \param allLevels if true then all sub-trees will be processed
  85   ModuleBase_ITreeNode* subNode(const ObjectPtr& theObj, bool allLevels = true) const
  86   {
  87     foreach(ModuleBase_ITreeNode* aNode, myChildren) {
  88       if (aNode->object() == theObj)
  89         return aNode;
  90       if (allLevels) {
  91         ModuleBase_ITreeNode* aSubNode = aNode->subNode(theObj, allLevels);
  92         if (aSubNode)
  93           return aSubNode;
  94       }
  95     }
  96     return 0;
  97   }
  98
  99   /// Returns true if the given node is found within children
 100   /// \param theNode a node to find
 101   /// \param allLevels if true then all sub-trees will be processed
 102   bool hasSubNode(ModuleBase_ITreeNode* theNode, bool allLevels = true) const
 103   {
 104     foreach(ModuleBase_ITreeNode* aNode, myChildren) {
 105       if (aNode == theNode)
 106         return true;
 107       if (allLevels) {
 108         if (aNode->hasSubNode(theNode))
 109           return true;
 110       }
 111     }
 112     return false;
 113   }
 114
 115   /// Returns number of children
 116   int childrenCount() const { return myChildren.length(); }
 117
 118   int nodeRow(ModuleBase_ITreeNode* theNode) const { return myChildren.indexOf(theNode); }
 119
 120   /// Returns object referenced by the node (can be null)
 121   virtual ObjectPtr object() const { return ObjectPtr(); }
 122
 123   /// Updates all sub-nodes of the node (checks whole sub-tree)
 124   virtual void update() {}
 125
 126   /// Process creation of objects.
 127   /// \param theObjects a list of created objects
 128   /// \return a list of nodes which corresponds to the created objects
 129   virtual QTreeNodesList objectCreated(const QObjectPtrList& theObjects) {
 130     return QTreeNodesList();
 131   }
 132
 133   /// Process deletion of objects.
 134   /// \param theDoc a document where objects were deleted
 135   /// \param theGroup a name of group where objects were deleted
 136   /// \return a list of parents where nodes were deleted
 137   virtual QTreeNodesList objectsDeleted(const DocumentPtr& theDoc, const QString& theGroup)
 138   { return QTreeNodesList(); }
 139
 140   /// Returns workshop object. Has to be reimplemented in a root node
 141   virtual ModuleBase_IWorkshop* workshop() const { return parent()->workshop(); }
 142
 143   /// Returns document object of the sub-tree. Has to be reimplemented in sub-tree root object
 144   virtual DocumentPtr document() const { return parent()->document(); }
 145
 146   /// Returns a node which belongs to the given document and contains objects of the given group
 147   /// \param theDoc a document
 148   /// \param theGroup a name of objects group
 149   /// \return a parent node if it is found
 150   virtual ModuleBase_ITreeNode* findParent(const DocumentPtr& theDoc, QString theGroup)
 151   { return 0; }
 152
 153   /// Returns root node of a data tree of the given document
 154   /// \param theDoc a document
 155   /// \return a tree node which is a root of the document structure
 156   virtual ModuleBase_ITreeNode* findRoot(const DocumentPtr& theDoc)
 157   {
 158     if (document() == theDoc)
 159       return this;
 160     ModuleBase_ITreeNode* aRoot;
 161     foreach(ModuleBase_ITreeNode* aNode, myChildren) {
 162       aRoot = aNode->findRoot(theDoc);
 163       if (aRoot)
 164         return aRoot;
 165     }
 166     return 0;
 167   }
 168
 169   /// Returns visibilitystate of the node in viewer 3d
 170   virtual VisibilityState visibilityState() const { return NoneState; }
 171
 172 protected:
 173
 174   /// deletes all children nodes (called in destructor.)
 175   virtual void deleteChildren()
 176   {
 177     while (myChildren.size()) {
 178       ModuleBase_ITreeNode* aNode = myChildren.takeLast();
 179       delete aNode;
 180     }
 181   }
 182
 183   void sortChildren() {
 184     if (myChildren.size() > 1) {
 185       int i = 0;
 186       ModuleBase_ITreeNode* aNode = 0;
 187       ObjectPtr aObject;
 188       int aIdx;
 189       int aCount = 0;
 190       int aSize = myChildren.size();
 191       int aMaxCount = aSize * aSize;
 192       int aShift = 0;
 193       while (i < aSize) {
 194         aCount++;
 195         // To avoid unlimited cycling
 196         if (aCount > aMaxCount)
 197           break;
 198
 199         aNode = myChildren.at(i);
 200         aObject = aNode->object();
 201         if (aObject.get()) {
 202           aIdx = aObject->document()->index(aObject, true) + aShift;
 203           if (aIdx != i) {
 204             myChildren.removeAll(aNode);
 205             myChildren.insert(aIdx, aNode);
 206             i = 0;
 207             continue;
 208           }
 209         }
 210         else
 211           aShift++;
 212         i++;
 213       }
 214     }
 215   }
 216
 217   ModuleBase_ITreeNode* myParent; //!< Parent of the node
 218   QTreeNodesList myChildren; //!< Children of the node
 219 };
 220
 221 #endif