include/opencascade/VrmlAPI_CafReader.hxx

0001 // Copyright (c) 2022 OPEN CASCADE SAS
0002 //
0003 // This file is part of Open CASCADE Technology software library.
0004 //
0005 // This library is free software; you can redistribute it and/or modify it under
0006 // the terms of the GNU Lesser General Public License version 2.1 as published
0007 // by the Free Software Foundation, with special exception defined in the file
0008 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0009 // distribution for complete text of the license and disclaimer of any warranty.
0010 //
0011 // Alternatively, this file may be used under the terms of Open CASCADE
0012 // commercial license or contractual agreement.
0013
0014 #ifndef _VrmlAPI_Reader_HeaderFile
0015 #define _VrmlAPI_Reader_HeaderFile
0016
0017 #include <RWMesh_CafReader.hxx>
0018
0019 //! The Vrml mesh reader into XDE document.
0020 class VrmlAPI_CafReader : public RWMesh_CafReader
0021 {
0022   DEFINE_STANDARD_RTTIEXT(VrmlAPI_CafReader, RWMesh_CafReader)
0023
0024 protected:
0025   //! Read the mesh data from specified file.
0026   //! @param theStream   input stream
0027   //! @param theFile     path of additional files
0028   //! @param theProgress progress indicator
0029   //! @param theToProbe  flag for probing file without complete reading. Not supported.
0030   //! @return false when theToProbe is set to true or reading has completed with error.
0031   Standard_EXPORT virtual Standard_Boolean performMesh(std::istream&                  theStream,
0032                                                        const TCollection_AsciiString& theFile,
0033                                                        const Message_ProgressRange&   theProgress,
0034                                                        const Standard_Boolean         theToProbe)
0035     Standard_OVERRIDE;
0036 };
0037
0038 #endif // _VrmlAPI_Reader_HeaderFile