31 #ifndef OPENVDB_GRID_HAS_BEEN_INCLUDED
32 #define OPENVDB_GRID_HAS_BEEN_INCLUDED
37 #include <boost/static_assert.hpp>
38 #include <boost/type_traits/remove_const.hpp>
39 #include <boost/type_traits/is_floating_point.hpp>
40 #include <openvdb/Types.h>
41 #include <openvdb/util/Name.h>
42 #include <openvdb/math/Transform.h>
43 #include <openvdb/tree/Tree.h>
44 #include <openvdb/metadata/MetaMap.h>
45 #include <openvdb/Exceptions.h>
54 template<
typename>
class Grid;
61 template<
typename Gr
idType>
62 inline typename GridType::Ptr
createGrid(
const typename GridType::ValueType& background);
68 template<
typename Gr
idType>
76 template<
typename TreePtrType>
94 template<
typename Gr
idType>
106 typedef boost::shared_ptr<GridBase>
Ptr;
107 typedef boost::shared_ptr<const GridBase>
ConstPtr;
109 typedef Ptr (*GridFactory)();
129 static bool isRegistered(
const Name &type);
132 static void clearRegistry();
139 virtual Name type()
const = 0;
141 virtual Name valueType()
const = 0;
144 template<
typename Gr
idType>
145 bool isType()
const {
return (this->type() == GridType::gridType()); }
148 template<
typename Gr
idType>
152 template<
typename Gr
idType>
154 template<
typename Gr
idType>
155 static typename GridType::ConstPtr constGrid(
const GridBase::Ptr&);
156 template<
typename Gr
idType>
169 TreeBase& baseTree() {
return const_cast<TreeBase&
>(this->constBaseTree()); }
186 virtual void newTree() = 0;
189 virtual bool empty()
const = 0;
191 virtual void clear() = 0;
198 virtual void pruneGrid(
float tolerance = 0.0) = 0;
205 std::string getName()
const;
207 void setName(
const std::string&);
210 std::string getCreator()
const;
212 void setCreator(
const std::string&);
216 bool saveFloatAsHalf()
const;
217 void setSaveFloatAsHalf(
bool);
224 void clearGridClass();
227 static std::string gridClassToString(
GridClass);
229 static std::string gridClassToMenuName(
GridClass);
233 static GridClass stringToGridClass(
const std::string&);
242 void clearVectorType();
245 static std::string vecTypeToString(
VecType);
248 static std::string vecTypeExamples(
VecType);
251 static std::string vecTypeDescription(
VecType);
252 static VecType stringToVecType(
const std::string&);
257 bool isInWorldSpace()
const;
259 void setIsInWorldSpace(
bool);
282 virtual Index64 activeVoxelCount()
const = 0;
286 virtual CoordBBox evalActiveVoxelBoundingBox()
const = 0;
289 virtual Coord evalActiveVoxelDim()
const = 0;
292 virtual Index64 memUsage()
const = 0;
298 void addStatsMetadata();
340 Vec3d indexToWorld(
const Vec3d& xyz)
const {
return transform().indexToWorld(xyz); }
344 Vec3d worldToIndex(
const Vec3d& xyz)
const {
return transform().worldToIndex(xyz); }
353 virtual void readTopology(std::istream&) = 0;
356 virtual void writeTopology(std::ostream&)
const = 0;
359 virtual void readBuffers(std::istream&) = 0;
361 virtual void writeBuffers(std::ostream&)
const = 0;
369 virtual void print(std::ostream& = std::cout,
int verboseLevel = 1)
const = 0;
374 GridBase(): mTransform(math::Transform::createLinearTransform()) {}
383 static void registerGrid(
const Name& type, GridFactory);
385 static void unregisterGrid(
const Name& type);
426 template<
typename Gr
idPtrContainerT>
427 inline typename GridPtrContainerT::value_type
430 typedef typename GridPtrContainerT::value_type GridPtrT;
431 typename GridPtrContainerT::const_iterator it =
432 std::find_if(container.begin(), container.end(),
GridNamePred(name));
433 return (it == container.end() ? GridPtrT() : *it);
437 template<
typename KeyT,
typename Gr
idPtrT>
441 typedef std::map<KeyT, GridPtrT> GridPtrMapT;
442 for (
typename GridPtrMapT::const_iterator it = container.begin(), end = container.end();
445 const GridPtrT& grid = it->second;
446 if (grid && grid->getName() == name)
return grid;
457 template<
typename _TreeType>
461 typedef boost::shared_ptr<Grid>
Ptr;
485 template<
typename OtherValueType>
530 Ptr deepCopy()
const {
return Ptr(
new Grid(*
this)); }
536 virtual Name type()
const {
return this->gridType(); }
553 virtual bool empty()
const {
return tree().empty(); }
555 virtual void clear() { tree().clear(); }
560 ConstAccessor getAccessor()
const {
return ConstAccessor(tree()); }
566 ValueOnIter beginValueOn() {
return tree().beginValueOn(); }
572 ValueOffIter beginValueOff() {
return tree().beginValueOff(); }
578 ValueAllIter beginValueAll() {
return tree().beginValueAll(); }
585 void evalMinMax(ValueType& minVal, ValueType& maxVal)
const;
595 void fill(
const CoordBBox& bbox,
const ValueType& value,
bool active =
true);
611 void signedFloodFill(
const ValueType& outside,
const ValueType& inside);
619 virtual void pruneGrid(
float tolerance = 0.0);
639 template<
typename OtherTreeType>
650 virtual CoordBBox evalActiveVoxelBoundingBox()
const;
652 virtual Coord evalActiveVoxelDim()
const;
663 TreePtrType treePtr() {
return mTree; }
671 TreeType& tree() {
return *mTree; }
689 virtual void newTree();
697 virtual void readTopology(std::istream&);
700 virtual void writeTopology(std::ostream&)
const;
703 virtual void readBuffers(std::istream&);
705 virtual void writeBuffers(std::ostream&)
const;
708 virtual void print(std::ostream& = std::cout,
int verboseLevel = 1)
const;
743 template<
typename Gr
idType>
744 inline typename GridType::Ptr
747 return GridBase::grid<GridType>(grid);
759 template<
typename Gr
idType>
760 inline typename GridType::ConstPtr
763 return GridBase::constGrid<GridType>(grid);
776 template<
typename Gr
idType>
777 inline typename GridType::Ptr
780 if (!grid || !grid->isType<GridType>())
return typename GridType::Ptr();
781 return gridPtrCast<GridType>(grid->deepCopyGrid());
785 template<
typename Gr
idType>
786 inline typename GridType::Ptr
789 if (!grid.
isType<GridType>())
return typename GridType::Ptr();
799 template<
typename _TreeType>
831 template<
typename _TreeType>
860 template<
typename _TreeType>
896 template<
typename Gr
idType>
897 inline typename GridType::Ptr
902 if (grid && grid->type() == GridType::gridType()) {
903 return boost::static_pointer_cast<GridType>(grid);
905 return typename GridType::Ptr();
909 template<
typename Gr
idType>
910 inline typename GridType::ConstPtr
913 return boost::const_pointer_cast<
const GridType>(
914 GridBase::grid<GridType>(boost::const_pointer_cast<
GridBase>(grid)));
918 template<
typename Gr
idType>
919 inline typename GridType::ConstPtr
922 return boost::const_pointer_cast<
const GridType>(GridBase::grid<GridType>(grid));
926 template<
typename Gr
idType>
927 inline typename GridType::ConstPtr
930 return boost::const_pointer_cast<
const GridType>(
931 GridBase::grid<GridType>(boost::const_pointer_cast<
GridBase>(grid)));
938 return boost::const_pointer_cast<
TreeBase>(this->constBaseTreePtr());
953 template<
typename TreeT>
959 template<
typename TreeT>
965 template<
typename TreeT>
972 template<
typename TreeT>
975 mTree(boost::static_pointer_cast<
TreeType>(other.mTree->copy()))
980 template<
typename TreeT>
988 template<
typename TreeT>
997 template<
typename TreeT>
1006 template<
typename TreeT>
1010 return Ptr(
new Grid(background));
1015 template<
typename TreeT>
1024 template<
typename TreeT>
1035 template<
typename TreeT>
1040 switch (treePolicy) {
1046 ret.reset(
new Grid(*
this));
1056 template<
typename TreeT>
1060 return this->copy(treePolicy);
1067 template<
typename TreeT>
1072 if (tree->type() != TreeType::treeType()) {
1074 + tree->type() +
" to a grid of type " + this->type());
1076 mTree = boost::static_pointer_cast<
TreeType>(tree);
1080 template<
typename TreeT>
1084 mTree.reset(
new TreeType(this->background()));
1088 template<
typename TreeT>
1092 tree().fill(bbox, value, active);
1096 template<
typename TreeT>
1100 tree().signedFloodFill(outside, inside);
1104 template<
typename TreeT>
1108 this->prune(
ValueType(zeroVal<ValueType>() + tolerance));
1112 template<
typename TreeT>
1116 tree().evalMinMax(minVal, maxVal);
1120 template<
typename TreeT>
1125 tree().evalActiveVoxelBoundingBox(bbox);
1130 template<
typename TreeT>
1135 const bool nonempty = tree().evalActiveVoxelDim(dim);
1136 return (nonempty ? dim :
Coord());
1146 template<
typename TreeT>
1150 tree().readTopology(is, saveFloatAsHalf());
1154 template<
typename TreeT>
1158 tree().writeTopology(os, saveFloatAsHalf());
1162 template<
typename TreeT>
1166 tree().readBuffers(is, saveFloatAsHalf());
1170 template<
typename TreeT>
1174 tree().writeBuffers(os, saveFloatAsHalf());
1178 template<
typename TreeT>
1182 tree().print(os, verboseLevel);
1184 if (metaCount() > 0) {
1185 os <<
"Additional metadata:" << std::endl;
1187 os <<
" " << it->first;
1189 const std::string value = it->second->str();
1190 if (!value.empty()) os <<
": " << value;
1196 os <<
"Transform:" << std::endl;
1197 transform().print(os,
" ");
1205 template<
typename Gr
idType>
1206 inline typename GridType::Ptr
1209 return GridType::create(background);
1213 template<
typename Gr
idType>
1214 inline typename GridType::Ptr
1217 return GridType::create();
1221 template<
typename TreePtrType>
1225 typedef typename TreePtrType::element_type TreeType;
1230 template<
typename Gr
idType>
1231 typename GridType::Ptr
1234 typedef typename GridType::ValueType ValueType;
1237 BOOST_STATIC_ASSERT(boost::is_floating_point<ValueType>::value);
1239 typename GridType::Ptr grid = GridType::create(
1240 static_cast<ValueType>(voxelSize * halfWidth));
1249 #endif // OPENVDB_GRID_HAS_BEEN_INCLUDED