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();
355 virtual void readTopology(std::istream&) = 0;
358 virtual void writeTopology(std::ostream&)
const = 0;
361 virtual void readBuffers(std::istream&) = 0;
363 virtual void writeBuffers(std::ostream&)
const = 0;
371 virtual void print(std::ostream& = std::cout,
int verboseLevel = 1)
const = 0;
376 GridBase(): mTransform(math::Transform::createLinearTransform()) {}
385 static void registerGrid(
const Name& type, GridFactory);
387 static void unregisterGrid(
const Name& type);
428 template<
typename Gr
idPtrContainerT>
429 inline typename GridPtrContainerT::value_type
432 typedef typename GridPtrContainerT::value_type GridPtrT;
433 typename GridPtrContainerT::const_iterator it =
434 std::find_if(container.begin(), container.end(),
GridNamePred(name));
435 return (it == container.end() ? GridPtrT() : *it);
439 template<
typename KeyT,
typename Gr
idPtrT>
443 typedef std::map<KeyT, GridPtrT> GridPtrMapT;
444 for (
typename GridPtrMapT::const_iterator it = container.begin(), end = container.end();
447 const GridPtrT& grid = it->second;
448 if (grid && grid->getName() == name)
return grid;
459 template<
typename _TreeType>
463 typedef boost::shared_ptr<Grid>
Ptr;
487 template<
typename OtherValueType>
539 virtual Name type()
const {
return this->gridType(); }
556 virtual bool empty()
const {
return tree().empty(); }
558 virtual void clear() { tree().clear(); }
588 void evalMinMax(ValueType& minVal, ValueType& maxVal)
const;
598 void fill(
const CoordBBox& bbox,
const ValueType& value,
bool active =
true);
610 void prune(
const ValueType& tolerance = zeroVal<ValueType>()) { tree().prune(tolerance); }
612 virtual void pruneGrid(
float tolerance = 0.0);
626 template<
typename OtherTreeType>
637 virtual CoordBBox evalActiveVoxelBoundingBox()
const;
639 virtual Coord evalActiveVoxelDim()
const;
676 virtual void newTree();
684 virtual void readTopology(std::istream&);
687 virtual void writeTopology(std::ostream&)
const;
690 virtual void readBuffers(std::istream&);
692 virtual void writeBuffers(std::ostream&)
const;
695 virtual void print(std::ostream& = std::cout,
int verboseLevel = 1)
const;
730 template<
typename Gr
idType>
731 inline typename GridType::Ptr
734 return GridBase::grid<GridType>(grid);
746 template<
typename Gr
idType>
747 inline typename GridType::ConstPtr
750 return GridBase::constGrid<GridType>(grid);
763 template<
typename Gr
idType>
764 inline typename GridType::Ptr
767 if (!grid || !grid->isType<GridType>())
return typename GridType::Ptr();
768 return gridPtrCast<GridType>(grid->deepCopyGrid());
772 template<
typename Gr
idType>
773 inline typename GridType::Ptr
776 if (!grid.
isType<GridType>())
return typename GridType::Ptr();
788 template<
typename _TreeType>
815 template<
typename _TreeType>
845 template<
typename Gr
idType>
846 inline typename GridType::Ptr
851 if (grid && grid->type() == GridType::gridType()) {
852 return boost::static_pointer_cast<GridType>(grid);
854 return typename GridType::Ptr();
858 template<
typename Gr
idType>
859 inline typename GridType::ConstPtr
862 return boost::const_pointer_cast<
const GridType>(
863 GridBase::grid<GridType>(boost::const_pointer_cast<
GridBase>(grid)));
867 template<
typename Gr
idType>
868 inline typename GridType::ConstPtr
871 return boost::const_pointer_cast<
const GridType>(GridBase::grid<GridType>(grid));
875 template<
typename Gr
idType>
876 inline typename GridType::ConstPtr
879 return boost::const_pointer_cast<
const GridType>(
880 GridBase::grid<GridType>(boost::const_pointer_cast<
GridBase>(grid)));
887 return boost::const_pointer_cast<
TreeBase>(this->constBaseTreePtr());
902 template<
typename TreeT>
908 template<
typename TreeT>
914 template<
typename TreeT>
921 template<
typename TreeT>
924 mTree(boost::static_pointer_cast<
TreeType>(other.mTree->copy()))
929 template<
typename TreeT>
937 template<
typename TreeT>
946 template<
typename TreeT>
955 template<
typename TreeT>
959 return Ptr(
new Grid(background));
964 template<
typename TreeT>
973 template<
typename TreeT>
984 template<
typename TreeT>
989 switch (treePolicy) {
995 ret.reset(
new Grid(*
this));
1005 template<
typename TreeT>
1009 return this->copy(treePolicy);
1016 template<
typename TreeT>
1021 if (tree->type() != TreeType::treeType()) {
1023 + tree->type() +
" to a grid of type " + this->type());
1025 mTree = boost::static_pointer_cast<
TreeType>(tree);
1029 template<
typename TreeT>
1033 mTree.reset(
new TreeType(this->background()));
1037 template<
typename TreeT>
1041 tree().fill(bbox, value, active);
1045 template<
typename TreeT>
1049 this->prune(
ValueType(zeroVal<ValueType>() + tolerance));
1053 template<
typename TreeT>
1057 tree().evalMinMax(minVal, maxVal);
1061 template<
typename TreeT>
1066 tree().evalActiveVoxelBoundingBox(bbox);
1071 template<
typename TreeT>
1076 const bool nonempty = tree().evalActiveVoxelDim(dim);
1077 return (nonempty ? dim :
Coord());
1087 template<
typename TreeT>
1091 tree().readTopology(is, saveFloatAsHalf());
1095 template<
typename TreeT>
1099 tree().writeTopology(os, saveFloatAsHalf());
1103 template<
typename TreeT>
1107 tree().readBuffers(is, saveFloatAsHalf());
1111 template<
typename TreeT>
1115 tree().writeBuffers(os, saveFloatAsHalf());
1119 template<
typename TreeT>
1123 tree().print(os, verboseLevel);
1125 if (metaCount() > 0) {
1126 os <<
"Additional metadata:" << std::endl;
1128 os <<
" " << it->first;
1130 const std::string value = it->second->str();
1131 if (!value.empty()) os <<
": " << value;
1137 os <<
"Transform:" << std::endl;
1138 transform().print(os,
" ");
1146 template<
typename Gr
idType>
1147 inline typename GridType::Ptr
1150 return GridType::create(background);
1154 template<
typename Gr
idType>
1155 inline typename GridType::Ptr
1158 return GridType::create();
1162 template<
typename TreePtrType>
1166 typedef typename TreePtrType::element_type TreeType;
1171 template<
typename Gr
idType>
1172 typename GridType::Ptr
1175 typedef typename GridType::ValueType ValueType;
1178 BOOST_STATIC_ASSERT(boost::is_floating_point<ValueType>::value);
1180 typename GridType::Ptr grid = GridType::create(
1181 static_cast<ValueType>(voxelSize * halfWidth));
1190 #endif // OPENVDB_GRID_HAS_BEEN_INCLUDED