Salome HOME
Porting to Python 2.6 - add coding page specification for Python scripts
[modules/smesh.git] / idl / SMESH_Group.idl
index 9842df2f6f682ebace0a6870c513cfb17b73232e..aa9cee1252b48e8f90d82f2e8083e9417de7effd 100644 (file)
@@ -1,41 +1,45 @@
-//  Copyright (C) 2004  CEA 
-// 
-//  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. 
-// 
-//  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.org 
+//  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, 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.
+//
+//  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
 //
 //  File   : SMESH_Group.idl
 //  Author : Sergey ANIKIN, OCC
 //  $Header$
-
+//
 #ifndef _SMESH_GROUP_IDL_
 #define _SMESH_GROUP_IDL_
 
 #include "SALOME_Exception.idl"
 #include "SALOME_GenericObj.idl"
+#include "SALOMEDS_Attributes.idl"
 
 #include "SMESH_Mesh.idl"
 
 module SMESH
 {
+  interface Predicate;
+
   /*!
-   * SMESH_Group: interface of group object
+   * SMESH_Group: base interface of group object
    */
-  interface SMESH_Group : SALOME::GenericObj
+  interface SMESH_GroupBase : SALOME::GenericObj, SMESH_IDSource
   {
     /*!
      * Sets group name
@@ -62,21 +66,11 @@ module SMESH
      */
     boolean IsEmpty();
 
-    /*!
-     * Clears the group's contents
-     */
-    void Clear();
-
     /*!
      * returns true if the group contains an element with ID == <elem_id> 
      */
     boolean Contains( in long elem_id );
 
-    /*!
-     * Adds elements to the group
-     */
-    long Add( in long_array elem_ids );
-
     /*!
      * Returns ID of an element at position <elem_index>
      */
@@ -88,15 +82,64 @@ module SMESH
     long_array GetListOfID();
 
     /*!
-     * Removes elements from the group
+     * Returns the mesh object this group belongs to
      */
-    long Remove( in long_array elem_ids );
+    SMESH_Mesh GetMesh();
 
     /*!
-     * Returns the mesh object this group belongs to
+     * Sets group color
      */
-    SMESH_Mesh GetMesh();
+    void SetColor(in SALOMEDS::Color theColor);
+
+    /*!
+     * Returns group color
+     */
+    SALOMEDS::Color GetColor();
+
+    /*!
+     * Sets group color number
+     * (corresponds to the "hue" parameter of the color - must be in range [0, 360])
+     */
+    void SetColorNumber( in long color );
+
+    /*!
+     * Returns group color number (obsolete - use GetColor instead)
+     * (corresponds to the "hue" parameter of the color - must be in range [0, 360])
+     */
+    long GetColorNumber();
   }; 
+
+  /*!
+   * SMESH_Group: interface of group object
+   */
+  interface SMESH_Group : SMESH_GroupBase
+  {
+    /*!
+     * Clears the group's contents
+     */
+    void Clear();
+
+    /*!
+     * Adds elements to the group
+     */
+    long Add( in long_array elem_ids );
+    long AddByPredicate( in Predicate thePredicate );
+
+    /*!
+     * Removes elements from the group
+     */
+    long Remove( in long_array elem_ids );
+    long RemoveByPredicate( in Predicate thePredicate );
+
+  };
+  /*!
+   * SMESH_Group: interface of group object linked to geometry
+   */
+  interface SMESH_GroupOnGeom : SMESH_GroupBase
+  {
+    GEOM::GEOM_Object GetShape();
+  };
+
 };