Developer Documentation
OFFReader.hh
1 /* ========================================================================= *
2  * *
3  * OpenMesh *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openmesh.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenMesh. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39  * *
40  * ========================================================================= */
41 
42 
43 
44 
45 //=============================================================================
46 //
47 // Implements a reader module for OFF files
48 //
49 //=============================================================================
50 
51 #pragma once
52 
53 //=== INCLUDES ================================================================
54 
55 
56 #include <iosfwd>
57 #include <string>
58 #include <cstdio>
59 
61 #include <OpenMesh/Core/Utils/SingletonT.hh>
62 #include <OpenMesh/Core/IO/reader/BaseReader.hh>
63 
64 
65 //== NAMESPACES ===============================================================
66 
67 
68 namespace OpenMesh {
69 namespace IO {
70 
71 
72 //== FORWARDS =================================================================
73 
74 
75 class BaseImporter;
76 
77 
78 //== IMPLEMENTATION ===========================================================
79 
80 
109 class OPENMESHDLLEXPORT _OFFReader_ : public BaseReader
110 {
111 public:
112 
113  _OFFReader_();
114 
116  virtual ~_OFFReader_() {};
117 
118  std::string get_description() const override { return "Object File Format"; }
119  std::string get_extensions() const override { return "off"; }
120  std::string get_magic() const override { return "OFF"; }
121 
122  bool read(const std::string& _filename,
123  BaseImporter& _bi,
124  Options& _opt) override;
125 
126  bool can_u_read(const std::string& _filename) const override;
127 
128  bool read(std::istream& _in, BaseImporter& _bi, Options& _opt ) override;
129 
130 private:
131 
132  bool can_u_read(std::istream& _is) const;
133 
134  bool read_ascii(std::istream& _in, BaseImporter& _bi, Options& _opt) const;
135  bool read_binary(std::istream& _in, BaseImporter& _bi, Options& _opt, bool swap) const;
136 
137  void readValue(std::istream& _in, float& _value) const;
138  void readValue(std::istream& _in, int& _value) const;
139  void readValue(std::istream& _in, unsigned int& _value) const;
140 
141  int getColorType(std::string & _line, bool _texCoordsAvailable) const;
142 
143  //available options for reading
144  mutable Options options_;
145  //options that the user wants to read
146  mutable Options userOptions_;
147 };
148 
149 
150 //== TYPE DEFINITION ==========================================================
151 
152 
155 OPENMESHDLLEXPORT _OFFReader_& OFFReader();
156 
157 
158 //=============================================================================
159 } // namespace IO
160 } // namespace OpenMesh
161 //=============================================================================
std::string get_extensions() const override
Definition: OFFReader.hh:119
std::string get_magic() const override
Return magic bits used to determine file format.
Definition: OFFReader.hh:120
virtual ~_OFFReader_()
Destructor.
Definition: OFFReader.hh:116
Set options for reader/writer modules.
Definition: Options.hh:90
_OFFReader_ __OFFReaderInstance
Declare the single entity of the OFF reader.
Definition: OFFReader.cc:88
std::string get_description() const override
Returns a brief description of the file type that can be parsed.
Definition: OFFReader.hh:118