OpenMesh
PLYReader.hh
1/* ========================================================================= *
2 * *
3 * OpenMesh *
4 * Copyright (c) 2001-2025, 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#include <list>
65
66#include <OpenMesh/Core/System/config.h>
67#include <OpenMesh/Core/Utils/SingletonT.hh>
68#include <OpenMesh/Core/IO/reader/BaseReader.hh>
69#include <OpenMesh/Core/Utils/GenProg.hh>
70
71
72//== NAMESPACES ===============================================================
73
74
75namespace OpenMesh {
76namespace IO {
77
78
79//== FORWARDS =================================================================
80
81
82class BaseImporter;
83
84
85//== IMPLEMENTATION ===========================================================
86
87
95class OPENMESHDLLEXPORT _PLYReader_ : public BaseReader
96{
97public:
98
100
101 std::string get_description() const override { return "PLY polygon file format"; }
102 std::string get_extensions() const override { return "ply"; }
103 std::string get_magic() const override { return "PLY"; }
104
105 bool read(const std::string& _filename,
106 BaseImporter& _bi,
107 Options& _opt) override;
108
109 bool read(std::istream& _is,
110 BaseImporter& _bi,
111 Options& _opt) override;
112
113 bool can_u_read(const std::string& _filename) const override;
114
115 enum ValueType {
116 Unsupported,
117 ValueTypeINT8, ValueTypeCHAR,
118 ValueTypeUINT8, ValueTypeUCHAR,
119 ValueTypeINT16, ValueTypeSHORT,
120 ValueTypeUINT16, ValueTypeUSHORT,
121 ValueTypeINT32, ValueTypeINT,
122 ValueTypeUINT32, ValueTypeUINT,
123 ValueTypeFLOAT32, ValueTypeFLOAT,
124 ValueTypeFLOAT64, ValueTypeDOUBLE
125 };
126
127private:
128
129 bool can_u_read(std::istream& _is) const;
130
131 bool read_ascii(std::istream& _in, BaseImporter& _bi, const Options& _opt) const;
132 bool read_binary(std::istream& _in, BaseImporter& _bi, bool swap, const Options& _opt) const;
133
134 void readValue(ValueType _type , std::istream& _in, float& _value) const;
135 void readValue(ValueType _type , std::istream& _in, double& _value) const;
136 void readValue(ValueType _type , std::istream& _in, unsigned int& _value) const;
137 void readValue(ValueType _type , std::istream& _in, unsigned short& _value) const;
138 void readValue(ValueType _type , std::istream& _in, unsigned char& _value) const;
139 void readValue(ValueType _type , std::istream& _in, int& _value) const;
140 void readValue(ValueType _type , std::istream& _in, short& _value) const;
141 void readValue(ValueType _type , std::istream& _in, signed char& _value) const;
142
143 template<typename T>
144 void readInteger(ValueType _type, std::istream& _in, T& _value) const;
145
147 void consume_input(std::istream& _in, int _count) const {
148
149 // Make sure, we do not run over our buffer size
150 int loops = _count / 8 ;
151
152 // Read only our buffer size batches
153 for ( auto i = 0 ; i < loops; ++i) {
154 _in.read(reinterpret_cast<char*>(&buff[0]), 8);
155 }
156
157 // Read reminder which is smaller than our buffer size
158 _in.read(reinterpret_cast<char*>(&buff[0]), _count - 8 * loops );
159 }
160
161 mutable unsigned char buff[8];
162
164 mutable Options options_;
165
167 mutable Options userOptions_;
168
169 mutable unsigned int vertexCount_;
170 mutable unsigned int faceCount_;
171
172 mutable uint vertexDimension_;
173
174 enum Property {
175 XCOORD,YCOORD,ZCOORD,
176 TEXX,TEXY,
177 COLORRED,COLORGREEN,COLORBLUE,COLORALPHA,
178 XNORM,YNORM,ZNORM, CUSTOM_PROP, VERTEX_INDICES,
179 TEXCOORD, TEXNUMBER, UNSUPPORTED
180 };
181
183 mutable std::map<ValueType, int> scalar_size_;
184
185 // Number of vertex properties
186 struct PropertyInfo
187 {
188 Property property;
189 ValueType value;
190 std::string name;//for custom properties
191 ValueType listIndexType;//if type is unsupported, the poerty is not a list. otherwise, it the index type
192 PropertyInfo():property(UNSUPPORTED),value(Unsupported),name(""),listIndexType(Unsupported){}
193 PropertyInfo(Property _p, ValueType _v):property(_p),value(_v),name(""),listIndexType(Unsupported){}
194 PropertyInfo(Property _p, ValueType _v, const std::string& _n):property(_p),value(_v),name(_n),listIndexType(Unsupported){}
195 };
196
197 enum Element {
198 VERTEX,
199 FACE,
200 UNKNOWN
201 };
202
203 // Information on the elements
204 struct ElementInfo
205 {
206 Element element_;
207 std::string name_;
208 unsigned int count_;
209 std::vector< PropertyInfo > properties_;
210 };
211
212 mutable std::vector< ElementInfo > elements_;
213
214 mutable std::vector< std::string > texture_files_;
215
216 template<typename T>
217 inline void read(_PLYReader_::ValueType _type, std::istream& _in, T& _value, OpenMesh::GenProg::TrueType /*_binary*/) const
218 {
219 readValue(_type, _in, _value);
220 }
221
222 template<typename T>
223 inline void read(_PLYReader_::ValueType _type, std::istream& _in, T& _value, OpenMesh::GenProg::FalseType /*_binary*/) const
224 {
225 _in >> _value;
226 }
227
228 template<typename T>
229 inline void readInteger(_PLYReader_::ValueType _type, std::istream& _in, T& _value, OpenMesh::GenProg::TrueType /*_binary*/) const
230 {
231 readInteger(_type, _in, _value);
232 }
233
234 template<typename T>
235 inline void readInteger(_PLYReader_::ValueType _type, std::istream& _in, T& _value, OpenMesh::GenProg::FalseType /*_binary*/) const
236 {
237 _in >> _value;
238 }
239
240 //read and assign custom properties with the given type. Also creates property, if not exist
241 template<bool binary, typename T, typename Handle>
242 void readCreateCustomProperty(std::istream& _in, BaseImporter& _bi, Handle _h, const std::string& _propName, const ValueType _valueType, const ValueType _listType) const;
243
244 template<bool binary, typename Handle>
245 void readCustomProperty(std::istream& _in, BaseImporter& _bi, Handle _h, const std::string& _propName, const _PLYReader_::ValueType _valueType, const _PLYReader_::ValueType _listIndexType) const;
246};
247
248
249//== TYPE DEFINITION ==========================================================
250
251
253extern _PLYReader_ __PLYReaderInstance;
254OPENMESHDLLEXPORT _PLYReader_& PLYReader();
255
256
257//=============================================================================
258} // namespace IO
259} // namespace OpenMesh
260//=============================================================================
261#endif
262//=============================================================================
Contains all the mesh ingredients like the polygonal mesh, the triangle mesh, different mesh kernels ...
Definition: MeshItems.hh:59
_PLYReader_ __PLYReaderInstance
Declare the single entity of the PLY reader.
Definition: PLYReader.cc:73
Base class for importer modules.
Definition: BaseImporter.hh:84
Set options for reader/writer modules.
Definition: Options.hh:92
Base class for reader modules.
Definition: BaseReader.hh:87
Implementation of the PLY format reader.
Definition: PLYReader.hh:96
std::string get_description() const override
Returns a brief description of the file type that can be parsed.
Definition: PLYReader.hh:101
std::string get_magic() const override
Return magic bits used to determine file format.
Definition: PLYReader.hh:103
std::string get_extensions() const override
Returns a string with the accepted file extensions separated by a whitespace and in small caps.
Definition: PLYReader.hh:102

Project OpenMesh, ©  Visual Computing Institute, RWTH Aachen. Documentation generated using doxygen .