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
52 #ifndef __OFFREADER_HH__
53 #define __OFFREADER_HH__
54
55
56 //=== INCLUDES ================================================================
57
58
59 #include <iosfwd>
60 #include <string>
61 #include <cstdio>
62
63 #include <OpenMesh/Core/System/config.h>
64 #include <OpenMesh/Core/Utils/SingletonT.hh>
65 #include <OpenMesh/Core/IO/reader/BaseReader.hh>
66
67
68 //== NAMESPACES ===============================================================
69
70
71 namespace OpenMesh {
72 namespace IO {
73
74
75 //== FORWARDS =================================================================
76
77
78 class BaseImporter;
79
80
81 //== IMPLEMENTATION ===========================================================
82
83
112 class OPENMESHDLLEXPORT _OFFReader_ : public BaseReader
113 {
114 public:
115
116 _OFFReader_();
117
119 virtual ~_OFFReader_() {};
120
121 std::string get_description() const { return "Object File Format"; }
122 std::string get_extensions() const { return "off"; }
123 std::string get_magic() const { return "OFF"; }
124
125 bool read(const std::string& _filename,
126 BaseImporter& _bi,
127 Options& _opt);
128
129 bool can_u_read(const std::string& _filename) const;
130
131 bool read(std::istream& _in, BaseImporter& _bi, Options& _opt );
132
133 private:
134
135 bool can_u_read(std::istream& _is) const;
136
137 bool read_ascii(std::istream& _in, BaseImporter& _bi, Options& _opt) const;
138 bool read_binary(std::istream& _in, BaseImporter& _bi, Options& _opt, bool swap) const;
139
140 void readValue(std::istream& _in, float& _value) const;
141 void readValue(std::istream& _in, int& _value) const;
142 void readValue(std::istream& _in, unsigned int& _value) const;
143
144 int getColorType(std::string & _line, bool _texCoordsAvailable) const;
145
146 //available options for reading
147 mutable Options options_;
148 //options that the user wants to read
149 mutable Options userOptions_;
150 };
151
152
153 //== TYPE DEFINITION ==========================================================
154
155
157 extern _OFFReader_ __OFFReaderInstance;
158 OPENMESHDLLEXPORT _OFFReader_& OFFReader();
159
160
161 //=============================================================================
162 } // namespace IO
163 } // namespace OpenMesh
164 //=============================================================================
165 #endif
166 //=============================================================================
OpenMesh::IO::BaseReader
Definition: BaseReader.hh:89
OpenMesh::IO::_OFFReader_::get_description
std::string get_description() const
Returns a brief description of the file type that can be parsed.
Definition: OFFReader.hh:121
OpenMesh::IO::_OFFReader_::~_OFFReader_
virtual ~_OFFReader_()
Destructor.
Definition: OFFReader.hh:119
BaseImporter
Definition: BaseImporter.hh:1
config.h
OpenMesh::IO::_OFFReader_::get_extensions
std::string get_extensions() const
Definition: OFFReader.hh:122
OpenMesh::IO::_OFFReader_
Definition: OFFReader.hh:112
OpenMesh::IO::_OFFReader_::get_magic
std::string get_magic() const
Return magic bits used to determine file format.
Definition: OFFReader.hh:123
OpenMesh::IO::Options
Set options for reader/writer modules.
Definition: Options.hh:90
OpenMesh::IO::BaseImporter
Definition: BaseImporter.hh:83
OpenMesh
Definition: MeshItems.hh:59
OpenMesh::IO::__OFFReaderInstance
_OFFReader_ __OFFReaderInstance
Declare the single entity of the OFF reader.
Definition: OFFReader.cc:88