]> SALOME platform Git repositories - modules/smesh.git/blob - idl/SMESH_Measurements.idl
Salome HOME
Minor correction in documentation
[modules/smesh.git] / idl / SMESH_Measurements.idl
1 // Copyright (C) 2007-2024  CEA, EDF, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
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.
10 //
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.
15 //
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
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22
23 //  File   : SMESH_Measurements.idl
24 //  Author : Pavel Telkov, OCC
25 //
26 #ifndef _SMESH_MEASUREMENTS_IDL_
27 #define _SMESH_MEASUREMENTS_IDL_
28
29 #include "SALOME_GenericObj.idl"
30 #include "SMESH_Mesh.idl"
31 #include "SMESH_smIdType.idl"
32
33 module SMESH
34 {
35   /*
36    * Measure component
37    */
38   struct Measure {
39     double minX, minY, minZ;
40     double maxX, maxY, maxZ;
41     smIdType node1, node2;
42     smIdType elem1, elem2;
43     double value;
44   };
45
46   interface Measurements: SALOME::GenericObj
47   {
48     /*!
49      * minimal distance between two entities
50      */
51     Measure MinDistance(in SMESH_IDSource source1,
52                         in SMESH_IDSource source2);
53
54     /*!
55      * common bounding box of entities
56      */
57     Measure BoundingBox(in ListOfIDSources sources);
58
59     /*!
60      * sum of length of 1D elements of the source
61      */
62     double Length(in SMESH_IDSource source);
63
64     /*!
65      * sum of area of 2D elements of the source
66      */
67     double Area(in SMESH_IDSource source);
68
69     /*!
70      * sum of volume of 3D elements of the source
71      */
72     double Volume(in SMESH_IDSource source);
73
74     /*!
75      * gravity center of the source
76      */
77     PointStruct GravityCenter(in SMESH_IDSource source);
78
79     /*!
80      * angle in radians defined by 3 points <(p1,p2,p3)
81      */
82     double Angle(in PointStruct p1, in PointStruct p2, in PointStruct p3 );
83   };
84 };
85
86 #endif