HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
openvdb::OPENVDB_VERSION_NAME Namespace Reference

Namespaces

 compression
 
 internal
 
 io
 
 logging
 
 math
 
 points
 
 string
 
 thread
 
 tools
 
 tree
 
 types_internal
 
 util
 

Classes

class  Exception
 
class  Grid
 Container class that associates a tree with a transform and metadata. More...
 
class  GridBase
 Abstract base class for typed grids. More...
 
struct  GridNamePred
 Predicate functor that returns true for grids that have a specified name. More...
 
struct  TreeAdapter
 This adapter allows code that is templated on a Tree type to accept either a Tree type or a Grid type. More...
 
struct  TreeAdapter< Grid< _TreeType > >
 Partial specialization for Grid types. More...
 
struct  TreeAdapter< tree::ValueAccessor< _TreeType > >
 Partial specialization for ValueAccessor types. More...
 
struct  HasMultiPassIO
 Metafunction that specifies whether a given leaf node, tree, or grid type requires multiple passes to read and write voxel data. More...
 
struct  HasMultiPassIO< tree::Tree< RootNodeType > >
 
struct  HasMultiPassIO< Grid< TreeType > >
 
class  Metadata
 Base class for storing metadata information in a grid. More...
 
class  UnknownMetadata
 Subclass to hold raw data of an unregistered type. More...
 
class  TypedMetadata
 Templated metadata class to hold specific types. More...
 
class  MetaMap
 Container that maps names (strings) to values of arbitrary types. More...
 
struct  TypeList
 A list of types (not necessarily unique) More...
 
struct  TupleList
 A trivial wrapper around a std::tuple but with compatible TypeList methods. Importantly can be instatiated from a TypeList and implements a similar ::foreach interface. More...
 
struct  TupleList<>
 Specilization of an empty TupleList. Required due to constructor selection. More...
 
class  ValueMask
 
struct  PointIndex
 Integer wrapper, required to distinguish PointIndexGrid and PointDataGrid from Int32Grid and Int64Grid. More...
 
struct  IsSpecializationOf
 Helper metafunction used to determine if the first template parameter is a specialization of the class template given in the second template parameter. More...
 
struct  IsSpecializationOf< Template< Args...>, Template >
 
struct  index_sequence
 Re-implementation of C++17's index_sequence and the helper alias make_index_sequence. This was introduced to fix an issue with clang's builtin implementation which treats template specializations of builtin templates differently when a subsequent parameter is dependent. The result is a resolution failure during partial specialization selection. For example, the following will fail to specialize: More...
 
struct  VecTraits
 
struct  VecTraits< T, false >
 
struct  QuatTraits
 
struct  QuatTraits< T, false >
 
struct  MatTraits
 
struct  MatTraits< T, false >
 
struct  ValueTraits
 
struct  ValueTraits< T, false >
 
struct  ConvertElementType
 Conversion classes for changing the underlying type of VDB types. More...
 
struct  ConvertElementType< math::Vec2< T >, SubT >
 
struct  ConvertElementType< math::Vec3< T >, SubT >
 
struct  ConvertElementType< math::Vec4< T >, SubT >
 
struct  ConvertElementType< math::Quat< T >, SubT >
 
struct  ConvertElementType< math::Mat3< T >, SubT >
 
struct  ConvertElementType< math::Mat4< T >, SubT >
 
struct  PromoteType
 Promotion classes which provide an interface for elevating and demoting a scalar or VDB type to a higher or lower precision. Integer types preserve their sign. Types promotion are only valid between 8 to 64 bits (long doubles are not supported). More...
 
struct  PromoteContainerType
 
struct  PromoteType< math::Vec2< T > >
 
struct  PromoteType< math::Vec3< T > >
 
struct  PromoteType< math::Vec4< T > >
 
struct  PromoteType< math::Quat< T > >
 
struct  PromoteType< math::Mat3< T > >
 
struct  PromoteType< math::Mat4< T > >
 
struct  CanConvertType
 CanConvertType<FromType, ToType>::value is true if a value of type ToType can be constructed from a value of type FromType. More...
 
struct  CanConvertType< T, math::Vec2< T > >
 
struct  CanConvertType< T, math::Vec3< T > >
 
struct  CanConvertType< T, math::Vec4< T > >
 
struct  CanConvertType< math::Vec2< T >, math::Vec2< T > >
 
struct  CanConvertType< math::Vec3< T >, math::Vec3< T > >
 
struct  CanConvertType< math::Vec4< T >, math::Vec4< T > >
 
struct  CanConvertType< T0, math::Vec2< T1 > >
 
struct  CanConvertType< T0, math::Vec3< T1 > >
 
struct  CanConvertType< T0, math::Vec4< T1 > >
 
struct  CanConvertType< PointIndex32, PointDataIndex32 >
 
struct  CanConvertType< PointDataIndex32, PointIndex32 >
 
struct  CanConvertType< T, ValueMask >
 
struct  CanConvertType< ValueMask, T >
 
struct  CopyConstness
 CopyConstness<T1, T2>::Type is either const T2 or T2 with no const qualifier, depending on whether T1 is const. More...
 
class  CombineArgs
 This struct collects both input and output arguments to "grid combiner" functors used with the tree::TypedGrid::combineExtended() and combine2Extended() methods. AValueType and BValueType are the value types of the two grids being combined. More...
 
struct  SwappedCombineOp
 
class  ShallowCopy
 Tag dispatch class that distinguishes shallow copy constructors from deep copy constructors. More...
 
class  TopologyCopy
 Tag dispatch class that distinguishes topology copy constructors from deep copy constructors. More...
 
class  DeepCopy
 Tag dispatch class that distinguishes constructors that deep copy. More...
 
class  Steal
 Tag dispatch class that distinguishes constructors that steal. More...
 
class  PartialCreate
 Tag dispatch class that distinguishes constructors during file input. More...
 
struct  VersionId
 

Typedefs

using TreeBase = tree::TreeBase
 
using GridPtrVec = std::vector< GridBase::Ptr >
 
using GridPtrVecIter = GridPtrVec::iterator
 
using GridPtrVecCIter = GridPtrVec::const_iterator
 
using GridPtrVecPtr = SharedPtr< GridPtrVec >
 
using GridCPtrVec = std::vector< GridBase::ConstPtr >
 
using GridCPtrVecIter = GridCPtrVec::iterator
 
using GridCPtrVecCIter = GridCPtrVec::const_iterator
 
using GridCPtrVecPtr = SharedPtr< GridCPtrVec >
 
using GridPtrSet = std::set< GridBase::Ptr >
 
using GridPtrSetIter = GridPtrSet::iterator
 
using GridPtrSetCIter = GridPtrSet::const_iterator
 
using GridPtrSetPtr = SharedPtr< GridPtrSet >
 
using GridCPtrSet = std::set< GridBase::ConstPtr >
 
using GridCPtrSetIter = GridCPtrSet::iterator
 
using GridCPtrSetCIter = GridCPtrSet::const_iterator
 
using GridCPtrSetPtr = SharedPtr< GridCPtrSet >
 
using BoolMetadata = TypedMetadata< bool >
 
using DoubleMetadata = TypedMetadata< double >
 
using FloatMetadata = TypedMetadata< float >
 
using Int32Metadata = TypedMetadata< int32_t >
 
using Int64Metadata = TypedMetadata< int64_t >
 
using StringMetadata = TypedMetadata< std::string >
 
using Vec2DMetadata = TypedMetadata< Vec2d >
 
using Vec2IMetadata = TypedMetadata< Vec2i >
 
using Vec2SMetadata = TypedMetadata< Vec2s >
 
using Vec3DMetadata = TypedMetadata< Vec3d >
 
using Vec3IMetadata = TypedMetadata< Vec3i >
 
using Vec3SMetadata = TypedMetadata< Vec3s >
 
using Vec4DMetadata = TypedMetadata< Vec4d >
 
using Vec4IMetadata = TypedMetadata< Vec4i >
 
using Vec4SMetadata = TypedMetadata< Vec4s >
 
using Mat4SMetadata = TypedMetadata< Mat4s >
 
using Mat4DMetadata = TypedMetadata< Mat4d >
 
using BoolTree = tree::Tree4< bool, 5, 4, 3 >::Type
 Common tree types. More...
 
using DoubleTree = tree::Tree4< double, 5, 4, 3 >::Type
 
using FloatTree = tree::Tree4< float, 5, 4, 3 >::Type
 
using Int32Tree = tree::Tree4< int32_t, 5, 4, 3 >::Type
 
using Int64Tree = tree::Tree4< int64_t, 5, 4, 3 >::Type
 
using MaskTree = tree::Tree4< ValueMask, 5, 4, 3 >::Type
 
using UInt32Tree = tree::Tree4< uint32_t, 5, 4, 3 >::Type
 
using Vec2DTree = tree::Tree4< Vec2d, 5, 4, 3 >::Type
 
using Vec2ITree = tree::Tree4< Vec2i, 5, 4, 3 >::Type
 
using Vec2STree = tree::Tree4< Vec2s, 5, 4, 3 >::Type
 
using Vec3DTree = tree::Tree4< Vec3d, 5, 4, 3 >::Type
 
using Vec3ITree = tree::Tree4< Vec3i, 5, 4, 3 >::Type
 
using Vec3STree = tree::Tree4< Vec3f, 5, 4, 3 >::Type
 
using ScalarTree = FloatTree
 
using TopologyTree = MaskTree
 
using Vec3dTree = Vec3DTree
 
using Vec3fTree = Vec3STree
 
using VectorTree = Vec3fTree
 
using BoolGrid = Grid< BoolTree >
 Common grid types. More...
 
using DoubleGrid = Grid< DoubleTree >
 
using FloatGrid = Grid< FloatTree >
 
using Int32Grid = Grid< Int32Tree >
 
using Int64Grid = Grid< Int64Tree >
 
using MaskGrid = Grid< MaskTree >
 
using Vec3DGrid = Grid< Vec3DTree >
 
using Vec3IGrid = Grid< Vec3ITree >
 
using Vec3SGrid = Grid< Vec3STree >
 
using ScalarGrid = FloatGrid
 
using TopologyGrid = MaskGrid
 
using Vec3dGrid = Vec3DGrid
 
using Vec3fGrid = Vec3SGrid
 
using VectorGrid = Vec3fGrid
 
using MapTypes = TypeList< math::AffineMap, math::UnitaryMap, math::ScaleMap, math::UniformScaleMap, math::TranslationMap, math::ScaleTranslateMap, math::UniformScaleTranslateMap, math::NonlinearFrustumMap >
 The Map types which OpenVDB will register by default. More...
 
using MetaTypes = TypeList< BoolMetadata, DoubleMetadata, FloatMetadata, Int32Metadata, Int64Metadata, StringMetadata, Vec2IMetadata, Vec2SMetadata, Vec2DMetadata, Vec3IMetadata, Vec3SMetadata, Vec3DMetadata, Vec4IMetadata, Vec4SMetadata, Vec4DMetadata, Mat4SMetadata, Mat4DMetadata, io::DelayedLoadMetadata >
 The Metadata types which OpenVDB will register by default. More...
 
using NamePair = std::pair< Name, Name >
 
using Index32 = uint32_t
 
using Index64 = uint64_t
 
using Index = Index32
 
using Int16 = int16_t
 
using Int32 = int32_t
 
using Int64 = int64_t
 
using Int = Int32
 
using Byte = unsigned char
 
using Real = double
 
using Vec2R = math::Vec2< Real >
 
using Vec2I = math::Vec2< Index32 >
 
using Vec2f = math::Vec2< float >
 
using Vec2H = math::Vec2< math::half >
 
using Vec3R = math::Vec3< Real >
 
using Vec3I = math::Vec3< Index32 >
 
using Vec3f = math::Vec3< float >
 
using Vec3H = math::Vec3< math::half >
 
using Vec3U8 = math::Vec3< uint8_t >
 
using Vec3U16 = math::Vec3< uint16_t >
 
using BBoxd = math::BBox< Vec3d >
 
using Vec4R = math::Vec4< Real >
 
using Vec4I = math::Vec4< Index32 >
 
using Vec4f = math::Vec4< float >
 
using Vec4H = math::Vec4< math::half >
 
using Mat3R = math::Mat3< Real >
 
using Mat4R = math::Mat4< Real >
 
using QuatR = math::Quat< Real >
 
template<typename T >
using SharedPtr = std::shared_ptr< T >
 
template<typename T >
using WeakPtr = std::weak_ptr< T >
 
using PointIndex32 = PointIndex< Index32, 0 >
 
using PointIndex64 = PointIndex< Index64, 0 >
 
using PointDataIndex32 = PointIndex< Index32, 1 >
 
using PointDataIndex64 = PointIndex< Index64, 1 >
 
template<std::size_t N>
using make_index_sequence = std::decay_t< decltype(make_index_sequence_impl< N >())>
 
typedef std::string Name
 
Lists of native Grid Types

The floating point Grid types which OpenVDB will register by default.

using RealGridTypes = TypeList< FloatGrid, DoubleGrid >
 The integer Grid types which OpenVDB will register by default. More...
 
using IntegerGridTypes = TypeList< Int32Grid, Int64Grid >
 The integer Grid types which OpenVDB will register by default. More...
 
using NumericGridTypes = RealGridTypes::Append< IntegerGridTypes >
 
using Vec3GridTypes = TypeList< Vec3IGrid, Vec3SGrid, Vec3DGrid >
 The Vec3 Grid types which OpenVDB will register by default. More...
 
using GridTypes = NumericGridTypes::Append< Vec3GridTypes >::Append< tools::PointIndexGrid >::Append< points::PointDataGrid >::Append< BoolGrid, MaskGrid >
 The Grid types which OpenVDB will register by default. More...
 
Lists of native Tree Types
using RealTreeTypes = RealGridTypes::Transform< internal::ToTreeType >
 
using IntegerTreeTypes = IntegerGridTypes::Transform< internal::ToTreeType >
 
using NumericTreeTypes = NumericGridTypes::Transform< internal::ToTreeType >
 
using Vec3TreeTypes = Vec3GridTypes::Transform< internal::ToTreeType >
 
using TreeTypes = GridTypes::Transform< internal::ToTreeType >
 
Lists of native TypedAttributeArray Types (for PointDataGrids)

The floating point attribute array types which OpenVDB will register by default.

using RealAttributeTypes = 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. More...
 
using IntegerAttributeTypes = TypeList< points::TypedAttributeArray< int8_t >, points::TypedAttributeArray< int16_t >, points::TypedAttributeArray< int32_t >, points::TypedAttributeArray< int64_t > >
 The integer attribute array types which OpenVDB will register by default. More...
 
using NumericAttributeTypes = RealAttributeTypes::Append< IntegerAttributeTypes >
 
using Vec3AttributeTypes = 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 Vec3 attribute array types which OpenVDB will register by default. More...
 
using Mat3AttributeTypes = TypeList< points::TypedAttributeArray< math::Mat3< float >>, points::TypedAttributeArray< math::Mat3< double >> >
 The Mat3 attribute array types which OpenVDB will register by default. More...
 
using Mat4AttributeTypes = TypeList< points::TypedAttributeArray< math::Mat4< float >>, points::TypedAttributeArray< math::Mat4< double >> >
 The Mat4 attribute array types which OpenVDB will register by default. More...
 
using QuatAttributeTypes = TypeList< points::TypedAttributeArray< math::Quat< float >>, points::TypedAttributeArray< math::Quat< double >> >
 The Quat attribute array types which OpenVDB will register by default. More...
 
using AttributeTypes = NumericAttributeTypes::Append< Vec3AttributeTypes >::Append< Mat3AttributeTypes >::Append< Mat4AttributeTypes >::Append< QuatAttributeTypes >::Append< points::GroupAttributeArray >::Append< points::StringAttributeArray >::Append< points::TypedAttributeArray< bool >>
 The attribute array types which OpenVDB will register by default. More...
 

Enumerations

enum  GridClass { GRID_UNKNOWN = 0, GRID_LEVEL_SET, GRID_FOG_VOLUME, GRID_STAGGERED }
 
enum  { NUM_GRID_CLASSES = GRID_STAGGERED + 1 }
 
enum  VecType {
  VEC_INVARIANT = 0, VEC_COVARIANT, VEC_COVARIANT_NORMALIZE, VEC_CONTRAVARIANT_RELATIVE,
  VEC_CONTRAVARIANT_ABSOLUTE
}
 
enum  { NUM_VEC_TYPES = VEC_CONTRAVARIANT_ABSOLUTE + 1 }
 
enum  MergePolicy { MERGE_ACTIVE_STATES = 0, MERGE_NODES, MERGE_ACTIVE_STATES_AND_NODES }
 
enum  {
  OPENVDB_FILE_VERSION_ROOTNODE_MAP = 213, OPENVDB_FILE_VERSION_INTERNALNODE_COMPRESSION = 214, OPENVDB_FILE_VERSION_SIMPLIFIED_GRID_TYPENAME = 215, OPENVDB_FILE_VERSION_GRID_INSTANCING = 216,
  OPENVDB_FILE_VERSION_BOOL_LEAF_OPTIMIZATION = 217, OPENVDB_FILE_VERSION_BO__OST_UUID = 218, OPENVDB_FILE_VERSION_NO_GRIDMAP = 219, OPENVDB_FILE_VERSION_NEW_TRANSFORM = 219,
  OPENVDB_FILE_VERSION_SELECTIVE_COMPRESSION = 220, OPENVDB_FILE_VERSION_FLOAT_FRUSTUM_BBOX = 221, OPENVDB_FILE_VERSION_NODE_MASK_COMPRESSION = 222, OPENVDB_FILE_VERSION_BLOSC_COMPRESSION = 223,
  OPENVDB_FILE_VERSION_POINT_INDEX_GRID = 223, OPENVDB_FILE_VERSION_MULTIPASS_IO = 224
}
 Notable file format version numbers. More...
 

Functions

 OPENVDB_EXCEPTION (ArithmeticError)
 
 OPENVDB_EXCEPTION (IndexError)
 
 OPENVDB_EXCEPTION (IoError)
 
 OPENVDB_EXCEPTION (KeyError)
 
 OPENVDB_EXCEPTION (LookupError)
 
 OPENVDB_EXCEPTION (NotImplementedError)
 
 OPENVDB_EXCEPTION (ReferenceError)
 
 OPENVDB_EXCEPTION (RuntimeError)
 
 OPENVDB_EXCEPTION (TypeError)
 
 OPENVDB_EXCEPTION (ValueError)
 
template<typename GridType >
GridType::Ptr createGrid (const typename GridType::ValueType &background)
 Create a new grid of type GridType with a given background value. More...
 
template<typename GridType >
GridType::Ptr createGrid ()
 Create a new grid of type GridType with background value zero. More...
 
template<typename TreePtrType >
Grid< typename
TreePtrType::element_type >
::Ptr 
createGrid (TreePtrType)
 Create a new grid of the appropriate type that wraps the given tree. More...
 
template<typename GridType >
GridType::Ptr createLevelSet (Real voxelSize=1.0, Real halfWidth=LEVEL_SET_HALF_WIDTH)
 Create a new grid of type GridType classified as a "Level Set", i.e., a narrow-band level set. More...
 
template<typename GridPtrContainerT >
GridPtrContainerT::value_type findGridByName (const GridPtrContainerT &container, const Name &name)
 Return the first grid in the given container whose name is name. More...
 
template<typename KeyT , typename GridPtrT >
GridPtrT findGridByName (const std::map< KeyT, GridPtrT > &container, const Name &name)
 Return the first grid in the given map whose name is name. More...
 
template<typename GridType >
GridType::Ptr gridPtrCast (const GridBase::Ptr &grid)
 Cast a generic grid pointer to a pointer to a grid of a concrete class. More...
 
template<typename GridType >
GridType::ConstPtr gridConstPtrCast (const GridBase::ConstPtr &grid)
 Cast a generic const grid pointer to a const pointer to a grid of a concrete class. More...
 
template<>
math::Mat3s zeroVal< math::Mat3s > ()
 
template<>
math::Mat3d zeroVal< math::Mat3d > ()
 
template<>
math::Mat4s zeroVal< math::Mat4s > ()
 
template<>
math::Mat4d zeroVal< math::Mat4d > ()
 
template<typename T >
constexpr T zeroVal ()
 Return the value of type T that corresponds to zero. More...
 
template<>
std::string zeroVal< std::string > ()
 Return the std::string value that corresponds to zero. More...
 
template<>
constexpr bool zeroVal< bool > ()
 Return the bool value that corresponds to zero. More...
 
template<>
math::Quats zeroVal< math::Quats > ()
 
template<>
math::Quatd zeroVal< math::Quatd > ()
 
std::ostream & operator<< (std::ostream &ostr, const Metadata &metadata)
 Write a Metadata to an output stream. More...
 
std::ostream & operator<< (std::ostream &, const MetaMap &)
 Write a MetaMap to an output stream. More...
 
OPENVDB_API void initialize ()
 Global registration of native Grid, Transform, Metadata and Point attribute types. Also initializes blosc (if enabled). More...
 
OPENVDB_API void uninitialize ()
 Global deregistration of native Grid, Transform, Metadata and Point attribute types. More...
 
template<size_t Start, size_t End, typename OpT >
OPENVDB_TYPELIST_FORCE_INLINE auto foreachIndex (OpT op)
 
template<size_t Start, size_t End, typename OpT , typename RetT >
OPENVDB_TYPELIST_FORCE_INLINE RetT evalFirstIndex (OpT op, const RetT def=RetT())
 
template<typename T , typename U >
SharedPtr< T > ConstPtrCast (const SharedPtr< U > &ptr)
 Return a new shared pointer that points to the same object as the given pointer but with possibly different const-ness. More...
 
template<typename T , typename U >
SharedPtr< T > DynamicPtrCast (const SharedPtr< U > &ptr)
 Return a new shared pointer that is either null or points to the same object as the given pointer after a dynamic_cast. More...
 
template<typename T , typename U >
SharedPtr< T > StaticPtrCast (const SharedPtr< U > &ptr)
 Return a new shared pointer that points to the same object as the given pointer after a static_cast. More...
 
template<std::size_t N, std::size_t... Is>
auto make_index_sequence_impl ()
 
template<typename T >
const char * typeNameAsString ()
 
template<>
const char * typeNameAsString< bool > ()
 
template<>
const char * typeNameAsString< ValueMask > ()
 
template<>
const char * typeNameAsString< math::half > ()
 
template<>
const char * typeNameAsString< float > ()
 
template<>
const char * typeNameAsString< double > ()
 
template<>
const char * typeNameAsString< int8_t > ()
 
template<>
const char * typeNameAsString< uint8_t > ()
 
template<>
const char * typeNameAsString< int16_t > ()
 
template<>
const char * typeNameAsString< uint16_t > ()
 
template<>
const char * typeNameAsString< int32_t > ()
 
template<>
const char * typeNameAsString< uint32_t > ()
 
template<>
const char * typeNameAsString< int64_t > ()
 
template<>
const char * typeNameAsString< Vec2i > ()
 
template<>
const char * typeNameAsString< Vec2s > ()
 
template<>
const char * typeNameAsString< Vec2d > ()
 
template<>
const char * typeNameAsString< Vec3U8 > ()
 
template<>
const char * typeNameAsString< Vec3U16 > ()
 
template<>
const char * typeNameAsString< Vec3i > ()
 
template<>
const char * typeNameAsString< Vec3f > ()
 
template<>
const char * typeNameAsString< Vec3d > ()
 
template<>
const char * typeNameAsString< Vec4i > ()
 
template<>
const char * typeNameAsString< Vec4f > ()
 
template<>
const char * typeNameAsString< Vec4d > ()
 
template<>
const char * typeNameAsString< std::string > ()
 
template<>
const char * typeNameAsString< Mat3s > ()
 
template<>
const char * typeNameAsString< Mat3d > ()
 
template<>
const char * typeNameAsString< Mat4s > ()
 
template<>
const char * typeNameAsString< Mat4d > ()
 
template<>
const char * typeNameAsString< math::Quats > ()
 
template<>
const char * typeNameAsString< math::Quatd > ()
 
template<>
const char * typeNameAsString< PointIndex32 > ()
 
template<>
const char * typeNameAsString< PointIndex64 > ()
 
template<>
const char * typeNameAsString< PointDataIndex32 > ()
 
template<>
const char * typeNameAsString< PointDataIndex64 > ()
 
Name readString (std::istream &is)
 
void writeString (std::ostream &os, const Name &name)
 
constexpr const char * getLibraryVersionString ()
 Return a library version number string of the form "<major>.<minor>.<patch>". More...
 
constexpr const char * getLibraryAbiVersionString ()
 Return a library version number string of the form "<major>.<minor>.<patch>abi<abi>". More...
 
constexpr const char * getPackageUrl ()
 
constexpr const char * getPackageRevision ()
 
template<typename GridType >
GridType::Ptr deepCopyTypedGrid (const GridBase::ConstPtr &grid)
 Return a pointer to a deep copy of the given grid, provided that the grid's concrete type is GridType. More...
 
template<typename GridType >
GridType::Ptr deepCopyTypedGrid (const GridBase &grid)
 Return a pointer to a deep copy of the given grid, provided that the grid's concrete type is GridType. More...
 

Variables

const int32_t OPENVDB_MAGIC = 0x56444220
 The magic number is stored in the first four bytes of every VDB file. More...
 
const uint32_t OPENVDB_LIBRARY_MAJOR_VERSION
 
const uint32_t OPENVDB_LIBRARY_MINOR_VERSION
 
const uint32_t OPENVDB_LIBRARY_PATCH_VERSION
 
const uint32_t OPENVDB_LIBRARY_VERSION
 
const uint32_t OPENVDB_ABI_VERSION
 
const uint32_t OPENVDB_FILE_VERSION = 224
 The current version number of the VDB file format. More...
 

Typedef Documentation

using openvdb::OPENVDB_VERSION_NAME::AttributeTypes = typedef NumericAttributeTypes:: Append<Vec3AttributeTypes>:: Append<Mat3AttributeTypes>:: Append<Mat4AttributeTypes>:: Append<QuatAttributeTypes>:: Append<points::GroupAttributeArray>:: Append<points::StringAttributeArray>:: Append<points::TypedAttributeArray<bool>>

The attribute array types which OpenVDB will register by default.

Definition at line 186 of file openvdb.h.

Definition at line 84 of file Types.h.

Common grid types.

Definition at line 73 of file openvdb.h.

Definition at line 358 of file Metadata.h.

using openvdb::OPENVDB_VERSION_NAME::BoolTree = typedef tree::Tree4<bool, 5, 4, 3>::Type

Common tree types.

Definition at line 53 of file openvdb.h.

using openvdb::OPENVDB_VERSION_NAME::Byte = typedef unsigned char

Definition at line 59 of file Types.h.

Definition at line 74 of file openvdb.h.

Definition at line 359 of file Metadata.h.

using openvdb::OPENVDB_VERSION_NAME::DoubleTree = typedef tree::Tree4<double, 5, 4, 3>::Type

Definition at line 54 of file openvdb.h.

Definition at line 75 of file openvdb.h.

Definition at line 360 of file Metadata.h.

Definition at line 55 of file openvdb.h.

Definition at line 523 of file Grid.h.

using openvdb::OPENVDB_VERSION_NAME::GridCPtrSetCIter = typedef GridCPtrSet::const_iterator

Definition at line 525 of file Grid.h.

using openvdb::OPENVDB_VERSION_NAME::GridCPtrSetIter = typedef GridCPtrSet::iterator

Definition at line 524 of file Grid.h.

Definition at line 526 of file Grid.h.

Definition at line 513 of file Grid.h.

using openvdb::OPENVDB_VERSION_NAME::GridCPtrVecCIter = typedef GridCPtrVec::const_iterator

Definition at line 515 of file Grid.h.

using openvdb::OPENVDB_VERSION_NAME::GridCPtrVecIter = typedef GridCPtrVec::iterator

Definition at line 514 of file Grid.h.

Definition at line 516 of file Grid.h.

Definition at line 518 of file Grid.h.

using openvdb::OPENVDB_VERSION_NAME::GridPtrSetCIter = typedef GridPtrSet::const_iterator

Definition at line 520 of file Grid.h.

using openvdb::OPENVDB_VERSION_NAME::GridPtrSetIter = typedef GridPtrSet::iterator

Definition at line 519 of file Grid.h.

Definition at line 521 of file Grid.h.

Definition at line 508 of file Grid.h.

using openvdb::OPENVDB_VERSION_NAME::GridPtrVecCIter = typedef GridPtrVec::const_iterator

Definition at line 510 of file Grid.h.

using openvdb::OPENVDB_VERSION_NAME::GridPtrVecIter = typedef GridPtrVec::iterator

Definition at line 509 of file Grid.h.

Definition at line 511 of file Grid.h.

using openvdb::OPENVDB_VERSION_NAME::GridTypes = typedef NumericGridTypes:: Append<Vec3GridTypes>:: Append<tools::PointIndexGrid>:: Append<points::PointDataGrid>:: Append<BoolGrid, MaskGrid>

The Grid types which OpenVDB will register by default.

Definition at line 110 of file openvdb.h.

Definition at line 54 of file Types.h.

using openvdb::OPENVDB_VERSION_NAME::Index32 = typedef uint32_t

Definition at line 52 of file Types.h.

using openvdb::OPENVDB_VERSION_NAME::Index64 = typedef uint64_t

Definition at line 53 of file Types.h.

Definition at line 58 of file Types.h.

using openvdb::OPENVDB_VERSION_NAME::Int16 = typedef int16_t

Definition at line 55 of file Types.h.

using openvdb::OPENVDB_VERSION_NAME::Int32 = typedef int32_t

Definition at line 56 of file Types.h.

Definition at line 76 of file openvdb.h.

Definition at line 361 of file Metadata.h.

using openvdb::OPENVDB_VERSION_NAME::Int32Tree = typedef tree::Tree4<int32_t, 5, 4, 3>::Type

Definition at line 56 of file openvdb.h.

using openvdb::OPENVDB_VERSION_NAME::Int64 = typedef int64_t

Definition at line 57 of file Types.h.

Definition at line 77 of file openvdb.h.

Definition at line 362 of file Metadata.h.

using openvdb::OPENVDB_VERSION_NAME::Int64Tree = typedef tree::Tree4<int64_t, 5, 4, 3>::Type

Definition at line 57 of file openvdb.h.

using openvdb::OPENVDB_VERSION_NAME::IntegerAttributeTypes = typedef TypeList< points::TypedAttributeArray<int8_t>, points::TypedAttributeArray<int16_t>, points::TypedAttributeArray<int32_t>, points::TypedAttributeArray<int64_t> >

The integer attribute array types which OpenVDB will register by default.

Definition at line 143 of file openvdb.h.

The integer Grid types which OpenVDB will register by default.

Definition at line 93 of file openvdb.h.

template<std::size_t N>
using openvdb::OPENVDB_VERSION_NAME::make_index_sequence = typedef std::decay_t<decltype(make_index_sequence_impl<N>())>

Definition at line 234 of file Types.h.

Definition at line 78 of file openvdb.h.

Definition at line 58 of file openvdb.h.

using openvdb::OPENVDB_VERSION_NAME::Mat3AttributeTypes = typedef TypeList< points::TypedAttributeArray<math::Mat3<float>>, points::TypedAttributeArray<math::Mat3<double>> >

The Mat3 attribute array types which OpenVDB will register by default.

Definition at line 165 of file openvdb.h.

Definition at line 96 of file Types.h.

using openvdb::OPENVDB_VERSION_NAME::Mat4AttributeTypes = typedef TypeList< points::TypedAttributeArray<math::Mat4<float>>, points::TypedAttributeArray<math::Mat4<double>> >

The Mat4 attribute array types which OpenVDB will register by default.

Definition at line 170 of file openvdb.h.

Definition at line 374 of file Metadata.h.

Definition at line 101 of file Types.h.

Definition at line 373 of file Metadata.h.

Definition at line 19 of file Name.h.

using openvdb::OPENVDB_VERSION_NAME::NamePair = typedef std::pair<Name, Name>

Definition at line 39 of file AttributeArray.h.

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.

Definition at line 148 of file openvdb.h.

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.

Definition at line 97 of file openvdb.h.

using openvdb::OPENVDB_VERSION_NAME::NumericTreeTypes = typedef NumericGridTypes::Transform<internal::ToTreeType>

Definition at line 121 of file openvdb.h.

Definition at line 181 of file Types.h.

Definition at line 182 of file Types.h.

Definition at line 178 of file Types.h.

Definition at line 179 of file Types.h.

using openvdb::OPENVDB_VERSION_NAME::QuatAttributeTypes = typedef TypeList< points::TypedAttributeArray<math::Quat<float>>, points::TypedAttributeArray<math::Quat<double>> >

The Quat attribute array types which OpenVDB will register by default.

Definition at line 175 of file openvdb.h.

Definition at line 106 of file Types.h.

using openvdb::OPENVDB_VERSION_NAME::Real = typedef double

Definition at line 60 of file Types.h.

using openvdb::OPENVDB_VERSION_NAME::RealAttributeTypes = typedef 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.

Definition at line 136 of file openvdb.h.

The integer Grid types which OpenVDB will register by default.

Definition at line 91 of file openvdb.h.

Definition at line 82 of file openvdb.h.

Definition at line 66 of file openvdb.h.

template<typename T >
using openvdb::OPENVDB_VERSION_NAME::SharedPtr = typedef std::shared_ptr<T>

Definition at line 114 of file Types.h.

Definition at line 83 of file openvdb.h.

Definition at line 67 of file openvdb.h.

Definition at line 26 of file Grid.h.

using openvdb::OPENVDB_VERSION_NAME::TreeTypes = typedef GridTypes::Transform<internal::ToTreeType>

Definition at line 123 of file openvdb.h.

using openvdb::OPENVDB_VERSION_NAME::UInt32Tree = typedef tree::Tree4<uint32_t, 5, 4, 3>::Type

Definition at line 59 of file openvdb.h.

Definition at line 364 of file Metadata.h.

using openvdb::OPENVDB_VERSION_NAME::Vec2DTree = typedef tree::Tree4<Vec2d, 5, 4, 3>::Type

Definition at line 60 of file openvdb.h.

Definition at line 65 of file Types.h.

Definition at line 66 of file Types.h.

Definition at line 64 of file Types.h.

Definition at line 365 of file Metadata.h.

using openvdb::OPENVDB_VERSION_NAME::Vec2ITree = typedef tree::Tree4<Vec2i, 5, 4, 3>::Type

Definition at line 61 of file openvdb.h.

Definition at line 63 of file Types.h.

Definition at line 366 of file Metadata.h.

using openvdb::OPENVDB_VERSION_NAME::Vec2STree = typedef tree::Tree4<Vec2s, 5, 4, 3>::Type

Definition at line 62 of file openvdb.h.

using openvdb::OPENVDB_VERSION_NAME::Vec3AttributeTypes = typedef 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 Vec3 attribute array types which OpenVDB will register by default.

Definition at line 160 of file openvdb.h.

Definition at line 79 of file openvdb.h.

Definition at line 84 of file openvdb.h.

Definition at line 367 of file Metadata.h.

using openvdb::OPENVDB_VERSION_NAME::Vec3DTree = typedef tree::Tree4<Vec3d, 5, 4, 3>::Type

Definition at line 63 of file openvdb.h.

Definition at line 68 of file openvdb.h.

Definition at line 74 of file Types.h.

Definition at line 85 of file openvdb.h.

Definition at line 69 of file openvdb.h.

The Vec3 Grid types which OpenVDB will register by default.

Definition at line 99 of file openvdb.h.

Definition at line 75 of file Types.h.

Definition at line 73 of file Types.h.

Definition at line 80 of file openvdb.h.

Definition at line 368 of file Metadata.h.

using openvdb::OPENVDB_VERSION_NAME::Vec3ITree = typedef tree::Tree4<Vec3i, 5, 4, 3>::Type

Definition at line 64 of file openvdb.h.

Definition at line 72 of file Types.h.

Definition at line 81 of file openvdb.h.

Definition at line 369 of file Metadata.h.

Definition at line 65 of file openvdb.h.

Definition at line 77 of file Types.h.

Definition at line 76 of file Types.h.

Definition at line 370 of file Metadata.h.

Definition at line 89 of file Types.h.

Definition at line 90 of file Types.h.

Definition at line 88 of file Types.h.

Definition at line 371 of file Metadata.h.

Definition at line 87 of file Types.h.

Definition at line 372 of file Metadata.h.

Definition at line 86 of file openvdb.h.

Definition at line 70 of file openvdb.h.

template<typename T >
using openvdb::OPENVDB_VERSION_NAME::WeakPtr = typedef std::weak_ptr<T>

Definition at line 115 of file Types.h.

Enumeration Type Documentation

anonymous enum
Enumerator
NUM_GRID_CLASSES 

Definition at line 459 of file Types.h.

anonymous enum
Enumerator
NUM_VEC_TYPES 

Definition at line 490 of file Types.h.

anonymous enum

Notable file format version numbers.

Enumerator
OPENVDB_FILE_VERSION_ROOTNODE_MAP 
OPENVDB_FILE_VERSION_INTERNALNODE_COMPRESSION 
OPENVDB_FILE_VERSION_SIMPLIFIED_GRID_TYPENAME 
OPENVDB_FILE_VERSION_GRID_INSTANCING 
OPENVDB_FILE_VERSION_BOOL_LEAF_OPTIMIZATION 
OPENVDB_FILE_VERSION_BO__OST_UUID 
OPENVDB_FILE_VERSION_NO_GRIDMAP 
OPENVDB_FILE_VERSION_NEW_TRANSFORM 
OPENVDB_FILE_VERSION_SELECTIVE_COMPRESSION 
OPENVDB_FILE_VERSION_FLOAT_FRUSTUM_BBOX 
OPENVDB_FILE_VERSION_NODE_MASK_COMPRESSION 
OPENVDB_FILE_VERSION_BLOSC_COMPRESSION 
OPENVDB_FILE_VERSION_POINT_INDEX_GRID 
OPENVDB_FILE_VERSION_MULTIPASS_IO 

Definition at line 272 of file version.h.

Enumerator
GRID_UNKNOWN 
GRID_LEVEL_SET 
GRID_FOG_VOLUME 
GRID_STAGGERED 

Definition at line 453 of file Types.h.

Specify how grids should be merged during certain (typically multithreaded) operations.

MERGE_ACTIVE_STATES

The output grid is active wherever any of the input grids is active.

MERGE_NODES

The output grid's tree has a node wherever any of the input grids' trees has a node, regardless of any active states.

MERGE_ACTIVE_STATES_AND_NODES
The output grid is active wherever any of the input grids is active, and its tree has a node wherever any of the input grids' trees has a node.
Enumerator
MERGE_ACTIVE_STATES 
MERGE_NODES 
MERGE_ACTIVE_STATES_AND_NODES 

Definition at line 506 of file Types.h.

The type of a vector determines how transforms are applied to it:

Invariant

Does not transform (e.g., tuple, uvw, color)

Covariant

Apply inverse-transpose transformation: w = 0, ignores translation (e.g., gradient/normal)

Covariant Normalize

Apply inverse-transpose transformation: w = 0, ignores translation, vectors are renormalized (e.g., unit normal)

Contravariant Relative

Apply "regular" transformation: w = 0, ignores translation (e.g., displacement, velocity, acceleration)

Contravariant Absolute
Apply "regular" transformation: w = 1, vector translates (e.g., position)
Enumerator
VEC_INVARIANT 
VEC_COVARIANT 
VEC_COVARIANT_NORMALIZE 
VEC_CONTRAVARIANT_RELATIVE 
VEC_CONTRAVARIANT_ABSOLUTE 

Definition at line 483 of file Types.h.

Function Documentation

template<typename T , typename U >
SharedPtr<T> openvdb::OPENVDB_VERSION_NAME::ConstPtrCast ( const SharedPtr< U > &  ptr)
inline

Return a new shared pointer that points to the same object as the given pointer but with possibly different const-ness.

Example:
FloatGrid::Ptr nonConstGrid = ConstPtrCast<FloatGrid>(grid);
FloatGrid::ConstPtr constGrid = ConstPtrCast<const FloatGrid>(nonConstGrid);

Definition at line 126 of file Types.h.

template<typename GridType >
GridType::Ptr openvdb::OPENVDB_VERSION_NAME::createGrid ( const typename GridType::ValueType &  background)
inline

Create a new grid of type GridType with a given background value.

Note
Calling createGrid<GridType>(background) is equivalent to calling GridType::create(background).

Definition at line 1722 of file Grid.h.

template<typename GridType >
GridType::Ptr openvdb::OPENVDB_VERSION_NAME::createGrid ( )
inline

Create a new grid of type GridType with background value zero.

Note
Calling createGrid<GridType>() is equivalent to calling GridType::create().

Definition at line 1730 of file Grid.h.

template<typename TreePtrType >
Grid< typename TreePtrType::element_type >::Ptr openvdb::OPENVDB_VERSION_NAME::createGrid ( TreePtrType  tree)
inline

Create a new grid of the appropriate type that wraps the given tree.

Note
This function can be called without specifying the template argument, i.e., as createGrid(tree).

Definition at line 1738 of file Grid.h.

template<typename GridType >
GridType::Ptr openvdb::OPENVDB_VERSION_NAME::createLevelSet ( Real  voxelSize = 1.0,
Real  halfWidth = LEVEL_SET_HALF_WIDTH 
)

Create a new grid of type GridType classified as a "Level Set", i.e., a narrow-band level set.

Note
GridType::ValueType must be a floating-point scalar.
Parameters
voxelSizethe size of a voxel in world units
halfWidththe half width of the narrow band in voxel units

The voxel size and the narrow band half width define the grid's background value as halfWidth*voxelWidth. The transform is linear with a uniform scaling only corresponding to the specified voxel size.

Note
It is generally advisable to specify a half-width of the narrow band that is larger than one voxel unit, otherwise zero crossings are not guaranteed.

Definition at line 1747 of file Grid.h.

template<typename GridType >
GridType::Ptr openvdb::OPENVDB_VERSION_NAME::deepCopyTypedGrid ( const GridBase::ConstPtr &  grid)
inline

Return a pointer to a deep copy of the given grid, provided that the grid's concrete type is GridType.

Return a null pointer if the input pointer is null or if it points to a grid that is not of type GridType.

Definition at line 1035 of file Grid.h.

template<typename GridType >
GridType::Ptr openvdb::OPENVDB_VERSION_NAME::deepCopyTypedGrid ( const GridBase &  grid)
inline

Return a pointer to a deep copy of the given grid, provided that the grid's concrete type is GridType.

Return a null pointer if the input pointer is null or if it points to a grid that is not of type GridType.

Definition at line 1044 of file Grid.h.

template<typename T , typename U >
SharedPtr<T> openvdb::OPENVDB_VERSION_NAME::DynamicPtrCast ( const SharedPtr< U > &  ptr)
inline

Return a new shared pointer that is either null or points to the same object as the given pointer after a dynamic_cast.

Example:
GridBase::ConstPtr grid = ...;
FloatGrid::ConstPtr floatGrid = DynamicPtrCast<const FloatGrid>(grid);

Definition at line 136 of file Types.h.

template<size_t Start, size_t End, typename OpT , typename RetT >
OPENVDB_TYPELIST_FORCE_INLINE RetT openvdb::OPENVDB_VERSION_NAME::evalFirstIndex ( OpT  op,
const RetT  def = RetT() 
)

Definition at line 566 of file TypeList.h.

template<typename GridPtrContainerT >
GridPtrContainerT::value_type openvdb::OPENVDB_VERSION_NAME::findGridByName ( const GridPtrContainerT &  container,
const Name name 
)
inline

Return the first grid in the given container whose name is name.

Definition at line 540 of file Grid.h.

template<typename KeyT , typename GridPtrT >
GridPtrT openvdb::OPENVDB_VERSION_NAME::findGridByName ( const std::map< KeyT, GridPtrT > &  container,
const Name name 
)
inline

Return the first grid in the given map whose name is name.

Definition at line 551 of file Grid.h.

template<size_t Start, size_t End, typename OpT >
OPENVDB_TYPELIST_FORCE_INLINE auto openvdb::OPENVDB_VERSION_NAME::foreachIndex ( OpT  op)

Definition at line 560 of file TypeList.h.

constexpr const char* openvdb::OPENVDB_VERSION_NAME::getLibraryAbiVersionString ( )
inline

Return a library version number string of the form "<major>.<minor>.<patch>abi<abi>".

Definition at line 293 of file version.h.

constexpr const char* openvdb::OPENVDB_VERSION_NAME::getLibraryVersionString ( )
inline

Return a library version number string of the form "<major>.<minor>.<patch>".

Definition at line 291 of file version.h.

constexpr const char* openvdb::OPENVDB_VERSION_NAME::getPackageRevision ( )
inline

Definition at line 297 of file version.h.

constexpr const char* openvdb::OPENVDB_VERSION_NAME::getPackageUrl ( )
inline

Definition at line 296 of file version.h.

template<typename GridType >
GridType::ConstPtr openvdb::OPENVDB_VERSION_NAME::gridConstPtrCast ( const GridBase::ConstPtr &  grid)
inline

Cast a generic const grid pointer to a const pointer to a grid of a concrete class.

Return a null pointer if the input pointer is null or if it points to a grid that is not of type GridType.

Note
Calling gridConstPtrCast<GridType>(grid) is equivalent to calling GridBase::constGrid<GridType>(grid).

Definition at line 1018 of file Grid.h.

template<typename GridType >
GridType::Ptr openvdb::OPENVDB_VERSION_NAME::gridPtrCast ( const GridBase::Ptr &  grid)
inline

Cast a generic grid pointer to a pointer to a grid of a concrete class.

Return a null pointer if the input pointer is null or if it points to a grid that is not of type GridType.

Note
Calling gridPtrCast<GridType>(grid) is equivalent to calling GridBase::grid<GridType>(grid).

Definition at line 1002 of file Grid.h.

OPENVDB_API void openvdb::OPENVDB_VERSION_NAME::initialize ( )
inline

Global registration of native Grid, Transform, Metadata and Point attribute types. Also initializes blosc (if enabled).

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.

Definition at line 294 of file logging.h.

template<std::size_t N, std::size_t... Is>
auto openvdb::OPENVDB_VERSION_NAME::make_index_sequence_impl ( )

Definition at line 226 of file Types.h.

openvdb::OPENVDB_VERSION_NAME::OPENVDB_EXCEPTION ( ArithmeticError  )
openvdb::OPENVDB_VERSION_NAME::OPENVDB_EXCEPTION ( IndexError  )
openvdb::OPENVDB_VERSION_NAME::OPENVDB_EXCEPTION ( IoError  )
openvdb::OPENVDB_VERSION_NAME::OPENVDB_EXCEPTION ( KeyError  )
openvdb::OPENVDB_VERSION_NAME::OPENVDB_EXCEPTION ( LookupError  )
openvdb::OPENVDB_VERSION_NAME::OPENVDB_EXCEPTION ( NotImplementedError  )
openvdb::OPENVDB_VERSION_NAME::OPENVDB_EXCEPTION ( ReferenceError  )
openvdb::OPENVDB_VERSION_NAME::OPENVDB_EXCEPTION ( RuntimeError  )
openvdb::OPENVDB_VERSION_NAME::OPENVDB_EXCEPTION ( TypeError  )
openvdb::OPENVDB_VERSION_NAME::OPENVDB_EXCEPTION ( ValueError  )
std::ostream& openvdb::OPENVDB_VERSION_NAME::operator<< ( std::ostream &  ,
const MetaMap &   
)

Write a MetaMap to an output stream.

std::ostream & openvdb::OPENVDB_VERSION_NAME::operator<< ( std::ostream &  ostr,
const Metadata &  metadata 
)
inline

Write a Metadata to an output stream.

Definition at line 351 of file Metadata.h.

Name openvdb::OPENVDB_VERSION_NAME::readString ( std::istream &  is)
inline

Definition at line 22 of file Name.h.

template<typename T , typename U >
SharedPtr<T> openvdb::OPENVDB_VERSION_NAME::StaticPtrCast ( const SharedPtr< U > &  ptr)
inline

Return a new shared pointer that points to the same object as the given pointer after a static_cast.

Example:
FloatGrid::Ptr floatGrid = ...;
GridBase::Ptr grid = StaticPtrCast<GridBase>(floatGrid);

Definition at line 146 of file Types.h.

template<typename T >
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString ( )

Definition at line 516 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< bool > ( )
inline

Definition at line 517 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< double > ( )
inline

Definition at line 521 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< float > ( )
inline

Definition at line 520 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< int16_t > ( )
inline

Definition at line 524 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< int32_t > ( )
inline

Definition at line 526 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< int64_t > ( )
inline

Definition at line 528 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< int8_t > ( )
inline

Definition at line 522 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< Mat3d > ( )
inline

Definition at line 542 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< Mat3s > ( )
inline

Definition at line 541 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< Mat4d > ( )
inline

Definition at line 544 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< Mat4s > ( )
inline

Definition at line 543 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< math::half > ( )
inline

Definition at line 519 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< math::Quatd > ( )
inline

Definition at line 546 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< math::Quats > ( )
inline

Definition at line 545 of file Types.h.

Definition at line 549 of file Types.h.

Definition at line 550 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< PointIndex32 > ( )
inline

Definition at line 547 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< PointIndex64 > ( )
inline

Definition at line 548 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< std::string > ( )
inline

Definition at line 540 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< uint16_t > ( )
inline

Definition at line 525 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< uint32_t > ( )
inline

Definition at line 527 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< uint8_t > ( )
inline

Definition at line 523 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< ValueMask > ( )
inline

Definition at line 518 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< Vec2d > ( )
inline

Definition at line 531 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< Vec2i > ( )
inline

Definition at line 529 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< Vec2s > ( )
inline

Definition at line 530 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< Vec3d > ( )
inline

Definition at line 536 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< Vec3f > ( )
inline

Definition at line 535 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< Vec3i > ( )
inline

Definition at line 534 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< Vec3U16 > ( )
inline

Definition at line 533 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< Vec3U8 > ( )
inline

Definition at line 532 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< Vec4d > ( )
inline

Definition at line 539 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< Vec4f > ( )
inline

Definition at line 538 of file Types.h.

template<>
const char* openvdb::OPENVDB_VERSION_NAME::typeNameAsString< Vec4i > ( )
inline

Definition at line 537 of file Types.h.

OPENVDB_API void openvdb::OPENVDB_VERSION_NAME::uninitialize ( )

Global deregistration of native Grid, Transform, Metadata and Point attribute types.

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.
void openvdb::OPENVDB_VERSION_NAME::writeString ( std::ostream &  os,
const Name name 
)
inline

Definition at line 33 of file Name.h.

template<typename T >
constexpr T openvdb::OPENVDB_VERSION_NAME::zeroVal ( )
inline

Return the value of type T that corresponds to zero.

Note
A zeroVal<T>() specialization must be defined for each ValueType T that cannot be constructed using the form T(0). For example, std::string(0) treats 0 as nullptr and throws a std::logic_error.

Definition at line 70 of file Math.h.

template<>
constexpr bool openvdb::OPENVDB_VERSION_NAME::zeroVal< bool > ( )
inline

Return the bool value that corresponds to zero.

Definition at line 74 of file Math.h.

Definition at line 844 of file Mat3.h.

Definition at line 843 of file Mat3.h.

Definition at line 1364 of file Mat4.h.

Definition at line 1363 of file Mat4.h.

Definition at line 610 of file Quat.h.

Definition at line 609 of file Quat.h.

Return the std::string value that corresponds to zero.

Definition at line 72 of file Math.h.

Variable Documentation

const uint32_t openvdb::OPENVDB_VERSION_NAME::OPENVDB_ABI_VERSION

ABI version number

Definition at line 264 of file version.h.

const uint32_t openvdb::OPENVDB_VERSION_NAME::OPENVDB_FILE_VERSION = 224

The current version number of the VDB file format.

This can be used to enable various backwards compatibility switches or to reject files that cannot be read.

Definition at line 269 of file version.h.

const uint32_t openvdb::OPENVDB_VERSION_NAME::OPENVDB_LIBRARY_MAJOR_VERSION

Library major, minor and patch version numbers

Definition at line 256 of file version.h.

const uint32_t openvdb::OPENVDB_VERSION_NAME::OPENVDB_LIBRARY_MINOR_VERSION

Definition at line 257 of file version.h.

const uint32_t openvdb::OPENVDB_VERSION_NAME::OPENVDB_LIBRARY_PATCH_VERSION

Definition at line 258 of file version.h.

const uint32_t openvdb::OPENVDB_VERSION_NAME::OPENVDB_LIBRARY_VERSION

Library version number as a packed integer ("%02x%02x%04x", major, minor, patch)

Definition at line 261 of file version.h.

const int32_t openvdb::OPENVDB_VERSION_NAME::OPENVDB_MAGIC = 0x56444220

The magic number is stored in the first four bytes of every VDB file.

This can be used to quickly test whether we have a valid file or not.

Definition at line 251 of file version.h.