OpenMesh: OpenMesh/Core/IO/reader/PLYReader.hh Source File

| OpenMesh

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