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 <Message_ProgressScope.hxx>
  20 #include <Message_ProgressIndicator.hxx>
  21
  22 class TopoDS_Shape;
  23
  24 //! This class creates and writes
  25 //! STL files from Open CASCADE shapes. An STL file can be written to an existing STL file or to a new one.
  26 class StlAPI_Writer
  27 {
  28 public:
  29
  30   DEFINE_STANDARD_ALLOC
  31
  32   //! Creates a writer object with default parameters: ASCIIMode.
  33   Standard_EXPORT StlAPI_Writer();
  34
  35   //! Returns the address to the flag defining the mode for writing the file.
  36   //! This address may be used to either read or change the flag.
  37   //! If the mode returns True (default value) the generated file is an ASCII file.
  38   //! If the mode returns False, the generated file is a binary file.
  39   Standard_Boolean& ASCIIMode() { return myASCIIMode; }
  40
  41   //! Converts a given shape to STL format and writes it to file with a given filename.
  42   //! \return the error state.
  43   Standard_EXPORT Standard_Boolean Write (const TopoDS_Shape& theShape,
  44                                           const Standard_CString theFileName,
  45                                           const Message_ProgressRange& theProgress = Message_ProgressRange());
  46
  47 private:
  48   Standard_Boolean myASCIIMode;
  49 };
  50
  51 #endif // _StlAPI_Writer_HeaderFile