Container class that associates a tree with a transform and metadata. More...

#include <openvdb/Grid.h>

Classes
struct	ValueConverter
	ValueConverter<T>::Type is the type of a grid having the same hierarchy as this grid but a different value type, T. More...

Public Types
using	Ptr = SharedPtr< Grid >

using	ConstPtr = SharedPtr< const Grid >

using	TreeType = _TreeType

using	TreePtrType = typename _TreeType::Ptr

using	ConstTreePtrType = typename _TreeType::ConstPtr

using	ValueType = typename _TreeType::ValueType

using	BuildType = typename _TreeType::BuildType

using	ValueOnIter = typename _TreeType::ValueOnIter

using	ValueOnCIter = typename _TreeType::ValueOnCIter

using	ValueOffIter = typename _TreeType::ValueOffIter

using	ValueOffCIter = typename _TreeType::ValueOffCIter

using	ValueAllIter = typename _TreeType::ValueAllIter

using	ValueAllCIter = typename _TreeType::ValueAllCIter

using	Accessor = typename _TreeType::Accessor

using	ConstAccessor = typename _TreeType::ConstAccessor

using	UnsafeAccessor = typename _TreeType::UnsafeAccessor

using	ConstUnsafeAccessor = typename _TreeType::ConstUnsafeAccessor

using	GridFactory) = Ptr(*)(

using	MetadataMap = std::map< Name, Metadata::Ptr >

using	MetaIterator = MetadataMap::iterator

using	ConstMetaIterator = MetadataMap::const_iterator

Public Member Functions
	Grid ()
	Construct a new grid with background value zero. More...

	Grid (const ValueType &background)
	Construct a new grid with the given background value. More...

	Grid (TreePtrType)
	Construct a new grid that shares the given tree and associates with it an identity linear transform. More...

	Grid (const Grid &)
	Deep copy another grid's metadata, transform and tree. More...

template<typename OtherTreeType >
	Grid (const Grid< OtherTreeType > &)
	Deep copy the metadata, transform and tree of another grid whose tree configuration is the same as this grid's but whose value type is different. Cast the other grid's values to this grid's value type. More...

	Grid (Grid &, ShallowCopy)
	Deep copy another grid's metadata and transform, but share its tree. More...

	Grid (const GridBase &)
	Deep copy another grid's metadata and transform, but construct a new tree with background value zero. More...

	~Grid () override

Grid &	operator= (const Grid &)=delete
	Disallow assignment, since it wouldn't be obvious whether the copy is deep or shallow. More...

Name	type () const override
	Return the name of this grid's type. More...

Name	valueType () const override
	Return the name of the type of a voxel's value (e.g., "float" or "vec3d"). More...

bool	isTreeUnique () const final
	Return true if tree is not shared with another grid. More...

MetaMap::Ptr	copyMeta () const
	Return a copy of this map whose fields are shared with this map. More...

MetaMap::Ptr	deepCopyMeta () const
	Return a deep copy of this map that shares no data with this map. More...

void	readMeta (std::istream &)
	Unserialize metadata from the given stream. More...

void	writeMeta (std::ostream &) const
	Serialize metadata to the given stream. More...

void	insertMeta (const Name &, const Metadata &value)
	Insert a new metadata field or overwrite the value of an existing field. More...

void	insertMeta (const MetaMap &)
	Deep copy all of the metadata fields from the given map into this map. More...

void	removeMeta (const Name &)
	Remove the given metadata field if it exists. More...

template<typename T >
T &	metaValue (const Name &)
	Return a reference to the value of type `T` stored in the given metadata field. More...

template<typename T >
const T &	metaValue (const Name &) const

MetaIterator	beginMeta ()

ConstMetaIterator	beginMeta () const

MetaIterator	endMeta ()

ConstMetaIterator	endMeta () const

void	clearMetadata ()

size_t	metaCount () const

std::string	str (const std::string &indent="") const
	Return a string describing this metadata map. Prefix each line with indent. More...

bool	operator== (const MetaMap &other) const
	Return `true` if the given map is equivalent to this map. More...

bool	operator!= (const MetaMap &other) const
	Return `true` if the given map is different from this map. More...

Copying
Ptr	copy ()
	Return a new grid of the same type as this grid whose metadata and transform are deep copies of this grid's and whose tree is shared with this grid. More...

ConstPtr	copy () const
	Return a new grid of the same type as this grid whose metadata and transform are deep copies of this grid's and whose tree is shared with this grid. More...

Ptr	copyWithNewTree () const
	Return a new grid of the same type as this grid whose metadata and transform are deep copies of this grid's and whose tree is default-constructed. More...

GridBase::Ptr	copyGrid () override
	Return a new grid of the same type as this grid whose metadata is a deep copy of this grid's and whose tree and transform are shared with this grid. More...

GridBase::ConstPtr	copyGrid () const override
	Return a new grid of the same type as this grid whose metadata is a deep copy of this grid's and whose tree and transform are shared with this grid. More...

GridBase::Ptr	copyGridWithNewTree () const override
	Return a new grid of the same type as this grid whose metadata and transform are deep copies of this grid's and whose tree is default-constructed. More...

ConstPtr	copyReplacingMetadata (const MetaMap &meta) const
	Return a new grid of the same type as this grid whose tree and transform is shared with this grid and whose metadata is provided as an argument. More...

ConstPtr	copyReplacingTransform (math::Transform::Ptr xform) const
	Return a new grid of the same type as this grid whose tree is shared with this grid, whose metadata is a deep copy of this grid's and whose transform is provided as an argument. More...

ConstPtr	copyReplacingMetadataAndTransform (const MetaMap &meta, math::Transform::Ptr xform) const
	Return a new grid of the same type as this grid whose tree is shared with this grid and whose transform and metadata are provided as arguments. More...

GridBase::ConstPtr	copyGridReplacingMetadata (const MetaMap &meta) const override
	Return a new grid of the same type as this grid whose tree and transform is shared with this grid and whose metadata is provided as an argument. More...

GridBase::ConstPtr	copyGridReplacingTransform (math::Transform::Ptr xform) const override
	Return a new grid of the same type as this grid whose tree is shared with this grid, whose metadata is a deep copy of this grid's and whose transform is provided as an argument. More...

GridBase::ConstPtr	copyGridReplacingMetadataAndTransform (const MetaMap &meta, math::Transform::Ptr xform) const override
	Return a new grid of the same type as this grid whose tree is shared with this grid and whose transform and metadata are provided as arguments. More...

Ptr	deepCopy () const
	Return a new grid whose metadata, transform and tree are deep copies of this grid's. More...

GridBase::Ptr	deepCopyGrid () const override
	Return a new grid whose metadata, transform and tree are deep copies of this grid's. More...

Voxel access
const ValueType &	background () const
	Return this grid's background value. More...

bool	empty () const override
	Return `true` if this grid contains only inactive background voxels. More...

void	clear () override
	Empty this grid, so that all voxels become inactive background voxels. More...

Accessor	getAccessor ()
	Return an accessor that provides random read and write access to this grid's voxels. More...

UnsafeAccessor	getUnsafeAccessor ()
	Return an unsafe accessor that provides random read and write access to this grid's voxels. More...

ConstAccessor	getAccessor () const
	Return an accessor that provides random read-only access to this grid's voxels. More...

ConstAccessor	getConstAccessor () const
	Return an accessor that provides random read-only access to this grid's voxels. More...

ConstUnsafeAccessor	getConstUnsafeAccessor () const
	Return an unsafe accessor that provides random read-only access to this grid's voxels. More...

ValueOnIter	beginValueOn ()
	Return an iterator over all of this grid's active values (tile and voxel). More...

ValueOnCIter	beginValueOn () const
	Return an iterator over all of this grid's active values (tile and voxel). More...

ValueOnCIter	cbeginValueOn () const
	Return an iterator over all of this grid's active values (tile and voxel). More...

ValueOffIter	beginValueOff ()
	Return an iterator over all of this grid's inactive values (tile and voxel). More...

ValueOffCIter	beginValueOff () const
	Return an iterator over all of this grid's inactive values (tile and voxel). More...

ValueOffCIter	cbeginValueOff () const
	Return an iterator over all of this grid's inactive values (tile and voxel). More...

ValueAllIter	beginValueAll ()
	Return an iterator over all of this grid's values (tile and voxel). More...

ValueAllCIter	beginValueAll () const
	Return an iterator over all of this grid's values (tile and voxel). More...

ValueAllCIter	cbeginValueAll () const
	Return an iterator over all of this grid's values (tile and voxel). More...

Tools
void	sparseFill (const CoordBBox &bbox, const ValueType &value, bool active=true)
	Set all voxels within a given axis-aligned box to a constant value. More...

void	fill (const CoordBBox &bbox, const ValueType &value, bool active=true)
	Set all voxels within a given axis-aligned box to a constant value. More...

void	denseFill (const CoordBBox &bbox, const ValueType &value, bool active=true)
	Set all voxels within a given axis-aligned box to a constant value and ensure that those voxels are all represented at the leaf level. More...

void	pruneGrid (float tolerance=0.0) override
	Reduce the memory footprint of this grid by increasing its sparseness. More...

void	clip (const CoordBBox &) override
	Clip this grid to the given index-space bounding box. More...

void	merge (Grid &other, MergePolicy policy=MERGE_ACTIVE_STATES)
	Efficiently merge another grid into this grid using one of several schemes. More...

template<typename OtherTreeType >
void	topologyUnion (const Grid< OtherTreeType > &other)
	Union this grid's set of active values with the active values of the other grid, whose value type may be different. More...

template<typename OtherTreeType >
void	topologyIntersection (const Grid< OtherTreeType > &other)
	Intersect this grid's set of active values with the active values of the other grid, whose value type may be different. More...

template<typename OtherTreeType >
void	topologyDifference (const Grid< OtherTreeType > &other)
	Difference this grid's set of active values with the active values of the other grid, whose value type may be different. More...

Statistics
Index64	activeVoxelCount () const override
	Return the number of active voxels. More...

CoordBBox	evalActiveVoxelBoundingBox () const override
	Return the axis-aligned bounding box of all active voxels. More...

Coord	evalActiveVoxelDim () const override
	Return the dimensions of the axis-aligned bounding box of all active voxels. More...

void	evalMinMax (ValueType &minVal, ValueType &maxVal) const
	Return the minimum and maximum active values in this grid. More...

Index64	memUsage () const override

Tree
TreePtrType	treePtr ()
	Return a pointer to this grid's tree, which might be shared with other grids. The pointer is guaranteed to be non-null. More...

ConstTreePtrType	treePtr () const
	Return a pointer to this grid's tree, which might be shared with other grids. The pointer is guaranteed to be non-null. More...

ConstTreePtrType	constTreePtr () const
	Return a pointer to this grid's tree, which might be shared with other grids. The pointer is guaranteed to be non-null. More...

TreeBase::ConstPtr	constBaseTreePtr () const override
	Return a pointer to this grid's tree, which might be shared with other grids. The pointer is guaranteed to be non-null. More...

void	setTree (TreeBase::Ptr) override
	Associate the given tree with this grid, in place of its existing tree. More...

void	newTree () override
	Associate a new, empty tree with this grid, in place of its existing tree. More...


TreeType &	tree ()
	Return a reference to this grid's tree, which might be shared with other grids. More...

const TreeType &	tree () const
	Return a reference to this grid's tree, which might be shared with other grids. More...

const TreeType &	constTree () const
	Return a reference to this grid's tree, which might be shared with other grids. More...

I/O
void	readTopology (std::istream &) override
	Read the grid topology from a stream. This will read only the grid structure, not the actual data buffers. More...

void	writeTopology (std::ostream &) const override
	Write the grid topology to a stream. This will write only the grid structure, not the actual data buffers. More...

void	readBuffers (std::istream &) override
	Read all data buffers for this grid. More...

void	readBuffers (std::istream &, const CoordBBox &) override
	Read all of this grid's data buffers that intersect the given index-space bounding box. More...

void	readNonresidentBuffers () const override
	Read all of this grid's data buffers that are not yet resident in memory (because delayed loading is in effect). More...

void	writeBuffers (std::ostream &) const override
	Write out all data buffers for this grid. More...

void	print (std::ostream &=std::cout, int verboseLevel=1) const override
	Output a human-readable description of this grid. More...

Type access
template<typename GridType >
bool	isType () const
	Return `true` if this grid is of the same type as the template parameter. More...

Tree
TreeBase::Ptr	baseTreePtr ()
	Return a pointer to this grid's tree, which might be shared with other grids. The pointer is guaranteed to be non-null. More...

TreeBase::ConstPtr	baseTreePtr () const
	Return a pointer to this grid's tree, which might be shared with other grids. The pointer is guaranteed to be non-null. More...

TreeBase &	baseTree ()
	Return a reference to this grid's tree, which might be shared with other grids. More...

const TreeBase &	baseTree () const
	Return a reference to this grid's tree, which might be shared with other grids. More...

const TreeBase &	constBaseTree () const
	Return a reference to this grid's tree, which might be shared with other grids. More...

Tools
void	clipGrid (const BBoxd &)
	Clip this grid to the given world-space bounding box. More...


template<typename GridTypeListT , typename OpT >
bool	apply (OpT &) const
	If this grid resolves to one of the listed grid types, invoke the given functor on the resolved grid. More...

template<typename GridTypeListT , typename OpT >
bool	apply (OpT &)
	If this grid resolves to one of the listed grid types, invoke the given functor on the resolved grid. More...

template<typename GridTypeListT , typename OpT >
bool	apply (const OpT &) const
	If this grid resolves to one of the listed grid types, invoke the given functor on the resolved grid. More...

template<typename GridTypeListT , typename OpT >
bool	apply (const OpT &)
	If this grid resolves to one of the listed grid types, invoke the given functor on the resolved grid. More...

Metadata
std::string	getName () const
	Return this grid's user-specified name. More...

void	setName (const std::string &)
	Specify a name for this grid. More...

std::string	getCreator () const
	Return the user-specified description of this grid's creator. More...

void	setCreator (const std::string &)
	Provide a description of this grid's creator. More...

bool	saveFloatAsHalf () const
	Return `true` if this grid should be written out with floating-point voxel values (including components of vectors) quantized to 16 bits. More...

void	setSaveFloatAsHalf (bool)
	Return this grid's user-specified name. More...

GridClass	getGridClass () const
	Return the class of volumetric data (level set, fog volume, etc.) that is stored in this grid. More...

void	setGridClass (GridClass)
	Specify the class of volumetric data (level set, fog volume, etc.) that is stored in this grid. More...

void	clearGridClass ()
	Remove the setting specifying the class of this grid's volumetric data. More...

VecType	getVectorType () const
	Return the type of vector data (invariant, covariant, etc.) stored in this grid, assuming that this grid contains a vector-valued tree. More...

void	setVectorType (VecType)
	Specify the type of vector data (invariant, covariant, etc.) stored in this grid, assuming that this grid contains a vector-valued tree. More...

void	clearVectorType ()
	Remove the setting specifying the type of vector data stored in this grid. More...

bool	isInWorldSpace () const

void	setIsInWorldSpace (bool)
	Specify whether this grid's voxel values are in world space or in local space. More...

Statistics
void	addStatsMetadata ()
	Add metadata to this grid comprising the current values of statistics like the active voxel count and bounding box. More...

MetaMap::Ptr	getStatsMetadata () const
	Return a new MetaMap containing just the metadata that was added to this grid with addStatsMetadata. More...

Transform
math::Transform::Ptr	transformPtr ()
	Return a pointer to this grid's transform, which might be shared with other grids. More...

math::Transform::ConstPtr	transformPtr () const
	Return a pointer to this grid's transform, which might be shared with other grids. More...

math::Transform::ConstPtr	constTransformPtr () const
	Return a pointer to this grid's transform, which might be shared with other grids. More...

void	setTransform (math::Transform::Ptr)
	Associate the given transform with this grid, in place of its existing transform. More...

Vec3d	voxelSize () const
	Return the size of this grid's voxels. More...

Vec3d	voxelSize (const Vec3d &xyz) const
	Return the size of this grid's voxel at position (x, y, z). More...

bool	hasUniformVoxels () const
	Return true if the voxels in world space are uniformly sized cubes. More...

Vec3d	indexToWorld (const Vec3d &xyz) const
	Apply this grid's transform to the given coordinates. More...

Vec3d	indexToWorld (const Coord &ijk) const
	Apply this grid's transform to the given coordinates. More...

Vec3d	worldToIndex (const Vec3d &xyz) const
	Apply the inverse of this grid's transform to the given coordinates. More...


math::Transform &	transform ()
	Return a reference to this grid's transform, which might be shared with other grids. More...

const math::Transform &	transform () const
	Return a reference to this grid's transform, which might be shared with other grids. More...

const math::Transform &	constTransform () const
	Return a reference to this grid's transform, which might be shared with other grids. More...

I/O
void	readTransform (std::istream &is)
	Read in the transform for this grid. More...

void	writeTransform (std::ostream &os) const
	Write out the transform for this grid. More...


Metadata::Ptr	operator[] (const Name &)
	Return a pointer to the metadata with the given name. If no such field exists, return a null pointer. More...

Metadata::ConstPtr	operator[] (const Name &) const
	Return a pointer to the metadata with the given name. If no such field exists, return a null pointer. More...


template<typename T >
T::Ptr	getMetadata (const Name &)
	Return a pointer to a TypedMetadata object of type `T` and with the given name. If no such field exists or if there is a type mismatch, return a null pointer. More...

template<typename T >
T::ConstPtr	getMetadata (const Name &) const
	Return a pointer to a TypedMetadata object of type `T` and with the given name. If no such field exists or if there is a type mismatch, return a null pointer. More...

Static Public Member Functions
static Ptr	create (const ValueType &background)
	Return a new grid with the given background value. More...

static Ptr	create ()
	Return a new grid with background value zero. More...

static Ptr	create (TreePtrType)
	Return a new grid that contains the given tree. More...

static Ptr	create (const GridBase &other)
	Return a new, empty grid with the same transform and metadata as the given grid and with background value zero. More...

static Name	gridType ()
	Return the name of this type of grid. More...

static bool	hasMultiPassIO ()
	Return `true` if grids of this type require multiple I/O passes to read and write data buffers. More...

static std::string	gridClassToString (GridClass)
	Return the metadata string value for the given class of volumetric data. More...

static std::string	gridClassToMenuName (GridClass)
	Return a formatted string version of the grid class. More...

static GridClass	stringToGridClass (const std::string &)
	Return the class of volumetric data specified by the given string. More...

static std::string	vecTypeToString (VecType)
	Return the metadata string value for the given type of vector data. More...

static std::string	vecTypeExamples (VecType)

static std::string	vecTypeDescription (VecType)
	Return a string describing how the given type of vector data is affected by transformations (e.g., "Does not transform", given VEC_INVARIANT). More...

static VecType	stringToVecType (const std::string &)

Registry
static bool	isRegistered ()
	Return `true` if this grid type is registered. More...

static void	registerGrid ()
	Register this grid type along with a factory function. More...

static void	unregisterGrid ()
	Remove this grid type from the registry. More...

Registry
static Ptr	createGrid (const Name &type)
	Create a new grid of the given (registered) type. More...

static bool	isRegistered (const Name &type)
	Return `true` if the given grid type name is registered. More...

static void	clearRegistry ()
	Clear the grid type registry. More...


template<typename GridType >
static GridType::Ptr	grid (const GridBase::Ptr &)
	Return the result of downcasting a GridBase pointer to a Grid pointer of the specified type, or return a null pointer if the types are incompatible. More...

template<typename GridType >
static GridType::ConstPtr	grid (const GridBase::ConstPtr &)
	Return the result of downcasting a GridBase pointer to a Grid pointer of the specified type, or return a null pointer if the types are incompatible. More...

template<typename GridType >
static GridType::ConstPtr	constGrid (const GridBase::Ptr &)
	Return the result of downcasting a GridBase pointer to a Grid pointer of the specified type, or return a null pointer if the types are incompatible. More...

template<typename GridType >
static GridType::ConstPtr	constGrid (const GridBase::ConstPtr &)
	Return the result of downcasting a GridBase pointer to a Grid pointer of the specified type, or return a null pointer if the types are incompatible. More...

Static Public Attributes
static const char *const	META_GRID_CLASS

static const char *const	META_GRID_CREATOR

static const char *const	META_GRID_NAME

static const char *const	META_SAVE_HALF_FLOAT

static const char *const	META_IS_LOCAL_SPACE

static const char *const	META_VECTOR_TYPE

static const char *const	META_FILE_BBOX_MIN

static const char *const	META_FILE_BBOX_MAX

static const char *const	META_FILE_COMPRESSION

static const char *const	META_FILE_MEM_BYTES

static const char *const	META_FILE_VOXEL_COUNT

static const char *const	META_FILE_DELAYED_LOAD

Static Protected Member Functions
static void	registerGrid (const Name &type, GridFactory)
	Register a grid type along with a factory function. More...

static void	unregisterGrid (const Name &type)
	Remove a grid type from the registry. More...

Detailed Description

template<typename _TreeType>
class openvdb::v12_0::Grid< _TreeType >

Container class that associates a tree with a transform and metadata.

Member Typedef Documentation

using Accessor = typename _TreeType::Accessor

using BuildType = typename _TreeType::BuildType

using ConstAccessor = typename _TreeType::ConstAccessor

using ConstMetaIterator = MetadataMap::const_iterator

inherited

using ConstPtr = SharedPtr<const Grid>

using ConstTreePtrType = typename _TreeType::ConstPtr

using ConstUnsafeAccessor = typename _TreeType::ConstUnsafeAccessor

using GridFactory = Ptr (*)(

inherited

using MetadataMap = std::map<Name, Metadata::Ptr>

inherited

using MetaIterator = MetadataMap::iterator

inherited

using Ptr = SharedPtr<Grid>

using TreePtrType = typename _TreeType::Ptr

using TreeType = _TreeType

using UnsafeAccessor = typename _TreeType::UnsafeAccessor

using ValueAllCIter = typename _TreeType::ValueAllCIter

using ValueAllIter = typename _TreeType::ValueAllIter

using ValueOffCIter = typename _TreeType::ValueOffCIter

using ValueOffIter = typename _TreeType::ValueOffIter

using ValueOnCIter = typename _TreeType::ValueOnCIter

using ValueOnIter = typename _TreeType::ValueOnIter

using ValueType = typename _TreeType::ValueType

Constructor & Destructor Documentation

Grid ( )

inline

Construct a new grid with background value zero.

Grid ( const ValueType & background )

inlineexplicit

Construct a new grid with the given background value.

Grid ( TreePtrType tree )

inlineexplicit

Construct a new grid that shares the given tree and associates with it an identity linear transform.

Exceptions

ValueError if the tree pointer is null

Grid ( const Grid< _TreeType > & other )

inline

Deep copy another grid's metadata, transform and tree.

Grid ( const Grid< OtherTreeType > & other )

inlineexplicit

Deep copy the metadata, transform and tree of another grid whose tree configuration is the same as this grid's but whose value type is different. Cast the other grid's values to this grid's value type.

Exceptions

TypeError if the other grid's tree configuration doesn't match this grid's or if this grid's ValueType is not constructible from the other grid's ValueType.

Grid	(	Grid< _TreeType > &	other,
		ShallowCopy
	)

inline

Deep copy another grid's metadata and transform, but share its tree.

Grid ( const GridBase & other )

inlineexplicit

Deep copy another grid's metadata and transform, but construct a new tree with background value zero.

~Grid ( )

inlineoverride

Member Function Documentation

Index64 activeVoxelCount ( ) const

inlineoverridevirtual

Return the number of active voxels.

Implements GridBase.

void addStatsMetadata ( )

inherited

Add metadata to this grid comprising the current values of statistics like the active voxel count and bounding box.

Note: This metadata is not automatically kept up-to-date with changes to this grid.

bool apply ( OpT & op ) const

inlineinherited

If this grid resolves to one of the listed grid types, invoke the given functor on the resolved grid.

Returns: false if this grid's type is not one of the listed types

Example:: using AllowedGridTypes = openvdb::TypeList<
openvdb::Int32Grid, openvdb::Int64Grid,
openvdb::FloatGrid, openvdb::DoubleGrid>;
const openvdb::CoordBBox bbox{
openvdb::Coord{0,0,0}, openvdb::Coord{10,10,10}};
// Fill the grid if it is one of the allowed types.
myGridBasePtr->apply<AllowedGridTypes>(
[&bbox](auto& grid) { // C++14
using GridType = typename std::decay<decltype(grid)>::type;
grid.fill(bbox, typename GridType::ValueType(1));
}
);

See also: TypeList

bool apply ( OpT & op )

inlineinherited

If this grid resolves to one of the listed grid types, invoke the given functor on the resolved grid.

Returns: false if this grid's type is not one of the listed types

Example:: using AllowedGridTypes = openvdb::TypeList<
openvdb::Int32Grid, openvdb::Int64Grid,
openvdb::FloatGrid, openvdb::DoubleGrid>;
const openvdb::CoordBBox bbox{
openvdb::Coord{0,0,0}, openvdb::Coord{10,10,10}};
// Fill the grid if it is one of the allowed types.
myGridBasePtr->apply<AllowedGridTypes>(
[&bbox](auto& grid) { // C++14
using GridType = typename std::decay<decltype(grid)>::type;
grid.fill(bbox, typename GridType::ValueType(1));
}
);

See also: TypeList

bool apply ( const OpT & op ) const

inlineinherited

If this grid resolves to one of the listed grid types, invoke the given functor on the resolved grid.

Returns: false if this grid's type is not one of the listed types

Example:: using AllowedGridTypes = openvdb::TypeList<
openvdb::Int32Grid, openvdb::Int64Grid,
openvdb::FloatGrid, openvdb::DoubleGrid>;
const openvdb::CoordBBox bbox{
openvdb::Coord{0,0,0}, openvdb::Coord{10,10,10}};
// Fill the grid if it is one of the allowed types.
myGridBasePtr->apply<AllowedGridTypes>(
[&bbox](auto& grid) { // C++14
using GridType = typename std::decay<decltype(grid)>::type;
grid.fill(bbox, typename GridType::ValueType(1));
}
);

See also: TypeList

bool apply ( const OpT & op )

inlineinherited

If this grid resolves to one of the listed grid types, invoke the given functor on the resolved grid.

Returns: false if this grid's type is not one of the listed types

Example:: using AllowedGridTypes = openvdb::TypeList<
openvdb::Int32Grid, openvdb::Int64Grid,
openvdb::FloatGrid, openvdb::DoubleGrid>;
const openvdb::CoordBBox bbox{
openvdb::Coord{0,0,0}, openvdb::Coord{10,10,10}};
// Fill the grid if it is one of the allowed types.
myGridBasePtr->apply<AllowedGridTypes>(
[&bbox](auto& grid) { // C++14
using GridType = typename std::decay<decltype(grid)>::type;
grid.fill(bbox, typename GridType::ValueType(1));
}
);

See also: TypeList

const ValueType& background ( ) const

inline

Return this grid's background value.

Note: Use tools::changeBackground to efficiently modify the background value.

TreeBase& baseTree ( )

inlineinherited

Return a reference to this grid's tree, which might be shared with other grids.

Note: Calling setTree on this grid invalidates all references previously returned by this method.

const TreeBase& baseTree ( ) const

inlineinherited

Return a reference to this grid's tree, which might be shared with other grids.

Note: Calling setTree on this grid invalidates all references previously returned by this method.

TreeBase::Ptr baseTreePtr ( )

inlineinherited

Return a pointer to this grid's tree, which might be shared with other grids. The pointer is guaranteed to be non-null.

TreeBase::ConstPtr baseTreePtr ( ) const

inlineinherited

Return a pointer to this grid's tree, which might be shared with other grids. The pointer is guaranteed to be non-null.

MetaIterator beginMeta ( )

inlineinherited

ConstMetaIterator beginMeta ( ) const

inlineinherited

ValueAllIter beginValueAll ( )

inline

Return an iterator over all of this grid's values (tile and voxel).

ValueAllCIter beginValueAll ( ) const

inline

Return an iterator over all of this grid's values (tile and voxel).

ValueOffIter beginValueOff ( )

inline

Return an iterator over all of this grid's inactive values (tile and voxel).

ValueOffCIter beginValueOff ( ) const

inline

Return an iterator over all of this grid's inactive values (tile and voxel).

ValueOnIter beginValueOn ( )

inline

Return an iterator over all of this grid's active values (tile and voxel).

ValueOnCIter beginValueOn ( ) const

inline

Return an iterator over all of this grid's active values (tile and voxel).

ValueAllCIter cbeginValueAll ( ) const

inline

Return an iterator over all of this grid's values (tile and voxel).

ValueOffCIter cbeginValueOff ( ) const

inline

Return an iterator over all of this grid's inactive values (tile and voxel).

ValueOnCIter cbeginValueOn ( ) const

inline

Return an iterator over all of this grid's active values (tile and voxel).

void clear ( )

inlineoverridevirtual

Empty this grid, so that all voxels become inactive background voxels.

Implements GridBase.

void clearGridClass ( )

inherited

Remove the setting specifying the class of this grid's volumetric data.

void clearMetadata ( )

inlineinherited

static void clearRegistry ( )

staticinherited

Clear the grid type registry.

void clearVectorType ( )

inherited

Remove the setting specifying the type of vector data stored in this grid.

void clip ( const CoordBBox & bbox )

inlineoverridevirtual

Clip this grid to the given index-space bounding box.

Voxels that lie outside the bounding box are set to the background.

Warning: Clipping a level set will likely produce a grid that is no longer a valid level set.

Implements GridBase.

void clipGrid ( const BBoxd & )

inherited

Clip this grid to the given world-space bounding box.

Voxels that lie outside the bounding box are set to the background.

Warning: Clipping a level set will likely produce a grid that is no longer a valid level set.

const TreeBase& constBaseTree ( ) const

inlineinherited

Return a reference to this grid's tree, which might be shared with other grids.

Note: Calling setTree on this grid invalidates all references previously returned by this method.

TreeBase::ConstPtr constBaseTreePtr ( ) const

inlineoverridevirtual

Return a pointer to this grid's tree, which might be shared with other grids. The pointer is guaranteed to be non-null.

Implements GridBase.

GridType::ConstPtr constGrid ( const GridBase::Ptr & grid )

inlinestaticinherited

Return the result of downcasting a GridBase pointer to a Grid pointer of the specified type, or return a null pointer if the types are incompatible.

GridType::ConstPtr constGrid ( const GridBase::ConstPtr & grid )

inlinestaticinherited

Return the result of downcasting a GridBase pointer to a Grid pointer of the specified type, or return a null pointer if the types are incompatible.

const math::Transform& constTransform ( ) const

inlineinherited

Return a reference to this grid's transform, which might be shared with other grids.

Note: Calling setTransform on this grid invalidates all references previously returned by this method.

math::Transform::ConstPtr constTransformPtr ( ) const

inlineinherited

Return a pointer to this grid's transform, which might be shared with other grids.

const TreeType& constTree ( ) const

inline

Return a reference to this grid's tree, which might be shared with other grids.

Note: Calling setTree() on this grid invalidates all references previously returned by this method.

ConstTreePtrType constTreePtr ( ) const

inline

Return a pointer to this grid's tree, which might be shared with other grids. The pointer is guaranteed to be non-null.

Grid< TreeT >::Ptr copy ( )

inline

Return a new grid of the same type as this grid whose metadata and transform are deep copies of this grid's and whose tree is shared with this grid.

Grid< TreeT >::ConstPtr copy ( ) const

inline

Return a new grid of the same type as this grid whose metadata and transform are deep copies of this grid's and whose tree is shared with this grid.

GridBase::Ptr copyGrid ( )

inlineoverridevirtual

Return a new grid of the same type as this grid whose metadata is a deep copy of this grid's and whose tree and transform are shared with this grid.

Implements GridBase.

GridBase::ConstPtr copyGrid ( ) const

inlineoverridevirtual

Return a new grid of the same type as this grid whose metadata is a deep copy of this grid's and whose tree and transform are shared with this grid.

Implements GridBase.

GridBase::ConstPtr copyGridReplacingMetadata ( const MetaMap & meta ) const

inlineoverridevirtual

Return a new grid of the same type as this grid whose tree and transform is shared with this grid and whose metadata is provided as an argument.

Implements GridBase.

GridBase::ConstPtr copyGridReplacingMetadataAndTransform	(	const MetaMap &	meta,
		math::Transform::Ptr	xform
	)		const

inlineoverridevirtual

Return a new grid of the same type as this grid whose tree is shared with this grid and whose transform and metadata are provided as arguments.

Exceptions

ValueError if the transform pointer is null

Implements GridBase.

GridBase::ConstPtr copyGridReplacingTransform ( math::Transform::Ptr xform ) const

inlineoverridevirtual

Return a new grid of the same type as this grid whose tree is shared with this grid, whose metadata is a deep copy of this grid's and whose transform is provided as an argument.

Exceptions

ValueError if the transform pointer is null

Implements GridBase.

GridBase::Ptr copyGridWithNewTree ( ) const

inlineoverridevirtual

Return a new grid of the same type as this grid whose metadata and transform are deep copies of this grid's and whose tree is default-constructed.

Implements GridBase.

MetaMap::Ptr copyMeta ( ) const

inherited

Return a copy of this map whose fields are shared with this map.

Grid< TreeT >::ConstPtr copyReplacingMetadata ( const MetaMap & meta ) const

inline

Return a new grid of the same type as this grid whose tree and transform is shared with this grid and whose metadata is provided as an argument.

Grid< TreeT >::ConstPtr copyReplacingMetadataAndTransform	(	const MetaMap &	meta,
		math::Transform::Ptr	xform
	)		const

inline

Return a new grid of the same type as this grid whose tree is shared with this grid and whose transform and metadata are provided as arguments.

Exceptions

ValueError if the transform pointer is null

Grid< TreeT >::ConstPtr copyReplacingTransform ( math::Transform::Ptr xform ) const

inline

Return a new grid of the same type as this grid whose tree is shared with this grid, whose metadata is a deep copy of this grid's and whose transform is provided as an argument.

Exceptions

ValueError if the transform pointer is null

Grid< TreeT >::Ptr copyWithNewTree ( ) const

inline

Return a new grid of the same type as this grid whose metadata and transform are deep copies of this grid's and whose tree is default-constructed.

Grid< TreeT >::Ptr create ( const ValueType & background )

inlinestatic

Return a new grid with the given background value.

Grid< TreeT >::Ptr create ( )

inlinestatic

Return a new grid with background value zero.

Grid< TreeT >::Ptr create ( TreePtrType tree )

inlinestatic

Return a new grid that contains the given tree.

Exceptions

ValueError if the tree pointer is null

Grid< TreeT >::Ptr create ( const GridBase & other )

inlinestatic

Return a new, empty grid with the same transform and metadata as the given grid and with background value zero.

static Ptr createGrid ( const Name & type )

staticinherited

Create a new grid of the given (registered) type.

Ptr deepCopy ( ) const

inline

Return a new grid whose metadata, transform and tree are deep copies of this grid's.

GridBase::Ptr deepCopyGrid ( ) const

inlineoverridevirtual

Return a new grid whose metadata, transform and tree are deep copies of this grid's.

Implements GridBase.

MetaMap::Ptr deepCopyMeta ( ) const

inherited

Return a deep copy of this map that shares no data with this map.

void denseFill	(	const CoordBBox &	bbox,
		const ValueType &	value,
		bool	active = `true`
	)

inline

Set all voxels within a given axis-aligned box to a constant value and ensure that those voxels are all represented at the leaf level.

Parameters

bbox	inclusive coordinates of opposite corners of an axis-aligned box.
value	the value to which to set voxels within the box.
active	if true, mark voxels within the box as active, otherwise mark them as inactive.

bool empty ( ) const

inlineoverridevirtual

Return true if this grid contains only inactive background voxels.

Implements GridBase.

MetaIterator endMeta ( )

inlineinherited

ConstMetaIterator endMeta ( ) const

inlineinherited

CoordBBox evalActiveVoxelBoundingBox ( ) const

inlineoverridevirtual

Return the axis-aligned bounding box of all active voxels.

Implements GridBase.

Coord evalActiveVoxelDim ( ) const

inlineoverridevirtual

Return the dimensions of the axis-aligned bounding box of all active voxels.

Implements GridBase.

void evalMinMax	(	ValueType &	minVal,
		ValueType &	maxVal
	)		const

inline

Return the minimum and maximum active values in this grid.

Deprecated:: "Switch from grid->evalMinMax(minVal, maxVal) to \tools::minMax(grid->tree()). Use threaded = false for serial execution"

void fill	(	const CoordBBox &	bbox,
		const ValueType &	value,
		bool	active = `true`
	)

inline

Set all voxels within a given axis-aligned box to a constant value.

Parameters

bbox	inclusive coordinates of opposite corners of an axis-aligned box
value	the value to which to set voxels within the box
active	if true, mark voxels within the box as active, otherwise mark them as inactive

Note: This operation generates a sparse, but not always optimally sparse, representation of the filled box. Follow fill operations with a prune() operation for optimal sparseness.

Accessor getAccessor ( )

inline

Return an accessor that provides random read and write access to this grid's voxels.

The accessor is safe in the sense that it is registered with this grid's tree.

ConstAccessor getAccessor ( ) const

inline

Return an accessor that provides random read-only access to this grid's voxels.

ConstAccessor getConstAccessor ( ) const

inline

Return an accessor that provides random read-only access to this grid's voxels.

ConstUnsafeAccessor getConstUnsafeAccessor ( ) const

inline

Return an unsafe accessor that provides random read-only access to this grid's voxels.

The accessor is unsafe in the sense that it is not registered with this grid's tree. In some rare cases this can give a performance advantage over a registered accessor, but it is unsafe if the tree topology is modified.

Warning: Only use this method if you're an expert and know the risks of using an unregistered accessor (see tree/ValueAccessor.h)

std::string getCreator ( ) const

inherited

Return the user-specified description of this grid's creator.

GridClass getGridClass ( ) const

inherited

Return the class of volumetric data (level set, fog volume, etc.) that is stored in this grid.

See also: gridClassToString, gridClassToMenuName, stringToGridClass

T::Ptr getMetadata ( const Name & name )

inlineinherited

Return a pointer to a TypedMetadata object of type T and with the given name. If no such field exists or if there is a type mismatch, return a null pointer.

T::ConstPtr getMetadata ( const Name & name ) const

inlineinherited

Return a pointer to a TypedMetadata object of type T and with the given name. If no such field exists or if there is a type mismatch, return a null pointer.

std::string getName ( ) const

inherited

Return this grid's user-specified name.

MetaMap::Ptr getStatsMetadata ( ) const

inherited

Return a new MetaMap containing just the metadata that was added to this grid with addStatsMetadata.

If addStatsMetadata was never called on this grid, return an empty MetaMap.

UnsafeAccessor getUnsafeAccessor ( )

inline

Return an unsafe accessor that provides random read and write access to this grid's voxels.

The accessor is unsafe in the sense that it is not registered with this grid's tree. In some rare cases this can give a performance advantage over a registered accessor, but it is unsafe if the tree topology is modified.

Warning: Only use this method if you're an expert and know the risks of using an unregistered accessor (see tree/ValueAccessor.h)

VecType getVectorType ( ) const

inherited

Return the type of vector data (invariant, covariant, etc.) stored in this grid, assuming that this grid contains a vector-valued tree.

See also: vecTypeToString, vecTypeExamples, vecTypeDescription, stringToVecType

GridType::Ptr grid ( const GridBase::Ptr & grid )

inlinestaticinherited

Return the result of downcasting a GridBase pointer to a Grid pointer of the specified type, or return a null pointer if the types are incompatible.

GridType::ConstPtr grid ( const GridBase::ConstPtr & grid )

inlinestaticinherited

Return the result of downcasting a GridBase pointer to a Grid pointer of the specified type, or return a null pointer if the types are incompatible.

static std::string gridClassToMenuName ( GridClass )

staticinherited

Return a formatted string version of the grid class.

static std::string gridClassToString ( GridClass )

staticinherited

Return the metadata string value for the given class of volumetric data.

static Name gridType ( )

inlinestatic

Return the name of this type of grid.

bool hasMultiPassIO ( )

inlinestatic

Return true if grids of this type require multiple I/O passes to read and write data buffers.

See also: HasMultiPassIO

bool hasUniformVoxels ( ) const

inlineinherited

Return true if the voxels in world space are uniformly sized cubes.

Vec3d indexToWorld ( const Vec3d & xyz ) const

inlineinherited

Apply this grid's transform to the given coordinates.

Vec3d indexToWorld ( const Coord & ijk ) const

inlineinherited

Apply this grid's transform to the given coordinates.

void insertMeta	(	const Name &	,
		const Metadata &	value
	)

inherited

Insert a new metadata field or overwrite the value of an existing field.

If a field with the given name doesn't already exist, add a new field. Otherwise, if the new value's type is the same as the existing field's value type, overwrite the existing value with new value.

Exceptions

TypeError	if a field with the given name already exists, but its value type is not the same as the new value's
ValueError	if the given field name is empty.

void insertMeta ( const MetaMap & )

inherited

Deep copy all of the metadata fields from the given map into this map.

Exceptions

TypeError if any field in the given map has the same name as but a different value type than one of this map's fields.

bool isInWorldSpace ( ) const

inherited

Return true if this grid's voxel values are in world space and should be affected by transformations, false if they are in local space and should not be affected by transformations.

static bool isRegistered ( const Name & type )

staticinherited

Return true if the given grid type name is registered.

static bool isRegistered ( )

inlinestatic

Return true if this grid type is registered.

bool isTreeUnique ( ) const

inlinefinalvirtual

Return true if tree is not shared with another grid.

Note: This is a virtual function with ABI=8

Implements GridBase.

bool isType ( ) const

inlineinherited

Return true if this grid is of the same type as the template parameter.

Index64 memUsage ( ) const

inlineoverridevirtual

Return the number of bytes of memory used by this grid.

Implements GridBase.

void merge	(	Grid< _TreeType > &	other,
		MergePolicy	policy = `MERGE_ACTIVE_STATES`
	)

inline

Efficiently merge another grid into this grid using one of several schemes.

This operation is primarily intended to combine grids that are mostly non-overlapping (for example, intermediate grids from computations that are parallelized across disjoint regions of space).

Warning: This operation always empties the other grid.

size_t metaCount ( ) const

inlineinherited

T & metaValue ( const Name & name )

inlineinherited

Return a reference to the value of type T stored in the given metadata field.

Exceptions

LookupError	if no field with the given name exists.
TypeError	if the given field is not of type `T`.

const T & metaValue ( const Name & name ) const

inlineinherited

void newTree ( )

inlineoverridevirtual

Associate a new, empty tree with this grid, in place of its existing tree.

Note: The new tree has the same background value as the existing tree.

Implements GridBase.

bool operator!= ( const MetaMap & other ) const

inlineinherited

Return true if the given map is different from this map.

Grid& operator= ( const Grid< _TreeType > & )

delete

Disallow assignment, since it wouldn't be obvious whether the copy is deep or shallow.

bool operator== ( const MetaMap & other ) const

inherited

Return true if the given map is equivalent to this map.

Metadata::Ptr operator[] ( const Name & name )

inlineinherited

Return a pointer to the metadata with the given name. If no such field exists, return a null pointer.

Metadata::ConstPtr operator[] ( const Name & name ) const

inlineinherited

Return a pointer to the metadata with the given name. If no such field exists, return a null pointer.

void print	(	std::ostream &	os = `std::cout`,
		int	verboseLevel = `1`
	)		const

inlineoverridevirtual

Output a human-readable description of this grid.

Implements GridBase.

void pruneGrid ( float tolerance = 0.0 )

inlineoverridevirtual

Reduce the memory footprint of this grid by increasing its sparseness.

Implements GridBase.

void readBuffers ( std::istream & is )

inlineoverridevirtual

Read all data buffers for this grid.

Implements GridBase.

void readBuffers	(	std::istream &	is,
		const CoordBBox &	bbox
	)

inlineoverridevirtual

Read all of this grid's data buffers that intersect the given index-space bounding box.

Implements GridBase.

void readMeta ( std::istream & )

inherited

Unserialize metadata from the given stream.

void readNonresidentBuffers ( ) const

inlineoverridevirtual

Read all of this grid's data buffers that are not yet resident in memory (because delayed loading is in effect).

If this grid was read from a memory-mapped file, this operation disconnects the grid from the file.

See also: io::File::open, io::MappedFile

Implements GridBase.

void readTopology ( std::istream & is )

inlineoverridevirtual

Read the grid topology from a stream. This will read only the grid structure, not the actual data buffers.

Implements GridBase.

void readTransform ( std::istream & is )

inlineinherited

Read in the transform for this grid.

static void registerGrid	(	const Name &	type,
		GridFactory
	)

staticprotectedinherited

Register a grid type along with a factory function.

static void registerGrid ( )

inlinestatic

Register this grid type along with a factory function.

void removeMeta ( const Name & )

inherited

Remove the given metadata field if it exists.

bool saveFloatAsHalf ( ) const

inherited

Return true if this grid should be written out with floating-point voxel values (including components of vectors) quantized to 16 bits.

void setCreator ( const std::string & )

inherited

Provide a description of this grid's creator.

void setGridClass ( GridClass )

inherited

Specify the class of volumetric data (level set, fog volume, etc.) that is stored in this grid.

See also: gridClassToString, gridClassToMenuName, stringToGridClass

void setIsInWorldSpace ( bool )

inherited

Specify whether this grid's voxel values are in world space or in local space.

void setName ( const std::string & )

inherited

Specify a name for this grid.

void setSaveFloatAsHalf ( bool )

inherited

Return this grid's user-specified name.

void setTransform ( math::Transform::Ptr xform )

inlineinherited

Associate the given transform with this grid, in place of its existing transform.

Exceptions

ValueError if the transform pointer is null

Note: Invalidates all references previously returned by transform or Transform.

void setTree ( TreeBase::Ptr tree )

inlineoverridevirtual

Associate the given tree with this grid, in place of its existing tree.

Exceptions

ValueError	if the tree pointer is null
TypeError	if the tree is not of type TreeType

Note: Invalidates all references previously returned by baseTree(), constBaseTree(), tree() or constTree().

Implements GridBase.

void setVectorType ( VecType )

inherited

Specify the type of vector data (invariant, covariant, etc.) stored in this grid, assuming that this grid contains a vector-valued tree.

See also: vecTypeToString, vecTypeExamples, vecTypeDescription, stringToVecType

void sparseFill	(	const CoordBBox &	bbox,
		const ValueType &	value,
		bool	active = `true`
	)

inline

Set all voxels within a given axis-aligned box to a constant value.

Parameters

bbox	inclusive coordinates of opposite corners of an axis-aligned box
value	the value to which to set voxels within the box
active	if true, mark voxels within the box as active, otherwise mark them as inactive

Note: This operation generates a sparse, but not always optimally sparse, representation of the filled box. Follow fill operations with a prune() operation for optimal sparseness.

std::string str ( const std::string & indent = "" ) const

inherited

Return a string describing this metadata map. Prefix each line with indent.

static GridClass stringToGridClass ( const std::string & )

staticinherited

Return the class of volumetric data specified by the given string.

If the string is not one of the ones returned by gridClassToString, return GRID_UNKNOWN.

static VecType stringToVecType ( const std::string & )

staticinherited

void topologyDifference ( const Grid< OtherTreeType > & other )

inline

Difference this grid's set of active values with the active values of the other grid, whose value type may be different.

After this method is called, voxels in this grid will be active only if they were active to begin with and if the corresponding voxels in the other grid were inactive.

Note: This operation can delete branches of this grid that overlap with active tiles in the other grid. Also, because it can deactivate voxels, it can create leaf nodes with no active values. Thus, it is recommended to prune this grid after calling this method.

void topologyIntersection ( const Grid< OtherTreeType > & other )

inline

Intersect this grid's set of active values with the active values of the other grid, whose value type may be different.

The resulting state of a value is active only if the corresponding value was already active AND if it is active in the other tree. Also, a resulting value maps to a voxel if the corresponding value already mapped to an active voxel in either of the two grids and it maps to an active tile or voxel in the other grid.

Note: This operation can delete branches of this grid that overlap with inactive tiles in the other grid. Also, because it can deactivate voxels, it can create leaf nodes with no active values. Thus, it is recommended to prune this grid after calling this method.

void topologyUnion ( const Grid< OtherTreeType > & other )

inline

Union this grid's set of active values with the active values of the other grid, whose value type may be different.

The resulting state of a value is active if the corresponding value was already active OR if it is active in the other grid. Also, a resulting value maps to a voxel if the corresponding value already mapped to a voxel OR if it is a voxel in the other grid. Thus, a resulting value can only map to a tile if the corresponding value already mapped to a tile AND if it is a tile value in the other grid.

Note: This operation modifies only active states, not values. Specifically, active tiles and voxels in this grid are not changed, and tiles or voxels that were inactive in this grid but active in the other grid are marked as active in this grid but left with their original values.

math::Transform& transform ( )

inlineinherited

Return a reference to this grid's transform, which might be shared with other grids.

Note: Calling setTransform on this grid invalidates all references previously returned by this method.

const math::Transform& transform ( ) const

inlineinherited

Return a reference to this grid's transform, which might be shared with other grids.

Note: Calling setTransform on this grid invalidates all references previously returned by this method.

math::Transform::Ptr transformPtr ( )

inlineinherited

Return a pointer to this grid's transform, which might be shared with other grids.

math::Transform::ConstPtr transformPtr ( ) const

inlineinherited

Return a pointer to this grid's transform, which might be shared with other grids.

TreeType& tree ( )

inline

Return a reference to this grid's tree, which might be shared with other grids.

Note: Calling setTree() on this grid invalidates all references previously returned by this method.

const TreeType& tree ( ) const

inline

Return a reference to this grid's tree, which might be shared with other grids.

Note: Calling setTree() on this grid invalidates all references previously returned by this method.

TreePtrType treePtr ( )

inline

Return a pointer to this grid's tree, which might be shared with other grids. The pointer is guaranteed to be non-null.

ConstTreePtrType treePtr ( ) const

inline

Return a pointer to this grid's tree, which might be shared with other grids. The pointer is guaranteed to be non-null.

Name type ( ) const

inlineoverridevirtual

Return the name of this grid's type.

Implements GridBase.

static void unregisterGrid ( const Name & type )

staticprotectedinherited

Remove a grid type from the registry.

static void unregisterGrid ( )

inlinestatic

Remove this grid type from the registry.

Name valueType ( ) const

inlineoverridevirtual

Return the name of the type of a voxel's value (e.g., "float" or "vec3d").

Implements GridBase.

static std::string vecTypeDescription ( VecType )

staticinherited

Return a string describing how the given type of vector data is affected by transformations (e.g., "Does not transform", given VEC_INVARIANT).

static std::string vecTypeExamples ( VecType )

staticinherited

Return a string listing examples of the given type of vector data (e.g., "Gradient/Normal", given VEC_COVARIANT).

static std::string vecTypeToString ( VecType )

staticinherited

Return the metadata string value for the given type of vector data.

Vec3d voxelSize ( ) const

inlineinherited

Return the size of this grid's voxels.

Vec3d voxelSize ( const Vec3d & xyz ) const

inlineinherited

Return the size of this grid's voxel at position (x, y, z).

Note: Frustum and perspective transforms have position-dependent voxel size.

Vec3d worldToIndex ( const Vec3d & xyz ) const

inlineinherited

Apply the inverse of this grid's transform to the given coordinates.

void writeBuffers ( std::ostream & os ) const

inlineoverridevirtual

Write out all data buffers for this grid.

Implements GridBase.

void writeMeta ( std::ostream & ) const

inherited

Serialize metadata to the given stream.

void writeTopology ( std::ostream & os ) const

inlineoverridevirtual

Write the grid topology to a stream. This will write only the grid structure, not the actual data buffers.

Implements GridBase.

void writeTransform ( std::ostream & os ) const

inlineinherited

Write out the transform for this grid.

Member Data Documentation

const char* const META_FILE_BBOX_MAX

staticinherited

const char* const META_FILE_BBOX_MIN

staticinherited

const char* const META_FILE_COMPRESSION

staticinherited

const char* const META_FILE_DELAYED_LOAD

staticinherited

const char* const META_FILE_MEM_BYTES

staticinherited

const char* const META_FILE_VOXEL_COUNT

staticinherited

const char* const META_GRID_CLASS

staticinherited

const char* const META_GRID_CREATOR

staticinherited

const char* const META_GRID_NAME

staticinherited

const char* const META_IS_LOCAL_SPACE

staticinherited

const char* const META_SAVE_HALF_FLOAT

staticinherited

const char* const META_VECTOR_TYPE

staticinherited

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Static Protected Member Functions

Detailed Description

template<typename _TreeType> class openvdb::v12_0::Grid< _TreeType >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename _TreeType>
class openvdb::v12_0::Grid< _TreeType >