0032540: RWGltf_CafReader - optional "scene" parameter encoded as mandatory
[occt.git] / src / RWGltf / RWGltf_CafReader.hxx
1 // Author: Kirill Gavrilov
2 // Copyright (c) 2016-2019 OPEN CASCADE SAS
3 //
4 // This file is part of Open CASCADE Technology software library.
5 //
6 // This library is free software; you can redistribute it and/or modify it under
7 // the terms of the GNU Lesser General Public License version 2.1 as published
8 // by the Free Software Foundation, with special exception defined in the file
9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
10 // distribution for complete text of the license and disclaimer of any warranty.
11 //
12 // Alternatively, this file may be used under the terms of Open CASCADE
13 // commercial license or contractual agreement.
14
15 #ifndef _RWGltf_CafReader_HeaderFile
16 #define _RWGltf_CafReader_HeaderFile
17
18 #include <Message_ProgressRange.hxx>
19 #include <NCollection_Vector.hxx>
20 #include <RWMesh_CafReader.hxx>
21 #include <TopoDS_Face.hxx>
22
23 class RWMesh_TriangulationReader;
24
25 //! The glTF (GL Transmission Format) mesh reader into XDE document.
26 class RWGltf_CafReader : public RWMesh_CafReader
27 {
28   DEFINE_STANDARD_RTTIEXT(RWGltf_CafReader, RWMesh_CafReader)
29 public:
30
31   //! Empty constructor.
32   Standard_EXPORT RWGltf_CafReader();
33
34   //! Return TRUE if multithreaded optimizations are allowed; FALSE by default.
35   bool ToParallel() const { return myToParallel; }
36
37   //! Setup multithreaded execution.
38   void SetParallel (bool theToParallel) { myToParallel = theToParallel; }
39
40   //! Return TRUE if Nodes without Geometry should be ignored, TRUE by default.
41   bool ToSkipEmptyNodes() { return myToSkipEmptyNodes; }
42
43   //! Set flag to ignore nodes without Geometry.
44   void SetSkipEmptyNodes (bool theToSkip) { myToSkipEmptyNodes = theToSkip; }
45
46   //! Return TRUE if all scenes in the document should be loaded, FALSE by default which means only main (default) scene will be loaded.
47   bool ToLoadAllScenes() const { return myToLoadAllScenes; }
48
49   //! Set flag to flag to load all scenes in the document, FALSE by default which means only main (default) scene will be loaded.
50   void SetLoadAllScenes (bool theToLoadAll) { myToLoadAllScenes = theToLoadAll; }
51
52   //! Set flag to use Mesh name in case if Node name is empty, TRUE by default.
53   bool ToUseMeshNameAsFallback() { return myUseMeshNameAsFallback; }
54
55   //! Set flag to use Mesh name in case if Node name is empty.
56   void SetMeshNameAsFallback (bool theToFallback) { myUseMeshNameAsFallback = theToFallback; }
57
58   //! Return flag to fill in triangulation using double or single precision; FALSE by default.
59   bool IsDoublePrecision() const { return myIsDoublePrecision; }
60
61   //! Set flag to fill in triangulation using double or single precision.
62   void SetDoublePrecision (bool theIsDouble) { myIsDoublePrecision = theIsDouble; }
63
64   //! Returns TRUE if data loading should be skipped and can be performed later; FALSE by default.
65   bool ToSkipLateDataLoading() { return myToSkipLateDataLoading; }
66
67   //! Sets flag to skip data loading.
68   void SetToSkipLateDataLoading (bool theToSkip) { myToSkipLateDataLoading = theToSkip; }
69
70   //! Returns TRUE if data should be loaded into itself without its transfering to new structure.
71   //! It allows to keep information about deferred storage to load/unload this data later.
72   //! TRUE by default.
73   bool ToKeepLateData() { return myToKeepLateData; }
74
75   //! Sets flag to keep information about deferred storage to load/unload data later.
76   void SetToKeepLateData (bool theToKeep) { myToKeepLateData = theToKeep; }
77
78   //! Returns TRUE if additional debug information should be print; FALSE by default.
79   bool ToPrintDebugMessages() const { return myToPrintDebugMessages; }
80
81   //! Sets flag to print debug information.
82   void SetToPrintDebugMessages (const Standard_Boolean theToPrint) { myToPrintDebugMessages = theToPrint; }
83
84 protected:
85
86   //! Read the mesh from specified file.
87   Standard_EXPORT virtual Standard_Boolean performMesh (const TCollection_AsciiString& theFile,
88                                                         const Message_ProgressRange& theProgress,
89                                                         const Standard_Boolean theToProbe) Standard_OVERRIDE;
90
91   //! Create primitive array reader context.
92   //! Can be overridden by sub-class to read triangulation into application-specific data structures instead of Poly_Triangulation.
93   //! Default implementation creates RWGltf_TriangulationReader.
94   Standard_EXPORT virtual Handle(RWMesh_TriangulationReader) createMeshReaderContext() const;
95
96   //! Read late data from RWGltf_GltfLatePrimitiveArray stored as Poly_Triangulation within faces.
97   Standard_EXPORT virtual Standard_Boolean readLateData (NCollection_Vector<TopoDS_Face>& theFaces,
98                                                          const TCollection_AsciiString& theFile,
99                                                          const Message_ProgressRange& theProgress);
100
101   //! Set reader for each late data.
102   Standard_EXPORT void updateLateDataReader (NCollection_Vector<TopoDS_Face>& theFaces,
103                                              const Handle(RWMesh_TriangulationReader)& theReader) const;
104
105 protected:
106
107   class CafReader_GltfBaseLoadingFunctor;
108   class CafReader_GltfFullDataLoadingFunctor;
109   class CafReader_GltfStreamDataLoadingFunctor;
110
111 protected:
112
113   Standard_Boolean myToParallel;            //!< flag to use multithreading; FALSE by default
114   Standard_Boolean myToSkipEmptyNodes;      //!< ignore nodes without Geometry; TRUE by default
115   Standard_Boolean myToLoadAllScenes;       //!< flag to load all scenes in the document, FALSE by default
116   Standard_Boolean myUseMeshNameAsFallback; //!< flag to use Mesh name in case if Node name is empty, TRUE by default
117   Standard_Boolean myIsDoublePrecision;     //!< flag to fill in triangulation using single or double precision
118   Standard_Boolean myToSkipLateDataLoading; //!< flag to skip triangulation loading
119   Standard_Boolean myToKeepLateData;        //!< flag to keep information about deferred storage to load/unload triangulation later
120   Standard_Boolean myToPrintDebugMessages;  //!< flag to print additional debug information
121
122 };
123
124 #endif // _RWGltf_CafReader_HeaderFile