Developer Documentation

PLYReader.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 __PLYREADER_HH__
53 #define __PLYREADER_HH__
54
55
56 //=== INCLUDES ================================================================
57
58
59
60 #include <iosfwd>
61 #include <string>
62 #include <cstdio>
63 #include <vector>
64
65 #include <OpenMesh/Core/System/config.h>
66 #include <OpenMesh/Core/Utils/SingletonT.hh>
67 #include <OpenMesh/Core/IO/reader/BaseReader.hh>
68 #include <OpenMesh/Core/Utils/GenProg.hh>
69
70
71 //== NAMESPACES ===============================================================
72
73
74 namespace OpenMesh {
75 namespace IO {
76
77
78 //== FORWARDS =================================================================
79
80
81 class BaseImporter;
82
83
84 //== IMPLEMENTATION ===========================================================
85
86
94 class OPENMESHDLLEXPORT _PLYReader_ : public BaseReader
95 {
96 public:
97
98 _PLYReader_();
99
100 std::string get_description() const { return "PLY polygon file format"; }
101 std::string get_extensions() const { return "ply"; }
102 std::string get_magic() const { return "PLY"; }
103
104 bool read(const std::string& _filename,
105 BaseImporter& _bi,
106 Options& _opt);
107
108 bool read(std::istream& _is,
109 BaseImporter& _bi,
110 Options& _opt);
111
112 bool can_u_read(const std::string& _filename) const;
113
114 enum ValueType {
115 Unsupported,
116 ValueTypeINT8, ValueTypeCHAR,
117 ValueTypeUINT8, ValueTypeUCHAR,
118 ValueTypeINT16, ValueTypeSHORT,
119 ValueTypeUINT16, ValueTypeUSHORT,
120 ValueTypeINT32, ValueTypeINT,
121 ValueTypeUINT32, ValueTypeUINT,
122 ValueTypeFLOAT32, ValueTypeFLOAT,
123 ValueTypeFLOAT64, ValueTypeDOUBLE
124 };
125
126 private:
127
128 bool can_u_read(std::istream& _is) const;
129
130 bool read_ascii(std::istream& _in, BaseImporter& _bi, const Options& _opt) const;
131 bool read_binary(std::istream& _in, BaseImporter& _bi, bool swap, const Options& _opt) const;
132
133 float readToFloatValue(ValueType _type , std::fstream& _in) const;
134
135 void readValue(ValueType _type , std::istream& _in, float& _value) const;
136 void readValue(ValueType _type , std::istream& _in, double& _value) const;
137 void readValue(ValueType _type , std::istream& _in, unsigned int& _value) const;
138 void readValue(ValueType _type , std::istream& _in, unsigned short& _value) const;
139 void readValue(ValueType _type , std::istream& _in, unsigned char& _value) const;
140 void readValue(ValueType _type , std::istream& _in, int& _value) const;
141 void readValue(ValueType _type , std::istream& _in, short& _value) const;
142 void readValue(ValueType _type , std::istream& _in, signed char& _value) const;
143
144 void readInteger(ValueType _type, std::istream& _in, int& _value) const;
145 void readInteger(ValueType _type, std::istream& _in, unsigned int& _value) const;
146
148 void consume_input(std::istream& _in, int _count) const {
149 _in.read(reinterpret_cast<char*>(&buff[0]), _count);
150 }
151
152 mutable unsigned char buff[8];
153
155 mutable Options options_;
156
158 mutable Options userOptions_;
159
160 mutable unsigned int vertexCount_;
161 mutable unsigned int faceCount_;
162
163 mutable uint vertexDimension_;
164
165 enum Property {
166 XCOORD,YCOORD,ZCOORD,
167 TEXX,TEXY,
168 COLORRED,COLORGREEN,COLORBLUE,COLORALPHA,
169 XNORM,YNORM,ZNORM, CUSTOM_PROP, VERTEX_INDICES,
170 UNSUPPORTED
171 };
172
174 mutable std::map<ValueType, int> scalar_size_;
175
176 // Number of vertex properties
177 struct PropertyInfo
178 {
179 Property property;
180 ValueType value;
181 std::string name;//for custom properties
182 ValueType listIndexType;//if type is unsupported, the poerty is not a list. otherwise, it the index type
183 PropertyInfo():property(UNSUPPORTED),value(Unsupported),name(""),listIndexType(Unsupported){}
184 PropertyInfo(Property _p, ValueType _v):property(_p),value(_v),name(""),listIndexType(Unsupported){}
185 PropertyInfo(Property _p, ValueType _v, const std::string& _n):property(_p),value(_v),name(_n),listIndexType(Unsupported){}
186 };
187
188 enum Element {
189 VERTEX,
190 FACE,
191 UNKNOWN
192 };
193
194 // Information on the elements
195 struct ElementInfo
196 {
197 Element element_;
198 std::string name_;
199 unsigned int count_;
200 std::vector< PropertyInfo > properties_;
201 };
202
203 mutable std::vector< ElementInfo > elements_;
204
205 template<typename T>
206 inline void read(_PLYReader_::ValueType _type, std::istream& _in, T& _value, OpenMesh::GenProg::TrueType /*_binary*/) const
207 {
208 readValue(_type, _in, _value);
209 }
210
211 template<typename T>
212 inline void read(_PLYReader_::ValueType _type, std::istream& _in, T& _value, OpenMesh::GenProg::FalseType /*_binary*/) const
213 {
214 _in >> _value;
215 }
216
217 //read and assign custom properties with the given type. Also creates property, if not exist
218 template<bool binary, typename T, typename Handle>
219 void readCreateCustomProperty(std::istream& _in, BaseImporter& _bi, Handle _h, const std::string& _propName, const ValueType _valueType, const ValueType _listType) const;
220
221 template<bool binary, typename Handle>
222 void readCustomProperty(std::istream& _in, BaseImporter& _bi, Handle _h, const std::string& _propName, const _PLYReader_::ValueType _valueType, const _PLYReader_::ValueType _listIndexType) const;
223 };
224
225
226 //== TYPE DEFINITION ==========================================================
227
228
230 extern _PLYReader_ __PLYReaderInstance;
231 OPENMESHDLLEXPORT _PLYReader_& PLYReader();
232
233
234 //=============================================================================
235 } // namespace IO
236 } // namespace OpenMesh
237 //=============================================================================
238 #endif
239 //=============================================================================
OpenMesh::IO::BaseReader
Definition: BaseReader.hh:89
OpenMesh::IO::_PLYReader_::get_description
std::string get_description() const
Returns a brief description of the file type that can be parsed.
Definition: PLYReader.hh:100
OpenMesh::IO::_PLYReader_::consume_input
void consume_input(std::istream &_in, int _count) const
Read unsupported properties in PLY file.
Definition: PLYReader.hh:148
OpenMesh::IO::_PLYReader_::get_magic
std::string get_magic() const
Return magic bits used to determine file format.
Definition: PLYReader.hh:102
OpenMesh::IO::_PLYReader_::get_extensions
std::string get_extensions() const
Definition: PLYReader.hh:101
OpenMesh::IO::_PLYReader_
Definition: PLYReader.hh:94
OpenMesh::IO::_PLYReader_::options_
Options options_
Available per file options for reading.
Definition: PLYReader.hh:155
BaseImporter
Definition: BaseImporter.hh:1
OpenMesh::IO::_PLYReader_::scalar_size_
std::map< ValueType, int > scalar_size_
Stores sizes of property types.
Definition: PLYReader.hh:174
OpenMesh::IO::_PLYReader_::ElementInfo
Definition: PLYReader.hh:195
OpenMesh::IO::__PLYReaderInstance
_PLYReader_ __PLYReaderInstance
Declare the single entity of the PLY reader.
Definition: PLYReader.cc:72
config.h
OpenMesh::IO::Options
Set options for reader/writer modules.
Definition: Options.hh:90
OpenMesh::IO::_PLYReader_::PropertyInfo
Definition: PLYReader.hh:177
OpenMesh::IO::BaseImporter
Definition: BaseImporter.hh:83
OpenMesh
Definition: MeshItems.hh:59
OpenMesh::IO::_PLYReader_::userOptions_
Options userOptions_
Options that the user wants to read.
Definition: PLYReader.hh:158