src/RWStl/RWStl_Reader.hxx

   1 // Created: 2016-05-01
   2 // Author: Andrey Betenev
   3 // Copyright: Open CASCADE 2016
   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 _RWStl_Reader_HeaderFile
  17 #define _RWStl_Reader_HeaderFile
  18
  19 #include <Message_ProgressIndicator.hxx>
  20 #include <gp_XYZ.hxx>
  21
  22 //! An abstract class implementing procedure to read STL file.
  23 //!
  24 //! This class is not bound to particular data structure and can be used to read the file directly into arbitrary data model.
  25 //! To use it, create descendant class and implement methods addNode() and addTriangle().
  26 //!
  27 //! Call method Read() to read the file. In the process of reading, the tool will call methods addNode() and addTriangle() to fill the mesh data structure.
  28 //!
  29 //! The nodes with equal coordinates are merged automatically  on the fly.
  30 class RWStl_Reader : public Standard_Transient
  31 {
  32   DEFINE_STANDARD_RTTIEXT(RWStl_Reader, Standard_Transient)
  33 public:
  34
  35   //! Reads data from STL file (either binary or Ascii).
  36   //! This function supports reading multi-domain STL files formed by concatenation of several "plain" files.
  37   //! The mesh nodes are not merged between domains.
  38   //! Unicode paths can be given in UTF-8 encoding.
  39   //! Format is recognized automatically by analysis of the file header.
  40   //! Returns true if success, false on error or user break.
  41   Standard_EXPORT Standard_Boolean Read (const char* theFile,
  42                                          const Handle(Message_ProgressIndicator)& theProgress);
  43
  44   //! Guess whether the stream is an Ascii STL file, by analysis of the first bytes (~200).
  45   //! The function attempts to put back the read symbols to the stream which thus must support ungetc().
  46   //! Returns true if the stream seems to contain Ascii STL.
  47   Standard_EXPORT Standard_Boolean IsAscii (Standard_IStream& theStream);
  48
  49   //! Reads STL data from binary stream.
  50   //! The stream must be opened in binary mode.
  51   //! Stops after reading the number of triangles recorded in the file header.
  52   //! Returns true if success, false on error or user break.
  53   Standard_EXPORT Standard_Boolean ReadBinary (Standard_IStream& theStream,
  54                                                const Handle(Message_ProgressIndicator)& theProgress);
  55
  56   //! Reads data from the stream assumed to contain Ascii STL data.
  57   //! The stream can be opened either in binary or in Ascii mode.
  58   //! Reading stops at the position specified by theUntilPos,
  59   //! or end of file is reached, or when keyword "endsolid" is found.
  60   //! Empty lines are not supported and will read to reading failure.
  61   //! If theUntilPos is non-zero, reads not more than until that position.
  62   //! Returns true if success, false on error or user break.
  63   Standard_EXPORT Standard_Boolean ReadAscii (Standard_IStream& theStream,
  64                                               const std::streampos theUntilPos,
  65                                               const Handle(Message_ProgressIndicator)& theProgress);
  66
  67 public:
  68
  69   //! Callback function to be implemented in descendant.
  70   //! Should create new node with specified coordinates in the target model, and return its ID as integer.
  71   virtual Standard_Integer AddNode (const gp_XYZ& thePnt) = 0;
  72
  73   //! Callback function to be implemented in descendant.
  74   //! Should create new triangle built on specified nodes in the target model.
  75   virtual void AddTriangle (Standard_Integer theN1, Standard_Integer theN2, Standard_Integer theN3) = 0;
  76
  77 };
  78
  79 #endif