PlyReader.h
Go to the documentation of this file.
1 // This file is a part of the OpenSurgSim project.
2 // Copyright 2013, SimQuest Solutions Inc.
3 //
4 // Licensed under the Apache License, Version 2.0 (the "License");
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
7 //
8 // http://www.apache.org/licenses/LICENSE-2.0
9 //
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
15 
16 #ifndef SURGSIM_DATASTRUCTURES_PLYREADER_H
17 #define SURGSIM_DATASTRUCTURES_PLYREADER_H
18 
19 #include <string>
20 #include <functional>
21 #include <memory>
22 #include <unordered_map>
23 #include <vector>
24 
25 namespace SurgSim
26 {
27 namespace DataStructures
28 {
29 
30 class PlyReaderDelegate;
31 
83 
84 
85 class PlyReader
86 {
87 public:
89  enum Type
90  {
101  };
102 
107  typedef std::function<void* (const std::string&, size_t)> StartElementCallbackType;
108 
111  typedef std::function<void (const std::string&)> StandardCallbackType;
112 
115  explicit PlyReader(const std::string& filename);
116 
118  virtual ~PlyReader();
119 
122  bool isValid() const;
123 
132  bool requestElement(const std::string& elementName,
133  std::function<void* (const std::string&, size_t)> startElementCallback,
134  std::function<void (const std::string&)> processElementCallback,
135  std::function<void (const std::string&)> endElementCallback);
136 
150  bool requestScalarProperty(const std::string& elementName, const std::string& propertyName,
151  int dataType, int dataOffset);
152 
167  bool requestListProperty(const std::string& elementName,
168  const std::string& propertyName,
169  int dataType, int dataOffset,
170  int countType, int countOffset);
171 
175  bool hasElement(const std::string& elementName) const;
176 
181  bool hasProperty(const std::string& elementName, const std::string& propertyName) const;
182 
187  bool isScalar(const std::string& elementName, const std::string& propertyName) const;
188 
192  bool parseWithDelegate(std::shared_ptr<PlyReaderDelegate> delegate);
193 
195  void setStartParseFileCallback(std::function<void (void)> startParseFileCallback);
196 
198  void setEndParseFileCallback(std::function<void (void)> endParseFileCallback);
199 
203  bool setDelegate(std::shared_ptr<PlyReaderDelegate> delegate);
204 
206  void parseFile();
207 
208 private:
209  friend class PlyReaderTests;
210 
221  bool requestProperty(const std::string& elementName,
222  const std::string& propertyName,
223  int dataType, int dataOffset,
224  int countType, int countOffset);
225 
228 
231  {
233  int dataType;
235  int countType;
237  };
238 
240  struct ElementInfo
241  {
246  std::vector<PropertyInfo> requestedProperties;
247  };
248 
249  std::unordered_map<std::string, ElementInfo> m_requestedElements;
250 
253  struct Data;
254  std::unique_ptr<Data> m_data;
256 
258  std::shared_ptr<PlyReaderDelegate> m_delegate;
259 
261  std::function<void(void)> m_startParseFileCallback;
262 
264  std::function<void(void)> m_endParseFileCallback;
265 };
266 
267 } // DataStructures
268 } // SurgSim
269 
270 #endif // SURGSIM_DATASTRUCTURES_PLYREADER_H
SurgSim::DataStructures::PlyReader::ElementInfo
Information about the element in the .ply file.
Definition: PlyReader.h:240
SurgSim::DataStructures::PlyReader::~PlyReader
virtual ~PlyReader()
Destructor.
Definition: PlyReader.cpp:74
SurgSim::DataStructures::PlyReader::TYPE_COUNT
@ TYPE_COUNT
Definition: PlyReader.h:100
SurgSim::DataStructures::PlyReader::TYPE_INVALID
@ TYPE_INVALID
Definition: PlyReader.h:91
SurgSim::DataStructures::PlyReader::parseWithDelegate
bool parseWithDelegate(std::shared_ptr< PlyReaderDelegate > delegate)
Sets a delegate for parsing and then parse the file.
Definition: PlyReader.cpp:333
SurgSim::DataStructures::PlyReader::ElementInfo::startElementCallback
StartElementCallbackType startElementCallback
Callback to be used when the element is first encountered.
Definition: PlyReader.h:243
SurgSim::DataStructures::PlyReader::PropertyInfo::dataType
int dataType
Type of the receiving data.
Definition: PlyReader.h:233
SurgSim::DataStructures::PlyReader::requestScalarProperty
bool requestScalarProperty(const std::string &elementName, const std::string &propertyName, int dataType, int dataOffset)
Request a scalar property for parsing.
Definition: PlyReader.cpp:118
SurgSim::DataStructures::PlyReader::TYPE_UNSIGNED_CHAR
@ TYPE_UNSIGNED_CHAR
Definition: PlyReader.h:95
SurgSim::DataStructures::PlyReader::PlyReader
PlyReader(const std::string &filename)
Constructor.
Definition: PlyReader.cpp:60
SurgSim::DataStructures::PlyReader::ElementInfo::requestedProperties
std::vector< PropertyInfo > requestedProperties
All the properties that are wanted.
Definition: PlyReader.h:246
SurgSim::DataStructures::PlyReader::m_data
std::unique_ptr< Data > m_data
Definition: PlyReader.h:253
SurgSim::DataStructures::PlyReader::m_endParseFileCallback
std::function< void(void)> m_endParseFileCallback
Callback to be executed at the end of 'parseFile'.
Definition: PlyReader.h:264
SurgSim::DataStructures::PlyReader::requestListProperty
bool requestListProperty(const std::string &elementName, const std::string &propertyName, int dataType, int dataOffset, int countType, int countOffset)
Request a list property for parsing.
Definition: PlyReader.cpp:124
SurgSim
Definition: CompoundShapeToGraphics.cpp:29
SurgSim::DataStructures::PlyReader::PropertyInfo::dataOffset
int dataOffset
Location for the receiving data.
Definition: PlyReader.h:234
SurgSim::DataStructures::PlyReader::Data
Definition: PlyReader.cpp:34
SurgSim::DataStructures::PlyReader::TYPE_INT
@ TYPE_INT
Definition: PlyReader.h:94
SurgSim::DataStructures::PlyReader::StartElementCallbackType
std::function< void *(const std::string &, size_t)> StartElementCallbackType
The callback that is being used to indicate the start of an element, the parameters that are passed i...
Definition: PlyReader.h:107
SurgSim::DataStructures::PlyReader::PropertyInfo::countOffset
int countOffset
For lists, location of the receiving data for the count.
Definition: PlyReader.h:236
SurgSim::DataStructures::PlyReader::PropertyInfo
Information about the property on the .ply file.
Definition: PlyReader.h:230
SurgSim::DataStructures::PlyReader::requestElement
bool requestElement(const std::string &elementName, std::function< void *(const std::string &, size_t)> startElementCallback, std::function< void(const std::string &)> processElementCallback, std::function< void(const std::string &)> endElementCallback)
Request element to be processed during parsing.
Definition: PlyReader.cpp:94
SurgSim::DataStructures::PlyReader
Wrapper for the C .ply file parser This class wraps the main functionality for the original C ....
Definition: PlyReader.h:85
SurgSim::DataStructures::PlyReader::PropertyInfo::propertyName
std::string propertyName
Name of the property.
Definition: PlyReader.h:232
SurgSim::DataStructures::PlyReader::m_delegate
std::shared_ptr< PlyReaderDelegate > m_delegate
The delegate.
Definition: PlyReader.h:258
SurgSim::DataStructures::PlyReader::TYPE_CHAR
@ TYPE_CHAR
Definition: PlyReader.h:92
SurgSim::DataStructures::PlyReader::Type
Type
Values that represent the data type/size of requested data.
Definition: PlyReader.h:89
SurgSim::DataStructures::PlyReader::ElementInfo::endElementCallback
StandardCallbackType endElementCallback
Callback to be used after all the elements have been processed.
Definition: PlyReader.h:245
SurgSim::DataStructures::PlyReader::PlyReaderTests
friend class PlyReaderTests
Definition: PlyReader.h:209
SurgSim::DataStructures::PlyReader::parseFile
void parseFile()
Parse the file.
Definition: PlyReader.cpp:211
SurgSim::DataStructures::PlyReader::TYPE_DOUBLE
@ TYPE_DOUBLE
Definition: PlyReader.h:99
SurgSim::DataStructures::PlyReader::m_startParseFileCallback
std::function< void(void)> m_startParseFileCallback
Callback to be executed at the start of 'parseFile'.
Definition: PlyReader.h:261
SurgSim::DataStructures::PlyReader::isScalar
bool isScalar(const std::string &elementName, const std::string &propertyName) const
Query if the property of the give element is scalar.
Definition: PlyReader.cpp:364
SurgSim::DataStructures::PlyReader::m_requestedElements
std::unordered_map< std::string, ElementInfo > m_requestedElements
Definition: PlyReader.h:249
SurgSim::DataStructures::PlyReader::StandardCallbackType
std::function< void(const std::string &)> StandardCallbackType
The callback that is used for the processing and the end of processing, the parameter passed is the n...
Definition: PlyReader.h:111
SurgSim::DataStructures::PlyReader::setStartParseFileCallback
void setStartParseFileCallback(std::function< void(void)> startParseFileCallback)
Register callback to be called at the begining of parseFile.
Definition: PlyReader.cpp:132
SurgSim::DataStructures::PlyReader::hasProperty
bool hasProperty(const std::string &elementName, const std::string &propertyName) const
Query if 'elementName' has the given property.
Definition: PlyReader.cpp:350
SurgSim::DataStructures::PlyReader::hasElement
bool hasElement(const std::string &elementName) const
Query if this elementName is in the .ply file.
Definition: PlyReader.cpp:343
string
string(TOUPPER ${DEVICE} DEVICE_UPPER_CASE) option(BUILD_DEVICE_$
Definition: CMakeLists.txt:38
SurgSim::DataStructures::PlyReader::isValid
bool isValid() const
Query if this object is valid.
Definition: PlyReader.cpp:89
SurgSim::DataStructures::PlyReader::setDelegate
bool setDelegate(std::shared_ptr< PlyReaderDelegate > delegate)
Sets a delegate for parsing.
Definition: PlyReader.cpp:196
SurgSim::DataStructures::PlyReader::TYPE_UNSIGNED_INT
@ TYPE_UNSIGNED_INT
Definition: PlyReader.h:97
SurgSim::DataStructures::PlyReader::ElementInfo::name
std::string name
Name of the element.
Definition: PlyReader.h:242
SurgSim::DataStructures::PlyReader::setEndParseFileCallback
void setEndParseFileCallback(std::function< void(void)> endParseFileCallback)
Register callback to be called at the end of parseFile.
Definition: PlyReader.cpp:137
SurgSim::DataStructures::PlyReader::m_filename
std::string m_filename
The name of the .ply file.
Definition: PlyReader.h:227
SurgSim::DataStructures::PlyReader::TYPE_UNSIGNED_SHORT
@ TYPE_UNSIGNED_SHORT
Definition: PlyReader.h:96
SurgSim::DataStructures::PlyReader::PropertyInfo::countType
int countType
For lists, type of the receiving data for the count of listelements.
Definition: PlyReader.h:235
SurgSim::DataStructures::PlyReader::TYPE_FLOAT
@ TYPE_FLOAT
Definition: PlyReader.h:98
SurgSim::DataStructures::PlyReader::TYPE_SHORT
@ TYPE_SHORT
Definition: PlyReader.h:93
SurgSim::DataStructures::PlyReader::ElementInfo::processElementCallback
StandardCallbackType processElementCallback
Callback to be used for each processed element.
Definition: PlyReader.h:244
SurgSim::DataStructures::PlyReader::requestProperty
bool requestProperty(const std::string &elementName, const std::string &propertyName, int dataType, int dataOffset, int countType, int countOffset)
Generic Internal function to handle list and scalar properties, see requestScalarProperty() and reque...
Definition: PlyReader.cpp:142