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()); }
150 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>
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();
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>
537 virtual Name type()
const {
return this->gridType(); }
554 virtual bool empty()
const {
return tree().empty(); }
556 virtual void clear() { tree().clear(); }
586 void evalMinMax(ValueType& minVal, ValueType& maxVal)
const;
596 void fill(
const CoordBBox& bbox,
const ValueType& value,
bool active =
true);
612 void signedFloodFill(
const ValueType& outside,
const ValueType& inside);
618 void prune(
const ValueType& tolerance = zeroVal<ValueType>()) { tree().prune(tolerance); }
620 virtual void pruneGrid(
float tolerance = 0.0);
640 template<
typename OtherTreeType>
651 virtual CoordBBox evalActiveVoxelBoundingBox()
const;
653 virtual Coord evalActiveVoxelDim()
const;
690 virtual void newTree();
698 virtual void readTopology(std::istream&);
701 virtual void writeTopology(std::ostream&)
const;
704 virtual void readBuffers(std::istream&);
706 virtual void writeBuffers(std::ostream&)
const;
709 virtual void print(std::ostream& = std::cout,
int verboseLevel = 1)
const;
744 template<
typename Gr
idType>
745 inline typename GridType::Ptr
748 return GridBase::grid<GridType>(grid);
760 template<
typename Gr
idType>
761 inline typename GridType::ConstPtr
764 return GridBase::constGrid<GridType>(grid);
777 template<
typename Gr
idType>
778 inline typename GridType::Ptr
781 if (!grid || !grid->isType<GridType>())
return typename GridType::Ptr();
782 return gridPtrCast<GridType>(grid->deepCopyGrid());
786 template<
typename Gr
idType>
787 inline typename GridType::Ptr
790 if (!grid.
isType<GridType>())
return typename GridType::Ptr();
802 template<
typename _TreeType>
829 template<
typename _TreeType>
859 template<
typename Gr
idType>
860 inline typename GridType::Ptr
865 if (grid && grid->type() == GridType::gridType()) {
866 return boost::static_pointer_cast<GridType>(grid);
868 return typename GridType::Ptr();
872 template<
typename Gr
idType>
873 inline typename GridType::ConstPtr
876 return boost::const_pointer_cast<
const GridType>(
877 GridBase::grid<GridType>(boost::const_pointer_cast<
GridBase>(grid)));
881 template<
typename Gr
idType>
882 inline typename GridType::ConstPtr
885 return boost::const_pointer_cast<
const GridType>(GridBase::grid<GridType>(grid));
889 template<
typename Gr
idType>
890 inline typename GridType::ConstPtr
893 return boost::const_pointer_cast<
const GridType>(
894 GridBase::grid<GridType>(boost::const_pointer_cast<
GridBase>(grid)));
901 return boost::const_pointer_cast<
TreeBase>(this->constBaseTreePtr());
916 template<
typename TreeT>
922 template<
typename TreeT>
928 template<
typename TreeT>
935 template<
typename TreeT>
938 mTree(boost::static_pointer_cast<
TreeType>(other.mTree->copy()))
943 template<
typename TreeT>
951 template<
typename TreeT>
960 template<
typename TreeT>
969 template<
typename TreeT>
973 return Ptr(
new Grid(background));
978 template<
typename TreeT>
987 template<
typename TreeT>
998 template<
typename TreeT>
1003 switch (treePolicy) {
1009 ret.reset(
new Grid(*
this));
1019 template<
typename TreeT>
1023 return this->copy(treePolicy);
1030 template<
typename TreeT>
1035 if (tree->type() != TreeType::treeType()) {
1037 + tree->type() +
" to a grid of type " + this->type());
1039 mTree = boost::static_pointer_cast<
TreeType>(tree);
1043 template<
typename TreeT>
1047 mTree.reset(
new TreeType(this->background()));
1051 template<
typename TreeT>
1055 tree().fill(bbox, value, active);
1059 template<
typename TreeT>
1063 tree().signedFloodFill(outside, inside);
1067 template<
typename TreeT>
1071 this->prune(
ValueType(zeroVal<ValueType>() + tolerance));
1075 template<
typename TreeT>
1079 tree().evalMinMax(minVal, maxVal);
1083 template<
typename TreeT>
1088 tree().evalActiveVoxelBoundingBox(bbox);
1093 template<
typename TreeT>
1098 const bool nonempty = tree().evalActiveVoxelDim(dim);
1099 return (nonempty ? dim :
Coord());
1109 template<
typename TreeT>
1113 tree().readTopology(is, saveFloatAsHalf());
1117 template<
typename TreeT>
1121 tree().writeTopology(os, saveFloatAsHalf());
1125 template<
typename TreeT>
1129 tree().readBuffers(is, saveFloatAsHalf());
1133 template<
typename TreeT>
1137 tree().writeBuffers(os, saveFloatAsHalf());
1141 template<
typename TreeT>
1145 tree().print(os, verboseLevel);
1147 if (metaCount() > 0) {
1148 os <<
"Additional metadata:" << std::endl;
1150 os <<
" " << it->first;
1152 const std::string value = it->second->str();
1153 if (!value.empty()) os <<
": " << value;
1159 os <<
"Transform:" << std::endl;
1160 transform().print(os,
" ");
1168 template<
typename Gr
idType>
1169 inline typename GridType::Ptr
1172 return GridType::create(background);
1176 template<
typename Gr
idType>
1177 inline typename GridType::Ptr
1180 return GridType::create();
1184 template<
typename TreePtrType>
1188 typedef typename TreePtrType::element_type TreeType;
1193 template<
typename Gr
idType>
1194 typename GridType::Ptr
1197 typedef typename GridType::ValueType ValueType;
1200 BOOST_STATIC_ASSERT(boost::is_floating_point<ValueType>::value);
1202 typename GridType::Ptr grid = GridType::create(
1203 static_cast<ValueType>(voxelSize * halfWidth));
1212 #endif // OPENVDB_GRID_HAS_BEEN_INCLUDED