Exposed TypeLists of the default set of OpenVDB types

Signed-off-by: Nick Avramoussis <[email protected]>

Author: Idclip

openvdb/openvdb/TypeList.h

@@ -351,6 +351,10 @@ template<typename OpT> inline void TSForEachImpl(OpT) {}
 template<typename OpT, typename T, typename... Ts>
 inline void TSForEachImpl(OpT op) { op(T()); TSForEachImpl<OpT, Ts...>(op); }
 
+template<template <typename> class OpT> inline void TSForEachImpl() {}
+template<template <typename> class OpT, typename T, typename... Ts>
+inline void TSForEachImpl() { OpT<T>()(); TSForEachImpl<OpT, Ts...>(); }
+
 } // namespace internal
 
 /// @endcond
@@ -499,6 +503,25 @@ struct TypeList
     template <size_t First, size_t Last>
     using RemoveByIndex = typename typelist_internal::TSRemoveIndicesImpl<Self, First, Last>::type;
 
+    /// @brief Invoke a templated class operator on each type in this list. Use
+    ///   this method if you only need access to the type for static methods.
+    /// @code
+    /// #include <typeinfo>
+    ///
+    /// template <typename T>
+    /// struct PintTypes() {
+    ///     inline void operator()() { std::cout << typeid(T).name() << std::endl; }
+    /// };
+    ///
+    /// using MyTypes = openvdb::TypeList<int, float, double>;
+    /// MyTypes::foreach<PintTypes>(); // "i, f, d" (exact output is compiler-dependent)
+    /// @endcode
+    ///
+    /// @note OpT must be a templated class. It is created and invoked for each
+    ///   type in this list.
+    template<template <typename> class OpT>
+    static void foreach() { typelist_internal::TSForEachImpl<OpT, Ts...>(); }
+
     /// @brief Invoke a templated, unary functor on a value of each type in this list.
     /// @details Example:
     /// @code

openvdb/openvdb/openvdb.cc

@@ -3,9 +3,7 @@
 
 #include "openvdb.h"
 #include "io/DelayedLoadMetadata.h"
-//#ifdef OPENVDB_ENABLE_POINTS
 #include "points/PointDataGrid.h"
-//#endif
 #include "tools/PointIndexGrid.h"
 #include "util/logging.h"
 
@@ -54,6 +52,11 @@ std::mutex sInitMutex;
 std::atomic<bool> sIsInitialized{false};
 }
 
+/// @todo  Change registerX() methods to simply be register()...
+template <typename GridT> struct RegisterGrid { inline void operator()() { GridT::registerGrid(); } };
+template <typename MetaT> struct RegisterMeta { inline void operator()() { MetaT::registerType(); } };
+template <typename MapT>  struct RegisterMap  { inline void operator()() { MapT::registerMap(); } };
+
 void
 initialize()
 {
@@ -65,65 +68,29 @@ initialize()
 
     // Register metadata.
     Metadata::clearRegistry();
-    BoolMetadata::registerType();
-    DoubleMetadata::registerType();
-    FloatMetadata::registerType();
-    Int32Metadata::registerType();
-    Int64Metadata::registerType();
-    StringMetadata::registerType();
-    Vec2IMetadata::registerType();
-    Vec2SMetadata::registerType();
-    Vec2DMetadata::registerType();
-    Vec3IMetadata::registerType();
-    Vec3SMetadata::registerType();
-    Vec3DMetadata::registerType();
-    Vec4IMetadata::registerType();
-    Vec4SMetadata::registerType();
-    Vec4DMetadata::registerType();
-    Mat4SMetadata::registerType();
-    Mat4DMetadata::registerType();
+    NativeMetaTypes::foreach<RegisterMeta>();
 
     // Register maps
     math::MapRegistry::clear();
-    math::AffineMap::registerMap();
-    math::UnitaryMap::registerMap();
-    math::ScaleMap::registerMap();
-    math::UniformScaleMap::registerMap();
-    math::TranslationMap::registerMap();
-    math::ScaleTranslateMap::registerMap();
-    math::UniformScaleTranslateMap::registerMap();
-    math::NonlinearFrustumMap::registerMap();
+    NativeMapTypes::foreach<RegisterMap>();
 
     // Register common grid types.
     GridBase::clearRegistry();
-    BoolGrid::registerGrid();
-    MaskGrid::registerGrid();
-    FloatGrid::registerGrid();
-    DoubleGrid::registerGrid();
-    Int32Grid::registerGrid();
-    Int64Grid::registerGrid();
+    NativeGridTypes::foreach<RegisterGrid>();
+
     // @note String grids types are deprecated but we still register them
     //   as supported serializable types for backward compatibility. This
     //   will likely be removed in a future major version
 OPENVDB_NO_DEPRECATION_WARNING_BEGIN
     StringGrid::registerGrid();
 OPENVDB_NO_DEPRECATION_WARNING_END
-    Vec3IGrid::registerGrid();
-    Vec3SGrid::registerGrid();
-    Vec3DGrid::registerGrid();
 
     // Register types associated with point index grids.
     Metadata::registerType(typeNameAsString<PointIndex32>(), Int32Metadata::createMetadata);
     Metadata::registerType(typeNameAsString<PointIndex64>(), Int64Metadata::createMetadata);
-    tools::PointIndexGrid::registerGrid();
 
     // Register types associated with point data grids.
-//#ifdef OPENVDB_ENABLE_POINTS
     points::internal::initialize();
-//#endif
-
-    // Register delay load metadata
-    io::DelayedLoadMetadata::registerType();
 
 #ifdef OPENVDB_USE_BLOSC
     blosc_init();
@@ -166,10 +133,7 @@ __pragma(warning(default:1711))
     Metadata::clearRegistry();
     GridBase::clearRegistry();
     math::MapRegistry::clear();
-
-//#ifdef OPENVDB_ENABLE_POINTS
     points::internal::uninitialize();
-//#endif
 
 #ifdef OPENVDB_USE_BLOSC
     // We don't want to destroy Blosc, because it might have been

openvdb/openvdb/openvdb.h

@@ -6,18 +6,49 @@
 
 #include "Platform.h"
 #include "Types.h"
+#include "TypeList.h"
 #include "Metadata.h"
 #include "math/Maps.h"
 #include "math/Transform.h"
 #include "Grid.h"
 #include "tree/Tree.h"
+#include "points/PointDataGrid.h"
 #include "io/File.h"
 
 
 namespace openvdb {
 OPENVDB_USE_VERSION_NAMESPACE
 namespace OPENVDB_VERSION_NAME {
 
+/// @brief  Global registration of native Grid, Transform, Metadata and Point
+///   attribute types. Also initializes blosc (if enabled).
+/// @details  Calling this methods registers factory callbacks for the set of
+///   native grid, transform, metadata and point attribute types that OpenVDB
+///   supports by default. For most types, calling openvdb::initialize is only
+///   required for serialization support. However, openvdb::initialize must be
+///   called for PointDataGrid attribute usage as these callbacks are used in
+///   various tools.
+/// @note  This method is thread safe - it can be concurrently called multiple
+///   times, early exiting if it has already been called so long as
+///   openvdb::uninitialize() has not been called.
+OPENVDB_API void initialize();
+
+/// @brief  Global deregistration of native Grid, Transform, Metadata and Point
+///   attribute types.
+/// @details  Clears all registered factory callbacks. This includes everything
+///   registered by openvdb::initialize() but will also include any manually
+///   registered types.
+/// @note  This method is thread safe - it can be concurrently called multiple
+///   times.
+/// @warning  This method does *not* uninitialize blosc. This is to avoid
+///   changing program states should another library also be using blosc. If
+///   blosc is enabled, consider calling blosc_destroy() in your application.
+OPENVDB_API void uninitialize();
+
+
+// foward declare some default types
+namespace io { class DelayedLoadMetadata; }
+
 /// Common tree types
 using BoolTree     = tree::Tree4<bool,        5, 4, 3>::Type;
 using DoubleTree   = tree::Tree4<double,      5, 4, 3>::Type;
@@ -54,11 +85,127 @@ using Vec3dGrid    = Vec3DGrid;
 using Vec3fGrid    = Vec3SGrid;
 using VectorGrid   = Vec3fGrid;
 
-/// Global registration of basic types
-OPENVDB_API void initialize();
+/// @name Lists of native Grid Types
+/// @{
+/// The floating point Grid types which OpenVDB will register by default.
+using NativeFloatGridTypes   = TypeList<FloatGrid, DoubleGrid>;
+/// The integer Grid types which OpenVDB will register by default.
+using NativeIntegerGridTypes = TypeList<Int32Grid, Int64Grid>;
+/// The scalar Grid types which OpenVDB will register by default. This is a
+/// combination of native floating point and integer grid types. Note that
+/// this list does not include Bool or Mask Grids.
+using NativeScalarGridTypes  = NativeFloatGridTypes::Append<NativeIntegerGridTypes>;
+/// The Vec3 Grid types which OpenVDB will register by default.
+using NativeVec3GridTypes    = TypeList<Vec3IGrid, Vec3SGrid, Vec3DGrid>;
 
-/// Global deregistration of basic types
-OPENVDB_API void uninitialize();
+/// The Grid types which OpenVDB will register by default.
+using NativeGridTypes =
+    NativeScalarGridTypes::
+        Append<NativeVec3GridTypes>::
+        Append<tools::PointIndexGrid>::
+    // #define unfortunately required for one of the tests that removes this alias
+#ifndef OPENVDB_DISABLE_POINT_DATA_TREE_ALIAS
+        Append<points::PointDataGrid>::
+#endif
+        Append<BoolGrid, MaskGrid>;
+/// @}
+
+
+/// @name Lists of native TypedAttributeArray Types (for PointDataGrids)
+/// @{
+/// The floating point attribute array types which OpenVDB will register by default.
+using NativeFloatAttributeTypes = TypeList<
+    points::TypedAttributeArray<float>,
+    points::TypedAttributeArray<double>,
+    points::TypedAttributeArray<float, points::TruncateCodec>,
+    points::TypedAttributeArray<float, points::FixedPointCodec<true, points::UnitRange>>,
+    points::TypedAttributeArray<float, points::FixedPointCodec<false, points::UnitRange>>
+    >;
+/// The integer attribute array types which OpenVDB will register by default.
+using NativeIntegerAttributeTypes = TypeList<
+    points::TypedAttributeArray<int8_t>,
+    points::TypedAttributeArray<int16_t>,
+    points::TypedAttributeArray<int32_t>,
+    points::TypedAttributeArray<int64_t>
+    >;
+/// The scalar attribute array types which OpenVDB will register by default.
+/// This is a combination of native floating point and integer array types.
+/// Note that this list does not include bool arrays.
+using NativeScalarAttributeTypes =
+    NativeFloatAttributeTypes::Append<NativeIntegerAttributeTypes>;
+/// The Vec3 attribute array types which OpenVDB will register by default.
+using NativeVec3AttributeTypes = TypeList<
+    points::TypedAttributeArray<math::Vec3<int32_t>>,
+    points::TypedAttributeArray<math::Vec3<float>>,
+    points::TypedAttributeArray<math::Vec3<double>>,
+    points::TypedAttributeArray<math::Vec3<float>, points::TruncateCodec>,
+    points::TypedAttributeArray<math::Vec3<float>, points::FixedPointCodec<true, points::PositionRange>>,
+    points::TypedAttributeArray<math::Vec3<float>, points::FixedPointCodec<false, points::PositionRange>>,
+    points::TypedAttributeArray<math::Vec3<float>, points::FixedPointCodec<true, points::UnitRange>>,
+    points::TypedAttributeArray<math::Vec3<float>, points::FixedPointCodec<false, points::UnitRange>>,
+    points::TypedAttributeArray<math::Vec3<float>, points::UnitVecCodec>
+    >;
+/// The Mat3 attribute array types which OpenVDB will register by default.
+using NativeMat3AttributeTypes = TypeList<
+    points::TypedAttributeArray<math::Mat3<float>>,
+    points::TypedAttributeArray<math::Mat3<double>>
+    >;
+/// The Mat4 attribute array types which OpenVDB will register by default.
+using NativeMat4AttributeTypes = TypeList<
+    points::TypedAttributeArray<math::Mat4<float>>,
+    points::TypedAttributeArray<math::Mat4<double>>
+    >;
+/// The Quat attribute array types which OpenVDB will register by default.
+using NativeQuatAttributeTypes = TypeList<
+    points::TypedAttributeArray<math::Quat<float>>,
+    points::TypedAttributeArray<math::Quat<double>>
+    >;
+
+/// The attribute array types which OpenVDB will register by default.
+using NativeAttributeTypes =
+    NativeScalarAttributeTypes::
+    Append<NativeVec3AttributeTypes>::
+    Append<NativeMat3AttributeTypes>::
+    Append<NativeMat4AttributeTypes>::
+    Append<NativeQuatAttributeTypes>::
+    Append<points::GroupAttributeArray>::
+    Append<points::StringAttributeArray>::
+    Append<points::TypedAttributeArray<bool>>;
+/// @}
+
+
+/// The Map types which OpenVDB will register by default.
+using NativeMapTypes = TypeList<
+    math::AffineMap,
+    math::UnitaryMap,
+    math::ScaleMap,
+    math::UniformScaleMap,
+    math::TranslationMap,
+    math::ScaleTranslateMap,
+    math::UniformScaleTranslateMap,
+    math::NonlinearFrustumMap>;
+
+
+/// The Metadata types which OpenVDB will register by default.
+using NativeMetaTypes = TypeList<
+    BoolMetadata,
+    DoubleMetadata,
+    FloatMetadata,
+    Int32Metadata,
+    Int64Metadata,
+    StringMetadata,
+    Vec2IMetadata,
+    Vec2SMetadata,
+    Vec2DMetadata,
+    Vec3IMetadata,
+    Vec3SMetadata,
+    Vec3DMetadata,
+    Vec4IMetadata,
+    Vec4SMetadata,
+    Vec4DMetadata,
+    Mat4SMetadata,
+    Mat4DMetadata,
+    io::DelayedLoadMetadata>;
 
 
 // Deprecated types

openvdb/openvdb/points/points.cc

@@ -3,61 +3,25 @@
 
 /// @file points/points.cc
 
+#include "openvdb.h"
 #include "PointDataGrid.h"
 
 namespace openvdb {
 OPENVDB_USE_VERSION_NAMESPACE
 namespace OPENVDB_VERSION_NAME {
 namespace points {
 
+template <typename ArrayT> struct RegisterArray { inline void operator()() { ArrayT::registerType(); } };
+
 void
 internal::initialize()
 {
-    // Register attribute arrays with no compression
-    TypedAttributeArray<bool>::registerType();
-    TypedAttributeArray<int8_t>::registerType();
-    TypedAttributeArray<int16_t>::registerType();
-    TypedAttributeArray<int32_t>::registerType();
-    TypedAttributeArray<int64_t>::registerType();
-    TypedAttributeArray<float>::registerType();
-    TypedAttributeArray<double>::registerType();
-    TypedAttributeArray<math::Vec3<int32_t>>::registerType();
-    TypedAttributeArray<math::Vec3<float>>::registerType();
-    TypedAttributeArray<math::Vec3<double>>::registerType();
-
-    // Register attribute arrays with group and string attribute
-    GroupAttributeArray::registerType();
-    StringAttributeArray::registerType();
-
-    // Register attribute arrays with matrix and quaternion attributes
-    TypedAttributeArray<math::Mat3<float>>::registerType();
-    TypedAttributeArray<math::Mat3<double>>::registerType();
-    TypedAttributeArray<math::Mat4<float>>::registerType();
-    TypedAttributeArray<math::Mat4<double>>::registerType();
-    TypedAttributeArray<math::Quat<float>>::registerType();
-    TypedAttributeArray<math::Quat<double>>::registerType();
-
-    // Register attribute arrays with truncate compression
-    TypedAttributeArray<float, TruncateCodec>::registerType();
-    TypedAttributeArray<math::Vec3<float>, TruncateCodec>::registerType();
-
-    // Register attribute arrays with fixed point compression
-    TypedAttributeArray<float, FixedPointCodec<true, UnitRange>>::registerType();
-    TypedAttributeArray<float, FixedPointCodec<false, UnitRange>>::registerType();
-    TypedAttributeArray<math::Vec3<float>, FixedPointCodec<true>>::registerType();
-    TypedAttributeArray<math::Vec3<float>, FixedPointCodec<false>>::registerType();
-    TypedAttributeArray<math::Vec3<float>, FixedPointCodec<true, PositionRange>>::registerType();
-    TypedAttributeArray<math::Vec3<float>, FixedPointCodec<false, PositionRange>>::registerType();
-    TypedAttributeArray<math::Vec3<float>, FixedPointCodec<true, UnitRange>>::registerType();
-    TypedAttributeArray<math::Vec3<float>, FixedPointCodec<false, UnitRange>>::registerType();
-
-    // Register attribute arrays with unit vector compression
-    TypedAttributeArray<math::Vec3<float>, UnitVecCodec>::registerType();
+    NativeAttributeTypes::foreach<RegisterArray>();
 
     // Register types associated with point data grids.
     Metadata::registerType(typeNameAsString<PointDataIndex32>(), Int32Metadata::createMetadata);
     Metadata::registerType(typeNameAsString<PointDataIndex64>(), Int64Metadata::createMetadata);
-    PointDataGrid::registerGrid();
+    if (!PointDataGrid::isRegistered()) PointDataGrid::registerGrid();
 }