OctreeNodePlyReaderDelegate.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_OCTREENODEPLYREADERDELEGATE_H
17 #define SURGSIM_DATASTRUCTURES_OCTREENODEPLYREADERDELEGATE_H
18 
22 
23 namespace SurgSim
24 {
25 namespace DataStructures
26 {
27 
31 {
32 public:
33 
36 
39 
40  bool registerDelegate(PlyReader* reader) override;
41 
42  bool fileIsAcceptable(const PlyReader& reader) override;
43 
49  void* beginBounds(const std::string& elementName, size_t count);
50 
56  void* beginDimension(const std::string& elementName, size_t count);
57 
63  void* beginSpacing(const std::string& elementName, size_t count);
64 
69  virtual void* beginVoxel(const std::string& elementName, size_t count);
70 
74  virtual void processVoxel(const std::string& elementName) = 0;
75 
76 protected:
78  virtual void initializeOctree() = 0;
79 
81  struct BoundsData
82  {
83  double xMin;
84  double yMin;
85  double zMin;
86  double xMax;
87  double yMax;
88  double zMax;
90 
92  Eigen::AlignedBox<double, 3> m_boundingBox;
93 
95  struct SpacingData
96  {
97  double x;
98  double y;
99  double z;
101 
104  {
105  unsigned int x;
106  unsigned int y;
107  unsigned int z;
109 
111  struct VoxelData
112  {
113  double x;
114  double y;
115  double z;
117 
120 
127 
128 };
129 
133 template <typename Data>
135 {
136 public:
137 
140 
143  explicit OctreeNodePlyReaderDelegate(std::shared_ptr<OctreeNode<Data>> octree);
144 
147 
149  std::shared_ptr<OctreeNode<Data>> getOctree();
150 
151  void processVoxel(const std::string& elementName) override;
152 
153  void initializeOctree() override;
154 
155 private:
156 
158  std::shared_ptr<OctreeNode<Data>> m_octree;
159 };
160 
161 }
162 }
163 
165 
166 #endif
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::beginDimension
void * beginDimension(const std::string &elementName, size_t count)
Callback function, begin the processing of the dimension.
Definition: OctreeNodePlyReaderDelegate.cpp:108
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::m_voxel
struct SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::VoxelData m_voxel
OctreeNodePlyReaderDelegate-inl.h
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::SpacingData::y
double y
Definition: OctreeNodePlyReaderDelegate.h:98
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::BoundsData::zMax
double zMax
Definition: OctreeNodePlyReaderDelegate.h:88
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::m_haveDimensions
bool m_haveDimensions
Definition: OctreeNodePlyReaderDelegate.h:124
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::initializeOctree
virtual void initializeOctree()=0
Set up the octree, this is left up to the derived classes.
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::SpacingData::x
double x
Definition: OctreeNodePlyReaderDelegate.h:97
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::SpacingData
Data structure to receive the spacing information from the file.
Definition: OctreeNodePlyReaderDelegate.h:96
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::BoundsData::xMax
double xMax
Definition: OctreeNodePlyReaderDelegate.h:86
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::DimensionData
Data structure to receive the dimension information from the file.
Definition: OctreeNodePlyReaderDelegate.h:104
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::fileIsAcceptable
bool fileIsAcceptable(const PlyReader &reader) override
Check whether the file in the reader can be used with this delegate, this gives the delegate a chance...
Definition: OctreeNodePlyReaderDelegate.cpp:83
SurgSim::DataStructures::OctreeNodePlyReaderDelegate::OctreeNodePlyReaderDelegate
OctreeNodePlyReaderDelegate()
Constructor.
Definition: OctreeNodePlyReaderDelegate-inl.h:25
EmptyData.h
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::SpacingData::z
double z
Definition: OctreeNodePlyReaderDelegate.h:99
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::registerDelegate
bool registerDelegate(PlyReader *reader) override
Registers the delegate with the reader.
Definition: OctreeNodePlyReaderDelegate.cpp:38
SurgSim::DataStructures::OctreeNodePlyReaderDelegate::~OctreeNodePlyReaderDelegate
virtual ~OctreeNodePlyReaderDelegate()
Destructor.
Definition: OctreeNodePlyReaderDelegate-inl.h:40
SurgSim
Definition: CompoundShapeToGraphics.cpp:30
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::beginSpacing
void * beginSpacing(const std::string &elementName, size_t count)
Callback function, begin the processing of the bounds.
Definition: OctreeNodePlyReaderDelegate.cpp:115
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::DimensionData::z
unsigned int z
Definition: OctreeNodePlyReaderDelegate.h:107
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::OctreeNodePlyReaderDelegateBase
OctreeNodePlyReaderDelegateBase()
Constructor.
Definition: OctreeNodePlyReaderDelegate.cpp:25
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::m_bounds
struct SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::BoundsData m_bounds
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::m_dimension
struct SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::DimensionData m_dimension
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::BoundsData
Data Structure to receive the bounds information.
Definition: OctreeNodePlyReaderDelegate.h:82
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::VoxelData::z
double z
Definition: OctreeNodePlyReaderDelegate.h:115
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::m_boundingBox
Eigen::AlignedBox< double, 3 > m_boundingBox
Bounding box, will be initialized from the file.
Definition: OctreeNodePlyReaderDelegate.h:92
SurgSim::DataStructures::OctreeNodePlyReaderDelegate
Subclass the OctreeNodePLyReaderDelegateBase class to enable processing of the templated data,...
Definition: OctreeNodePlyReaderDelegate.h:135
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::processVoxel
virtual void processVoxel(const std::string &elementName)=0
Callback function to process one voxel.
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::VoxelData
Data structure to receive the specific voxel information from the file.
Definition: OctreeNodePlyReaderDelegate.h:112
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase
Delegate to read Octrees from ply files, this is the abstract base class, to let us modify loading by...
Definition: OctreeNodePlyReaderDelegate.h:31
SurgSim::DataStructures::PlyReader
Wrapper for the C .ply file parser This class wraps the main functionality for the original C ....
Definition: PlyReader.h:86
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::m_haveBounds
bool m_haveBounds
Definition: OctreeNodePlyReaderDelegate.h:125
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::m_numLevels
int m_numLevels
Calculated number of levels for the octree.
Definition: OctreeNodePlyReaderDelegate.h:119
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::BoundsData::zMin
double zMin
Definition: OctreeNodePlyReaderDelegate.h:85
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::VoxelData::x
double x
Definition: OctreeNodePlyReaderDelegate.h:113
PlyReaderDelegate.h
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::DimensionData::y
unsigned int y
Definition: OctreeNodePlyReaderDelegate.h:106
SurgSim::DataStructures::OctreeNodePlyReaderDelegate::initializeOctree
void initializeOctree() override
Definition: OctreeNodePlyReaderDelegate-inl.h:62
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::VoxelData::y
double y
Definition: OctreeNodePlyReaderDelegate.h:114
SurgSim::DataStructures::OctreeNode
Octree data structure.
Definition: OctreeNode.h:133
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::~OctreeNodePlyReaderDelegateBase
virtual ~OctreeNodePlyReaderDelegateBase()
Destructor.
Definition: OctreeNodePlyReaderDelegate.cpp:33
OctreeNode.h
SurgSim::DataStructures::OctreeNodePlyReaderDelegate::m_octree
std::shared_ptr< OctreeNode< Data > > m_octree
The octree that will be filled with the data from the file.
Definition: OctreeNodePlyReaderDelegate.h:158
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::beginBounds
void * beginBounds(const std::string &elementName, size_t count)
Callback function, begin the processing of the bounds.
Definition: OctreeNodePlyReaderDelegate.cpp:101
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::DimensionData::x
unsigned int x
Definition: OctreeNodePlyReaderDelegate.h:105
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::m_haveSpacing
bool m_haveSpacing
Definition: OctreeNodePlyReaderDelegate.h:123
string
string(TOUPPER ${DEVICE} DEVICE_UPPER_CASE) option(BUILD_DEVICE_$
Definition: CMakeLists.txt:38
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::m_spacing
struct SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::SpacingData m_spacing
SurgSim::DataStructures::PlyReaderDelegate
PlyReaderDelegate abstract class.
Definition: PlyReaderDelegate.h:32
SurgSim::DataStructures::OctreeNodePlyReaderDelegate::getOctree
std::shared_ptr< OctreeNode< Data > > getOctree()
Definition: OctreeNodePlyReaderDelegate-inl.h:46
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::BoundsData::yMax
double yMax
Definition: OctreeNodePlyReaderDelegate.h:87
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::BoundsData::yMin
double yMin
Definition: OctreeNodePlyReaderDelegate.h:84
SurgSim::DataStructures::OctreeNodePlyReaderDelegate::processVoxel
void processVoxel(const std::string &elementName) override
Definition: OctreeNodePlyReaderDelegate-inl.h:52
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::beginVoxel
virtual void * beginVoxel(const std::string &elementName, size_t count)
Callback function, begin the processing of the voxels.
Definition: OctreeNodePlyReaderDelegate.cpp:122
SurgSim::DataStructures::OctreeNodePlyReaderDelegateBase::BoundsData::xMin
double xMin
Definition: OctreeNodePlyReaderDelegate.h:83