include/opencascade/StlAPI.hxx

0001 // Created on: 1997-05-13
0002 // Created by: Fabien REUTER
0003 // Copyright (c) 1997-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _StlAPI_HeaderFile
0018 #define _StlAPI_HeaderFile
0019
0020 #include <Poly_Triangulation.hxx>
0021 #include <Standard.hxx>
0022 #include <Standard_DefineAlloc.hxx>
0023 #include <Standard_CString.hxx>
0024 class TopoDS_Shape;
0025
0026 //! Offers the API for STL data manipulation.
0027 class StlAPI
0028 {
0029 public:
0030
0031   DEFINE_STANDARD_ALLOC
0032
0033   //! Convert and write shape to STL format.
0034   //! File is written in binary if aAsciiMode is False otherwise it is written in Ascii (by default).
0035   Standard_EXPORT static Standard_Boolean Write (const TopoDS_Shape&    theShape,
0036                                                  const Standard_CString theFile,
0037                                                  const Standard_Boolean theAsciiMode = Standard_True);
0038
0039   //! Legacy interface.
0040   //! Read STL file and create a shape composed of triangular faces, one per facet.
0041   //! This approach is very inefficient, especially for large files.
0042   //! Consider reading STL file to Poly_Triangulation object instead (see class RWStl).
0043   Standard_DEPRECATED("This method is very inefficient; see RWStl class for better alternative")
0044   Standard_EXPORT static Standard_Boolean Read (TopoDS_Shape& theShape,
0045                                                 const Standard_CString aFile);
0046
0047 };
0048
0049 #endif // _StlAPI_HeaderFile