include/opencascade/StlAPI_Reader.hxx

0001 // Created on: 2000-06-23
0002 // Created by: Sergey MOZOKHIN
0003 // Copyright (c) 2000-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _StlAPI_Reader_HeaderFile
0017 #define _StlAPI_Reader_HeaderFile
0018
0019 #include <Standard_Handle.hxx>
0020 #include <Standard_IStream.hxx>
0021
0022 class TopoDS_Shape;
0023
0024 //! Reading from stereolithography format.
0025 //! Reads STL file and creates a shape composed of triangular faces, one per facet.
0026 //! IMPORTANT: This approach is very inefficient, especially for large files.
0027 //! IMPORTANT: Consider reading STL file to Poly_Triangulation object instead (see class RWStl).
0028 class StlAPI_Reader
0029 {
0030 public:
0031   //! Reads STL file to the TopoDS_Shape (each triangle is converted to the face).
0032   //! @return True if reading is successful
0033   Standard_EXPORT bool Read(TopoDS_Shape& theShape, const char* const theFileName);
0034
0035   //! Reads STL data from stream to the TopoDS_Shape (each triangle is converted to the face).
0036   //! @param theShape result shape
0037   //! @param theStream stream to read from
0038   //! @return True if reading is successful
0039   Standard_EXPORT bool Read(TopoDS_Shape& theShape, Standard_IStream& theStream);
0040 };
0041
0042 #endif // _StlAPI_Reader_HeaderFile