smesh/idl/SMESH_Group.idl

191 lines
4.8 KiB
Plaintext
Raw Normal View History

2024-01-20 19:16:41 +05:00
// Copyright (C) 2007-2024 CEA, EDF, OPEN CASCADE
2004-06-18 14:34:31 +06:00
//
2012-08-09 16:03:55 +06:00
// Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
2004-06-18 14:34:31 +06:00
//
2012-08-09 16:03:55 +06:00
// 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
2014-02-20 18:25:37 +06:00
// version 2.1 of the License, or (at your option) any later version.
2009-02-17 10:27:49 +05:00
//
2012-08-09 16:03:55 +06:00
// 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.
2009-02-17 10:27:49 +05:00
//
2012-08-09 16:03:55 +06:00
// 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
2009-02-17 10:27:49 +05:00
//
2012-08-09 16:03:55 +06:00
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
2004-06-18 14:34:31 +06:00
//
2012-08-09 16:03:55 +06:00
2004-06-18 14:34:31 +06:00
// File : SMESH_Group.idl
// Author : Sergey ANIKIN, OCC
// $Header$
2009-02-17 10:27:49 +05:00
//
2004-06-18 14:34:31 +06:00
#ifndef _SMESH_GROUP_IDL_
#define _SMESH_GROUP_IDL_
#include "SALOME_Exception.idl"
#include "SALOME_GenericObj.idl"
#include "SALOMEDS_Attributes.idl"
2004-06-18 14:34:31 +06:00
#include "SMESH_Mesh.idl"
#include "SMESH_smIdType.idl"
2004-06-18 14:34:31 +06:00
module SMESH
{
interface Predicate;
2012-08-09 16:03:55 +06:00
interface Filter;
2004-06-18 14:34:31 +06:00
/*!
2004-12-01 15:48:31 +05:00
* SMESH_Group: base interface of group object
2004-06-18 14:34:31 +06:00
*/
2017-03-20 22:01:59 +05:00
interface SMESH_GroupBase : SMESH_IDSource
2004-06-18 14:34:31 +06:00
{
/*!
* Sets group name
*/
void SetName( in string name );
/*!
* Returns group name
*/
string GetName();
/*!
* Returns group type (type of elements in the group)
*/
ElementType GetType();
/*!
* Returns the number of elements in the group
*/
smIdType Size();
2004-06-18 14:34:31 +06:00
/*!
* Returns true if the group does not contain any elements
*/
boolean IsEmpty();
/*!
* returns true if the group contains an element with ID == <elem_id>
*/
boolean Contains( in smIdType elem_id );
2004-06-18 14:34:31 +06:00
/*!
* Returns ID of an element at position <elem_index> counted from 1
2004-06-18 14:34:31 +06:00
*/
smIdType GetID( in smIdType elem_index );
2004-06-18 14:34:31 +06:00
/*!
* Returns a sequence of all element IDs in the group
*/
smIdType_array GetListOfID();
2004-06-18 14:34:31 +06:00
/*!
2012-08-09 16:03:55 +06:00
* Get the number of nodes of cells included to the group
* For a nodal group returns the same value as Size() function
*/
smIdType GetNumberOfNodes();
2012-08-09 16:03:55 +06:00
/*!
* Get IDs of nodes of cells included to the group
* For a nodal group returns result of GetListOfID() function
*/
smIdType_array GetNodeIDs();
2012-08-09 16:03:55 +06:00
/*!
* Return true if GetNumberOfNodes() won't take a long time for computation
2004-06-18 14:34:31 +06:00
*/
2012-08-09 16:03:55 +06:00
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 \c true if \c this group depends on the \a other via
* FT_BelongToMeshGroup predicate or vice versa
*/
boolean IsInDependency( in SMESH_GroupBase other );
};
2004-12-01 15:48:31 +05:00
/*!
2012-08-09 16:03:55 +06:00
* SMESH_Group: interface of a standalone group object
2004-12-01 15:48:31 +05:00
*/
interface SMESH_Group : SMESH_GroupBase
{
/*!
* Clears the group's contents
*/
void Clear();
/*!
2012-08-09 16:03:55 +06:00
* Adds elements or nodes with specified identifiers to the group
2004-12-01 15:48:31 +05:00
*/
smIdType Add( in smIdType_array elem_ids );
2012-08-09 16:03:55 +06:00
/*!
* Adds elements or nodes that match specified predicate to the group
*/
smIdType AddByPredicate( in Predicate thePredicate );
2012-08-09 16:03:55 +06:00
/*!
* Add all elements or nodes from the specified source to the group
*/
smIdType AddFrom( in SMESH_IDSource theSource );
2004-12-01 15:48:31 +05:00
/*!
2012-08-09 16:03:55 +06:00
* Removes elements or nodes with specified identifiers from the group
2004-12-01 15:48:31 +05:00
*/
smIdType Remove( in smIdType_array elem_ids );
2012-08-09 16:03:55 +06:00
/*!
* Removes elements or nodes that match specified predicate from the group
*/
smIdType RemoveByPredicate( in Predicate thePredicate );
2004-12-01 15:48:31 +05:00
};
2012-08-09 16:03:55 +06:00
2004-12-01 15:48:31 +05:00
/*!
2012-08-09 16:03:55 +06:00
* SMESH_GroupOnGeom: interface of a group object linked to geometry
2004-12-01 15:48:31 +05:00
*/
interface SMESH_GroupOnGeom : SMESH_GroupBase
{
GEOM::GEOM_Object GetShape();
};
2012-08-09 16:03:55 +06:00
/*!
* SMESH_GroupOnFilter: interface of a group object defined by filter
*/
interface SMESH_GroupOnFilter : SMESH_GroupBase
{
void SetFilter( in Filter theFilter) raises (SALOME::SALOME_Exception);
2012-08-09 16:03:55 +06:00
Filter GetFilter();
//! @return True if group contents is computed
boolean IsUpToDate();
2012-08-09 16:03:55 +06:00
};
2004-06-18 14:34:31 +06:00
};
#endif