GridBase Class Reference

Abstract base class for typed grids. More...

#include <openvdb/Grid.h>

Inherits MetaMap.

Inherited by Grid< _TreeType >.

Public Types
using	Ptr = SharedPtr< GridBase >
using	ConstPtr = SharedPtr< const GridBase >
using	GridFactory) = Ptr(*)(
using	MetadataMap = std::map< Name, Metadata::Ptr >
using	MetaIterator = MetadataMap::iterator
using	ConstMetaIterator = MetadataMap::const_iterator

Public Member Functions
	~GridBase () override
virtual bool	empty () const =0
	Return true if this grid contains only background voxels. More...
virtual void	clear ()=0
	Empty this grid, setting all voxels to the background. 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
virtual GridBase::Ptr	copyGrid ()=0
	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...
virtual GridBase::ConstPtr	copyGrid () const =0
	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...
virtual GridBase::Ptr	copyGridWithNewTree () const =0
	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...
virtual GridBase::ConstPtr	copyGridReplacingMetadata (const MetaMap &meta) const =0
	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...
virtual GridBase::ConstPtr	copyGridReplacingTransform (math::Transform::Ptr xform) const =0
	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...
virtual GridBase::ConstPtr	copyGridReplacingMetadataAndTransform (const MetaMap &meta, math::Transform::Ptr xform) const =0
	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...
virtual GridBase::Ptr	deepCopyGrid () const =0
	Return a new grid whose metadata, transform and tree are deep copies of this grid's. More...
Type access
virtual Name	type () const =0
	Return the name of this grid's type. More...
virtual Name	valueType () const =0
	Return the name of the type of a voxel's value (e.g., "float" or "vec3d"). More...
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...
virtual TreeBase::ConstPtr	constBaseTreePtr () const =0
	Return a pointer to this grid's tree, which might be shared with other grids. The pointer is guaranteed to be non-null. More...
virtual bool	isTreeUnique () const =0
	Return true if tree is not shared with another grid. 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...
virtual void	setTree (TreeBase::Ptr)=0
	Associate the given tree with this grid, in place of its existing tree. More...
virtual void	newTree ()=0
	Set a new tree with the same background value as the previous tree. More...
Tools
virtual void	pruneGrid (float tolerance=0.0)=0
	Reduce the memory footprint of this grid by increasing its sparseness either losslessly (tolerance = 0) or lossily (tolerance > 0). More...
void	clipGrid (const BBoxd &)
	Clip this grid to the given world-space bounding box. More...
virtual void	clip (const CoordBBox &)=0
	Clip this grid to the given index-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
virtual Index64	activeVoxelCount () const =0
	Return the number of active voxels. More...
virtual CoordBBox	evalActiveVoxelBoundingBox () const =0
virtual Coord	evalActiveVoxelDim () const =0
	Return the dimensions of the axis-aligned bounding box of all active voxels. More...
virtual Index64	memUsage () const =0
	Return the number of bytes of memory used by this grid. More...
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
virtual void	readTopology (std::istream &)=0
	Read the grid topology from a stream. This will read only the grid structure, not the actual data buffers. More...
virtual void	writeTopology (std::ostream &) const =0
	Write the grid topology to a stream. This will write only the grid structure, not the actual data buffers. More...
virtual void	readBuffers (std::istream &)=0
	Read all data buffers for this grid. More...
virtual void	readBuffers (std::istream &, const CoordBBox &)=0
	Read all of this grid's data buffers that intersect the given index-space bounding box. More...
virtual void	readNonresidentBuffers () const =0
	Read all of this grid's data buffers that are not yet resident in memory (because delayed loading is in effect). More...
virtual void	writeBuffers (std::ostream &) const =0
	Write out all data buffers for this grid. More...
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...
virtual void	print (std::ostream &=std::cout, int verboseLevel=1) const =0
	Output a human-readable description of 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 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 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

Protected Member Functions
	GridBase ()
	Initialize with an identity linear transform. More...
	GridBase (const MetaMap &meta, math::Transform::Ptr xform)
	Initialize with metadata and a transform. More...
	GridBase (const GridBase &other)
	Deep copy another grid's metadata and transform. More...
	GridBase (GridBase &other, ShallowCopy)
	Copy another grid's metadata but share its transform. More...

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

Abstract base class for typed grids.

Member Typedef Documentation

using ConstMetaIterator = MetadataMap::const_iterator

inherited

using ConstPtr = SharedPtr<const GridBase>

using GridFactory = Ptr (*)(

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

inherited

using MetaIterator = MetadataMap::iterator

inherited

using Ptr = SharedPtr<GridBase>

Constructor & Destructor Documentation

~GridBase ( )

inlineoverride

GridBase ( )

inlineprotected

Initialize with an identity linear transform.

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

inlineprotected

Initialize with metadata and a transform.

Exceptions

ValueError

if the transform pointer is null

GridBase ( const GridBase &  other )

inlineprotected

Deep copy another grid's metadata and transform.

GridBase ( GridBase &  other, ShallowCopy    )

inlineprotected

Copy another grid's metadata but share its transform.

Member Function Documentation

virtual Index64 activeVoxelCount ( ) const

pure virtual

Return the number of active voxels.

Implemented in Grid< _TreeType >.

void addStatsMetadata

(

)

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

inline

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 )

inline

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

inline

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 )

inline

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

TreeBase& baseTree ( )

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 TreeBase& baseTree ( ) 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.

TreeBase::Ptr baseTreePtr ( )

inline

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

inline

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

virtual void clear ( )

pure virtual

Empty this grid, setting all voxels to the background.

Implemented in Grid< _TreeType >.

void clearGridClass

(

)

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

void clearMetadata ( )

inlineinherited

static void clearRegistry ( )

static

Clear the grid type registry.

void clearVectorType

(

)

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

virtual void clip ( const CoordBBox &  )

pure virtual

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.

Implemented in Grid< _TreeType >.

void clipGrid

(

const BBoxd &

)

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

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.

virtual TreeBase::ConstPtr constBaseTreePtr ( ) const

pure virtual

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

Implemented in Grid< _TreeType >.

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

inlinestatic

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 )

inlinestatic

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

inline

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

inline

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

virtual GridBase::Ptr copyGrid ( )

pure virtual

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.

Implemented in Grid< _TreeType >.

virtual GridBase::ConstPtr copyGrid ( ) const

pure virtual

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.

Implemented in Grid< _TreeType >.

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

pure virtual

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.

Implemented in Grid< _TreeType >.

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

pure virtual

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

Implemented in Grid< _TreeType >.

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

pure virtual

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

Implemented in Grid< _TreeType >.

virtual GridBase::Ptr copyGridWithNewTree ( ) const

pure virtual

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.

Implemented in Grid< _TreeType >.

MetaMap::Ptr copyMeta ( ) const

inherited

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

static Ptr createGrid ( const Name &  type )

static

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

virtual GridBase::Ptr deepCopyGrid ( ) const

pure virtual

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

Implemented in Grid< _TreeType >.

MetaMap::Ptr deepCopyMeta ( ) const

inherited

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

virtual bool empty ( ) const

pure virtual

Return true if this grid contains only background voxels.

Implemented in Grid< _TreeType >.

MetaIterator endMeta ( )

inlineinherited

ConstMetaIterator endMeta ( ) const

inlineinherited

virtual CoordBBox evalActiveVoxelBoundingBox ( ) const

pure virtual

Return the axis-aligned bounding box of all active voxels. If the grid is empty a default bbox is returned.

Implemented in Grid< _TreeType >.

virtual Coord evalActiveVoxelDim ( ) const

pure virtual

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

Implemented in Grid< _TreeType >.

std::string getCreator

(

)

const

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

GridClass getGridClass

(

)

const

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

Return this grid's user-specified name.

MetaMap::Ptr getStatsMetadata

(

)

const

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.

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.

See also

vecTypeToString, vecTypeExamples, vecTypeDescription, stringToVecType

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

inlinestatic

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 )

inlinestatic

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  )

static

Return a formatted string version of the grid class.

static std::string gridClassToString ( GridClass  )

static

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

bool hasUniformVoxels ( ) const

inline

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

Vec3d indexToWorld ( const Vec3d &  xyz ) const

inline

Apply this grid's transform to the given coordinates.

Vec3d indexToWorld ( const Coord &  ijk ) const

inline

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

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 )

static

Return true if the given grid type name is registered.

virtual bool isTreeUnique ( ) const

pure virtual

Return true if tree is not shared with another grid.

Implemented in Grid< _TreeType >.

bool isType ( ) const

inline

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

virtual Index64 memUsage ( ) const

pure virtual

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

Implemented in Grid< _TreeType >.

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

virtual void newTree ( )

pure virtual

Set a new tree with the same background value as the previous tree.

Implemented in Grid< _TreeType >.

bool operator!= ( const MetaMap &  other ) const

inlineinherited

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

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.

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

pure virtual

Output a human-readable description of this grid.

Implemented in Grid< _TreeType >.

virtual void pruneGrid ( float  tolerance = 0.0 )

pure virtual

Reduce the memory footprint of this grid by increasing its sparseness either losslessly (tolerance = 0) or lossily (tolerance > 0).

With tolerance > 0, sparsify regions where voxels have the same active state and have values that differ by no more than the tolerance (converted to this grid's value type).

Implemented in Grid< _TreeType >.

virtual void readBuffers ( std::istream &  )

pure virtual

Read all data buffers for this grid.

Implemented in Grid< _TreeType >.

virtual void readBuffers ( std::istream &  , const CoordBBox &    )

pure virtual

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

Implemented in Grid< _TreeType >.

void readMeta ( std::istream &  )

inherited

Unserialize metadata from the given stream.

virtual void readNonresidentBuffers ( ) const

pure virtual

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

Implemented in Grid< _TreeType >.

virtual void readTopology ( std::istream &  )

pure virtual

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

Implemented in Grid< _TreeType >.

void readTransform ( std::istream &  is )

inline

Read in the transform for this grid.

static void registerGrid ( const Name &  type, GridFactory    )

staticprotected

Register a grid type along with a factory function.

void removeMeta ( const Name &  )

inherited

Remove the given metadata field if it exists.

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.

void setCreator

(

const std::string &

)

Provide a description of this grid's creator.

void setGridClass

(

GridClass

)

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

)

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

void setName

(

const std::string &

)

Specify a name for this grid.

void setSaveFloatAsHalf

(

bool

)

Return this grid's user-specified name.

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

inline

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.

virtual void setTree ( TreeBase::Ptr  )

pure virtual

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 the appropriate type

Note

Invalidates all references previously returned by baseTree or BaseTree.

Implemented in Grid< _TreeType >.

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.

See also

vecTypeToString, vecTypeExamples, vecTypeDescription, stringToVecType

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 &  )

static

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 &  )

static

math::Transform& transform ( )

inline

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

inline

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 ( )

inline

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

math::Transform::ConstPtr transformPtr ( ) const

inline

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

virtual Name type ( ) const

pure virtual

Return the name of this grid's type.

Implemented in Grid< _TreeType >.

static void unregisterGrid ( const Name &  type )

staticprotected

Remove a grid type from the registry.

virtual Name valueType ( ) const

pure virtual

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

Implemented in Grid< _TreeType >.

static std::string vecTypeDescription ( VecType  )

static

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  )

static

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

static std::string vecTypeToString ( VecType  )

static

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

Vec3d voxelSize ( ) const

inline

Return the size of this grid's voxels.

Vec3d voxelSize ( const Vec3d &  xyz ) const

inline

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

inline

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

virtual void writeBuffers ( std::ostream &  ) const

pure virtual

Write out all data buffers for this grid.

Implemented in Grid< _TreeType >.

void writeMeta ( std::ostream &  ) const

inherited

Serialize metadata to the given stream.

virtual void writeTopology ( std::ostream &  ) const

pure virtual

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

Implemented in Grid< _TreeType >.

void writeTransform ( std::ostream &  os ) const

inline

Write out the transform for this grid.

Member Data Documentation

const char* const META_FILE_BBOX_MAX

static

const char* const META_FILE_BBOX_MIN

static

const char* const META_FILE_COMPRESSION

static

const char* const META_FILE_DELAYED_LOAD

static

const char* const META_FILE_MEM_BYTES

static

const char* const META_FILE_VOXEL_COUNT

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_IS_LOCAL_SPACE

static

const char* const META_SAVE_HALF_FLOAT

static

const char* const META_VECTOR_TYPE

static