OpenMesh
PLYReader.hh
1 /* ========================================================================= *
2  * *
3  * OpenMesh *
4  * Copyright (c) 2001-2022, 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 override { return "PLY polygon file format"; }
101  std::string get_extensions() const override { return "ply"; }
102  std::string get_magic() const override { return "PLY"; }
103 
104  bool read(const std::string& _filename,
105  BaseImporter& _bi,
106  Options& _opt) override;
107 
108  bool read(std::istream& _is,
109  BaseImporter& _bi,
110  Options& _opt) override;
111 
112  bool can_u_read(const std::string& _filename) const override;
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  void readValue(ValueType _type , std::istream& _in, float& _value) const;
134  void readValue(ValueType _type , std::istream& _in, double& _value) const;
135  void readValue(ValueType _type , std::istream& _in, unsigned int& _value) const;
136  void readValue(ValueType _type , std::istream& _in, unsigned short& _value) const;
137  void readValue(ValueType _type , std::istream& _in, unsigned char& _value) const;
138  void readValue(ValueType _type , std::istream& _in, int& _value) const;
139  void readValue(ValueType _type , std::istream& _in, short& _value) const;
140  void readValue(ValueType _type , std::istream& _in, signed char& _value) const;
141 
142  template<typename T>
143  void readInteger(ValueType _type, std::istream& _in, T& _value) const;
144 
146  void consume_input(std::istream& _in, int _count) const {
147  _in.read(reinterpret_cast<char*>(&buff[0]), _count);
148  }
149 
150  mutable unsigned char buff[8];
151 
153  mutable Options options_;
154 
156  mutable Options userOptions_;
157 
158  mutable unsigned int vertexCount_;
159  mutable unsigned int faceCount_;
160 
161  mutable uint vertexDimension_;
162 
163  enum Property {
164  XCOORD,YCOORD,ZCOORD,
165  TEXX,TEXY,
166  COLORRED,COLORGREEN,COLORBLUE,COLORALPHA,
167  XNORM,YNORM,ZNORM, CUSTOM_PROP, VERTEX_INDICES,
168  UNSUPPORTED
169  };
170 
172  mutable std::map<ValueType, int> scalar_size_;
173 
174  // Number of vertex properties
175  struct PropertyInfo
176  {
177  Property property;
178  ValueType value;
179  std::string name;//for custom properties
180  ValueType listIndexType;//if type is unsupported, the poerty is not a list. otherwise, it the index type
181  PropertyInfo():property(UNSUPPORTED),value(Unsupported),name(""),listIndexType(Unsupported){}
182  PropertyInfo(Property _p, ValueType _v):property(_p),value(_v),name(""),listIndexType(Unsupported){}
183  PropertyInfo(Property _p, ValueType _v, const std::string& _n):property(_p),value(_v),name(_n),listIndexType(Unsupported){}
184  };
185 
186  enum Element {
187  VERTEX,
188  FACE,
189  UNKNOWN
190  };
191 
192  // Information on the elements
193  struct ElementInfo
194  {
195  Element element_;
196  std::string name_;
197  unsigned int count_;
198  std::vector< PropertyInfo > properties_;
199  };
200 
201  mutable std::vector< ElementInfo > elements_;
202 
203  template<typename T>
204  inline void read(_PLYReader_::ValueType _type, std::istream& _in, T& _value, OpenMesh::GenProg::TrueType /*_binary*/) const
205  {
206  readValue(_type, _in, _value);
207  }
208 
209  template<typename T>
210  inline void read(_PLYReader_::ValueType _type, std::istream& _in, T& _value, OpenMesh::GenProg::FalseType /*_binary*/) const
211  {
212  _in >> _value;
213  }
214 
215  template<typename T>
216  inline void readInteger(_PLYReader_::ValueType _type, std::istream& _in, T& _value, OpenMesh::GenProg::TrueType /*_binary*/) const
217  {
218  readInteger(_type, _in, _value);
219  }
220 
221  template<typename T>
222  inline void readInteger(_PLYReader_::ValueType _type, std::istream& _in, T& _value, OpenMesh::GenProg::FalseType /*_binary*/) const
223  {
224  _in >> _value;
225  }
226 
227  //read and assign custom properties with the given type. Also creates property, if not exist
228  template<bool binary, typename T, typename Handle>
229  void readCreateCustomProperty(std::istream& _in, BaseImporter& _bi, Handle _h, const std::string& _propName, const ValueType _valueType, const ValueType _listType) const;
230 
231  template<bool binary, typename Handle>
232  void readCustomProperty(std::istream& _in, BaseImporter& _bi, Handle _h, const std::string& _propName, const _PLYReader_::ValueType _valueType, const _PLYReader_::ValueType _listIndexType) const;
233 };
234 
235 
236 //== TYPE DEFINITION ==========================================================
237 
238 
240 extern _PLYReader_ __PLYReaderInstance;
241 OPENMESHDLLEXPORT _PLYReader_& PLYReader();
242 
243 
244 //=============================================================================
245 } // namespace IO
246 } // namespace OpenMesh
247 //=============================================================================
248 #endif
249 //=============================================================================
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:91
Base class for reader modules.
Definition: BaseReader.hh:87
Implementation of the PLY format reader.
Definition: PLYReader.hh:95
std::string get_description() const override
Returns a brief description of the file type that can be parsed.
Definition: PLYReader.hh:100
std::string get_magic() const override
Return magic bits used to determine file format.
Definition: PLYReader.hh:102
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:101

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