Salome HOME
Initial repository creation
[plugins/canrecplugin.git] / idl / CANRECPlugin.idl
1 // Copyright (C) 2014-2015  OPEN CASCADE
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19
20 #ifndef __CANRECPlugin_IDL__
21 #define __CANRECPlugin_IDL__
22
23 #include "GEOM_Gen.idl"
24
25 module CANRECPlugin
26 {       
27   /*!
28    *  \brief Interface to Canonical Recognition modeling functions.
29    */
30   interface ICanRecOperations : GEOM::GEOM_IOperations
31   {
32     /*!
33      * \brief Perform, if possible, conversion of NURBS (B-Spline, Bezier) geometry to canonical (analytical) form. 
34      *
35      * \param theObject the input object (solid, compound, compsolid).
36      * \param theMergeSurf the flag to switch on/off merging surfaces in the result shape.
37      * \param theMergeCurves the flag to switch on/off merging curves in the result shape.
38      * \param theTolerance the tolerance of the canonical recognition operation.
39      *
40      * \return New GEOM_Object, containing the canonical recognition of the input object.
41      */
42     GEOM::GEOM_Object MakeCanonicalRecognition ( in GEOM::GEOM_Object theObject,
43                                                  in boolean theMergeSurf,
44                                                  in boolean theMergeCurves,
45                                                  in double theTolerance );
46   };
47 };
48
49 #endif  // __CANRECPlugin_IDL__