1 // Copyright (C) 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // File : SMESH_Group.idl
24 // Author : Sergey ANIKIN, OCC
27 #ifndef _SMESH_GROUP_IDL_
28 #define _SMESH_GROUP_IDL_
30 #include "SALOME_Exception.idl"
31 #include "SALOME_GenericObj.idl"
32 #include "SALOMEDS_Attributes.idl"
34 #include "SMESH_Mesh.idl"
35 #include "SMESH_smIdType.idl"
43 * SMESH_Group: base interface of group object
45 interface SMESH_GroupBase : SMESH_IDSource
50 void SetName( in string name );
58 * Returns group type (type of elements in the group)
60 ElementType GetType();
63 * Returns the number of elements in the group
68 * Returns true if the group does not contain any elements
73 * returns true if the group contains an element with ID == <elem_id>
75 boolean Contains( in smIdType elem_id );
78 * Returns ID of an element at position <elem_index> counted from 1
80 smIdType GetID( in smIdType elem_index );
83 * Returns a sequence of all element IDs in the group
85 smIdType_array GetListOfID();
88 * Get the number of nodes of cells included to the group
89 * For a nodal group returns the same value as Size() function
91 smIdType GetNumberOfNodes();
94 * Get IDs of nodes of cells included to the group
95 * For a nodal group returns result of GetListOfID() function
97 smIdType_array GetNodeIDs();
100 * Return true if GetNumberOfNodes() won't take a long time for computation
102 boolean IsNodeInfoAvailable();
107 void SetColor(in SALOMEDS::Color theColor);
110 * Returns group color
112 SALOMEDS::Color GetColor();
115 * Sets group color number
116 * (corresponds to the "hue" parameter of the color - must be in range [0, 360])
118 void SetColorNumber( in long color );
121 * Returns group color number (obsolete - use GetColor instead)
122 * (corresponds to the "hue" parameter of the color - must be in range [0, 360])
124 long GetColorNumber();
127 * Returns \c true if \c this group depends on the \a other via
128 * FT_BelongToMeshGroup predicate or vice versa
130 boolean IsInDependency( in SMESH_GroupBase other );
134 * SMESH_Group: interface of a standalone group object
136 interface SMESH_Group : SMESH_GroupBase
139 * Clears the group's contents
144 * Adds elements or nodes with specified identifiers to the group
146 smIdType Add( in smIdType_array elem_ids );
148 * Adds elements or nodes that match specified predicate to the group
150 smIdType AddByPredicate( in Predicate thePredicate );
152 * Add all elements or nodes from the specified source to the group
154 smIdType AddFrom( in SMESH_IDSource theSource );
157 * Removes elements or nodes with specified identifiers from the group
159 smIdType Remove( in smIdType_array elem_ids );
161 * Removes elements or nodes that match specified predicate from the group
163 smIdType RemoveByPredicate( in Predicate thePredicate );
168 * SMESH_GroupOnGeom: interface of a group object linked to geometry
170 interface SMESH_GroupOnGeom : SMESH_GroupBase
172 GEOM::GEOM_Object GetShape();
176 * SMESH_GroupOnFilter: interface of a group object defined by filter
178 interface SMESH_GroupOnFilter : SMESH_GroupBase
180 void SetFilter( in Filter theFilter) raises (SALOME::SALOME_Exception);
183 //! @return True if group contents is computed
184 boolean IsUpToDate();