X-Git-Url: http://git.salome-platform.org/gitweb/?p=modules%2Fsmesh.git;a=blobdiff_plain;f=idl%2FSMESH_Group.idl;h=71a256525ace6ee46303283edfe9deb391ce7fea;hp=9842df2f6f682ebace0a6870c513cfb17b73232e;hb=0003e6b4fcc95a0aec695ceef8371dee28baf417;hpb=c3bf92bd87b770fd81631a3853f7f5bb1ac6a4e8 diff --git a/idl/SMESH_Group.idl b/idl/SMESH_Group.idl index 9842df2f6..71a256525 100644 --- a/idl/SMESH_Group.idl +++ b/idl/SMESH_Group.idl @@ -1,41 +1,47 @@ -// 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-2016 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, 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 +// + // 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; + interface Filter; + /*! - * SMESH_Group: interface of group object + * SMESH_Group: base interface of group object */ - interface SMESH_Group : SALOME::GenericObj + interface SMESH_GroupBase : SMESH_IDSource { /*! * Sets group name @@ -63,40 +69,117 @@ module SMESH boolean IsEmpty(); /*! - * Clears the group's contents + * returns true if the group contains an element with ID == */ - void Clear(); + boolean Contains( in long elem_id ); /*! - * returns true if the group contains an element with ID == + * Returns ID of an element at position counted from 1 */ - boolean Contains( in long elem_id ); + long GetID( in long elem_index ); /*! - * Adds elements to the group + * Returns a sequence of all element IDs in the group */ - long Add( in long_array elem_ids ); + long_array GetListOfID(); /*! - * Returns ID of an element at position + * Get the number of nodes of cells included to the group + * For a nodal group returns the same value as Size() function */ - long GetID( in long elem_index ); + long GetNumberOfNodes(); /*! - * Returns a sequence of all element IDs in the group + * Get IDs of nodes of cells included to the group + * For a nodal group returns result of GetListOfID() function */ - long_array GetListOfID(); + long_array GetNodeIDs(); /*! - * Removes elements from the group + * Return true if GetNumberOfNodes() won't take a long time for computation */ - long Remove( in long_array elem_ids ); + boolean IsNodeInfoAvailable(); + + /*! + * Sets group color + */ + 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(); /*! - * Returns the mesh object this group belongs to + * Returns \c true if \c this group depends on the \a other via + * FT_BelongToMeshGroup predicate or vice versa */ - SMESH_Mesh GetMesh(); - }; + boolean IsInDependency( in SMESH_GroupBase other ); + }; + + /*! + * SMESH_Group: interface of a standalone group object + */ + interface SMESH_Group : SMESH_GroupBase + { + /*! + * Clears the group's contents + */ + void Clear(); + + /*! + * Adds elements or nodes with specified identifiers to the group + */ + long Add( in long_array elem_ids ); + /*! + * Adds elements or nodes that match specified predicate to the group + */ + long AddByPredicate( in Predicate thePredicate ); + /*! + * Add all elements or nodes from the specified source to the group + */ + long AddFrom( in SMESH_IDSource theSource ); + + /*! + * Removes elements or nodes with specified identifiers from the group + */ + long Remove( in long_array elem_ids ); + /*! + * Removes elements or nodes that match specified predicate from the group + */ + long RemoveByPredicate( in Predicate thePredicate ); + + }; + + /*! + * SMESH_GroupOnGeom: interface of a group object linked to geometry + */ + interface SMESH_GroupOnGeom : SMESH_GroupBase + { + GEOM::GEOM_Object GetShape(); + }; + + /*! + * SMESH_GroupOnFilter: interface of a group object defined by filter + */ + interface SMESH_GroupOnFilter : SMESH_GroupBase + { + void SetFilter( in Filter theFilter) raises (SALOME::SALOME_Exception); + Filter GetFilter(); + }; + };