0031687: Draw Harness, ViewerTest - extend command vrenderparams with option updating...
[occt.git] / src / StlAPI / StlAPI_Writer.hxx
1 // Created on: 2000-06-23
2 // Created by: Sergey MOZOKHIN
3 // Copyright (c) 2000-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _StlAPI_Writer_HeaderFile
17 #define _StlAPI_Writer_HeaderFile
18
19 #include <Poly_Triangulation.hxx>
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23 #include <Standard_Boolean.hxx>
24 #include <Standard_CString.hxx>
25 #include <Message_ProgressIndicator.hxx>
26
27 class TopoDS_Shape;
28
29 //! This class creates and writes
30 //! STL files from Open CASCADE shapes. An STL file can be written to an existing STL file or to a new one.
31 class StlAPI_Writer
32 {
33 public:
34
35   DEFINE_STANDARD_ALLOC
36
37   //! Creates a writer object with default parameters: ASCIIMode.
38   Standard_EXPORT StlAPI_Writer();
39
40   //! Returns the address to the flag defining the mode for writing the file.
41   //! This address may be used to either read or change the flag.
42   //! If the mode returns True (default value) the generated file is an ASCII file.
43   //! If the mode returns False, the generated file is a binary file.
44   Standard_Boolean& ASCIIMode() { return myASCIIMode; }
45
46   //! Converts a given shape to STL format and writes it to file with a given filename.
47   //! \return the error state.
48   Standard_EXPORT Standard_Boolean Write (const TopoDS_Shape& theShape,
49                                           const Standard_CString theFileName,
50                                           const Handle(Message_ProgressIndicator)& theProgress = NULL);
51
52 private:
53   Standard_Boolean myASCIIMode;
54 };
55
56 #endif // _StlAPI_Writer_HeaderFile