4178b353 |
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 | |
4178b353 |
19 | #include <gp_XYZ.hxx> |
c37bd936 |
20 | #include <Standard_ReadLineBuffer.hxx> |
7e785937 |
21 | #include <Standard_IStream.hxx> |
22 | |
23 | class Message_ProgressRange; |
4178b353 |
24 | |
25 | //! An abstract class implementing procedure to read STL file. |
26 | //! |
27 | //! This class is not bound to particular data structure and can be used to read the file directly into arbitrary data model. |
28 | //! To use it, create descendant class and implement methods addNode() and addTriangle(). |
29 | //! |
30 | //! 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. |
31 | //! |
32 | //! The nodes with equal coordinates are merged automatically on the fly. |
33 | class RWStl_Reader : public Standard_Transient |
34 | { |
35 | DEFINE_STANDARD_RTTIEXT(RWStl_Reader, Standard_Transient) |
36 | public: |
37 | |
c9831764 |
38 | //! Default constructor. |
39 | Standard_EXPORT RWStl_Reader(); |
40 | |
4178b353 |
41 | //! Reads data from STL file (either binary or Ascii). |
1d949423 |
42 | //! This function supports reading multi-domain STL files formed by concatenation of several "plain" files. |
43 | //! The mesh nodes are not merged between domains. |
4178b353 |
44 | //! Unicode paths can be given in UTF-8 encoding. |
45 | //! Format is recognized automatically by analysis of the file header. |
46 | //! Returns true if success, false on error or user break. |
47 | Standard_EXPORT Standard_Boolean Read (const char* theFile, |
7e785937 |
48 | const Message_ProgressRange& theProgress); |
4178b353 |
49 | |
50 | //! Guess whether the stream is an Ascii STL file, by analysis of the first bytes (~200). |
97454ee0 |
51 | //! If the stream does not support seekg() then the parameter isSeekgAvailable should |
52 | //! be passed as 'false', in this case the function attempts to put back the read symbols |
53 | //! to the stream which thus must support ungetc(). |
4178b353 |
54 | //! Returns true if the stream seems to contain Ascii STL. |
97454ee0 |
55 | Standard_EXPORT Standard_Boolean IsAscii (Standard_IStream& theStream, |
56 | const bool isSeekgAvailable); |
4178b353 |
57 | |
58 | //! Reads STL data from binary stream. |
59 | //! The stream must be opened in binary mode. |
60 | //! Stops after reading the number of triangles recorded in the file header. |
61 | //! Returns true if success, false on error or user break. |
62 | Standard_EXPORT Standard_Boolean ReadBinary (Standard_IStream& theStream, |
7e785937 |
63 | const Message_ProgressRange& theProgress); |
4178b353 |
64 | |
65 | //! Reads data from the stream assumed to contain Ascii STL data. |
66 | //! The stream can be opened either in binary or in Ascii mode. |
67 | //! Reading stops at the position specified by theUntilPos, |
68 | //! or end of file is reached, or when keyword "endsolid" is found. |
69 | //! Empty lines are not supported and will read to reading failure. |
70 | //! If theUntilPos is non-zero, reads not more than until that position. |
71 | //! Returns true if success, false on error or user break. |
72 | Standard_EXPORT Standard_Boolean ReadAscii (Standard_IStream& theStream, |
c37bd936 |
73 | Standard_ReadLineBuffer& theBuffer, |
4178b353 |
74 | const std::streampos theUntilPos, |
7e785937 |
75 | const Message_ProgressRange& theProgress); |
4178b353 |
76 | |
77 | public: |
78 | |
79 | //! Callback function to be implemented in descendant. |
80 | //! Should create new node with specified coordinates in the target model, and return its ID as integer. |
81 | virtual Standard_Integer AddNode (const gp_XYZ& thePnt) = 0; |
82 | |
83 | //! Callback function to be implemented in descendant. |
84 | //! Should create new triangle built on specified nodes in the target model. |
85 | virtual void AddTriangle (Standard_Integer theN1, Standard_Integer theN2, Standard_Integer theN3) = 0; |
86 | |
c9831764 |
87 | public: |
88 | |
89 | //! Return merge tolerance; M_PI/2 by default - all nodes are merged regardless angle between triangles. |
90 | Standard_Real MergeAngle() const { return myMergeAngle; } |
91 | |
92 | //! Set merge angle in radians. |
93 | //! Specify something like M_PI/4 (45 degrees) to avoid merge nodes between triangles at sharp corners. |
94 | void SetMergeAngle (Standard_Real theAngleRad) { myMergeAngle = theAngleRad; } |
95 | |
96 | //! Return linear merge tolerance; 0.0 by default (only 3D points with exactly matching coordinates are merged). |
97 | double MergeTolerance() const { return myMergeTolearance; } |
98 | |
99 | //! Set linear merge tolerance. |
100 | void SetMergeTolerance (double theTolerance) { myMergeTolearance = theTolerance; } |
101 | |
102 | protected: |
103 | |
104 | Standard_Real myMergeAngle; |
105 | Standard_Real myMergeTolearance; |
106 | |
4178b353 |
107 | }; |
108 | |
109 | #endif |