1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef ModuleBase_ITreeNode_H
21 #define ModuleBase_ITreeNode_H
23 #include "ModuleBase.h"
24 #include "ModuleBase_Definitions.h"
26 #include <ModelAPI_Object.h>
27 #include <ModelAPI_Document.h>
34 class ModuleBase_ITreeNode;
35 class ModuleBase_IWorkshop;
37 typedef QList<ModuleBase_ITreeNode*> QTreeNodesList;
39 class ModuleBase_ITreeNode
42 enum VisibilityState {
49 /// Default constructor
50 ModuleBase_ITreeNode(ModuleBase_ITreeNode* theParent = 0) : myParent(theParent) {}
52 virtual ~ModuleBase_ITreeNode() { deleteChildren(); }
54 virtual std::string type() const = 0;
56 /// Returns the node representation according to theRole.
57 virtual QVariant data(int theColumn, int theRole) const { return QVariant(); }
59 /// Returns properties flag of the item
60 virtual Qt::ItemFlags flags(int theColumn) const {
61 return Qt::ItemIsSelectable | Qt::ItemIsEnabled;
64 /// Returns parent node of the current node
65 ModuleBase_ITreeNode* parent() const { return myParent; }
67 /// Returns list of the node children
68 QTreeNodesList children() const { return myChildren; }
70 /// Returns a children node according to given row (index)
71 ModuleBase_ITreeNode* subNode(int theRow) const
73 if ((theRow > -1) && (theRow < myChildren.length()))
74 return myChildren.at(theRow);
78 /// Finds a node which contains the referenced object
79 /// \param theObj an object to find
80 /// \param allLevels if true then all sub-trees will be processed
81 ModuleBase_ITreeNode* subNode(const ObjectPtr& theObj, bool allLevels = true) const
83 foreach(ModuleBase_ITreeNode* aNode, myChildren) {
84 if (aNode->object() == theObj)
87 ModuleBase_ITreeNode* aSubNode = aNode->subNode(theObj, allLevels);
95 /// Returns true if the given node is found within children
96 /// \param theNode a node to find
97 /// \param allLevels if true then all sub-trees will be processed
98 bool hasSubNode(ModuleBase_ITreeNode* theNode, bool allLevels = true) const
100 foreach(ModuleBase_ITreeNode* aNode, myChildren) {
101 if (aNode == theNode)
104 if (aNode->hasSubNode(theNode))
111 /// Returns number of children
112 int childrenCount() const { return myChildren.length(); }
114 int nodeRow(ModuleBase_ITreeNode* theNode) const { return myChildren.indexOf(theNode); }
116 /// Returns object referenced by the node (can be null)
117 virtual ObjectPtr object() const { return ObjectPtr(); }
119 /// Updates all sub-nodes of the node (checks whole sub-tree)
120 virtual void update() {}
122 /// Process creation of objects.
123 /// \param theObjects a list of created objects
124 /// \return a list of nodes which corresponds to the created objects
125 virtual QTreeNodesList objectCreated(const QObjectPtrList& theObjects) {
126 return QTreeNodesList();
129 /// Process deletion of objects.
130 /// \param theDoc a document where objects were deleted
131 /// \param theGroup a name of group where objects were deleted
132 /// \return a list of parents where nodes were deleted
133 virtual QTreeNodesList objectsDeleted(const DocumentPtr& theDoc, const QString& theGroup)
134 { return QTreeNodesList(); }
136 /// Returns workshop object. Has to be reimplemented in a root node
137 virtual ModuleBase_IWorkshop* workshop() const { return parent()->workshop(); }
139 /// Returns document object of the sub-tree. Has to be reimplemented in sub-tree root object
140 virtual DocumentPtr document() const { return parent()->document(); }
142 /// Returns a node which belongs to the given document and contains objects of the given group
143 /// \param theDoc a document
144 /// \param theGroup a name of objects group
145 /// \return a parent node if it is found
146 virtual ModuleBase_ITreeNode* findParent(const DocumentPtr& theDoc, QString theGroup)
149 /// Returns root node of a data tree of the given document
150 /// \param theDoc a document
151 /// \return a tree node which is a root of the document structure
152 virtual ModuleBase_ITreeNode* findRoot(const DocumentPtr& theDoc)
154 if (document() == theDoc)
156 ModuleBase_ITreeNode* aRoot;
157 foreach(ModuleBase_ITreeNode* aNode, myChildren) {
158 aRoot = aNode->findRoot(theDoc);
165 /// Returns visibilitystate of the node in viewer 3d
166 virtual VisibilityState visibilityState() const { return NoneState; }
170 /// deletes all children nodes (called in destructor.)
171 virtual void deleteChildren()
173 while (myChildren.size()) {
174 ModuleBase_ITreeNode* aNode = myChildren.takeLast();
179 void sortChildren() {
180 if (myChildren.size() > 1) {
182 ModuleBase_ITreeNode* aNode = 0;
186 int aSize = myChildren.size();
187 int aMaxCount = aSize * aSize;
191 // To avoid unlimited cycling
192 if (aCount > aMaxCount)
195 aNode = myChildren.at(i);
196 aObject = aNode->object();
198 aIdx = aObject->document()->index(aObject, true) + aShift;
200 myChildren.removeAll(aNode);
201 myChildren.insert(aIdx, aNode);
213 ModuleBase_ITreeNode* myParent; //!< Parent of the node
214 QTreeNodesList myChildren; //!< Children of the node