]> SALOME platform Git repositories - modules/geom.git/blob - idl/STLPlugin.idl
Salome HOME
Porting to dev version of OCCT.
[modules/geom.git] / idl / STLPlugin.idl
1 // Copyright (C) 2014-2016  CEA/DEN, EDF R&D, 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 __STLPlugin_IDL__
21 #define __STLPlugin_IDL__
22
23 #include "GEOM_Gen.idl"
24
25 module GEOM
26 {
27   /*!
28    *  \brief Interface for STLPlugin modeling functions.
29    */
30   interface ISTLOperations : GEOM::GEOM_IOperations
31   {
32     /*!
33      *  \brief Export the given shape into a file with given name in STL format.
34      *
35      *  \param theObject Shape to be stored in the file.
36      *  \param theFileName Name of the file to store the given shape in.
37      *  \param theIsASCII The format of the exported file (ASCII or Binary).
38      *  \param theDeflection Deflection of the given shape.
39      *  \param theIsRelative Mode for writing the file. If True (default value), the 
40      *         deflection is calculated from the relative size of the 
41      *         shape; if False, the user defined deflection is used.
42      */
43     void ExportSTL( in GEOM::GEOM_Object theObject, 
44                     in string            theFileName,
45                     in boolean           theIsASCII,
46                     in double            theDeflection,
47                     in boolean           theIsRelative );
48       
49     /*!
50      *  \brief Import a shape from the STL file.
51      *
52      *  \param theFileName The file, containing the shape.
53      *  \return List of GEOM_Objects, containing the created shape and propagation groups.
54      */              
55     GEOM::ListOfGO ImportSTL( in string theFileName );
56   };
57 };
58
59 #endif // __STLPlugin_IDL__