OpenVDB
2.0.0
|
Grid serializer/unserializer. More...
#include <Archive.h>
Inherited by File, and Stream.
Public Member Functions | |
Archive () | |
virtual | ~Archive () |
std::string | getUniqueTag () const |
Return the UUID that was most recently written (or read, if no UUID has been written yet). More... | |
bool | isIdentical (const std::string &uuidStr) const |
Return true if the given UUID matches this archive's UUID. More... | |
uint32_t | fileVersion () const |
Return the file format version number of the input stream. More... | |
VersionId | libraryVersion () const |
Return the (major, minor) version number of the library that was used to write the input stream. More... | |
std::string | version () const |
Return a string of the form "<major>.<minor>/<format>", giving the library and file format version numbers associated with the input stream. More... | |
bool | isInstancingEnabled () const |
Return true if trees shared by multiple grids are written out only once, false if they are written out once per grid. More... | |
void | setInstancingEnabled (bool b) |
Specify whether trees shared by multiple grids should be written out only once (true ) or once per grid (false ). More... | |
bool | isCompressionEnabled () const |
Return true if the data stream is Zip-compressed. More... | |
void | setCompressionEnabled (bool) |
Specify whether the data stream should be Zip-compressed. More... | |
uint32_t | compressionFlags () const |
Return a bit mask specifying compression options for the data stream. More... | |
void | setCompressionFlags (uint32_t c) |
Specify whether and how the data stream should be compressed. [Mainly for internal use]. More... | |
bool | isGridStatsMetadataEnabled () const |
Return true if grid statistics (active voxel count and bounding box, etc.) are computed and written as grid metadata. More... | |
void | setGridStatsMetadataEnabled (bool b) |
Specify whether grid statistics (active voxel count and bounding box, etc.) should be computed and written as grid metadata. More... | |
Static Public Attributes | |
static const uint32_t | DEFAULT_COMPRESSION_FLAGS |
Protected Types | |
typedef std::map< Name, GridBase::Ptr > | NamedGridMap |
Protected Member Functions | |
bool | inputHasGridOffsets () const |
Return true if the input stream contains grid offsets that allow for random access or partial reading. More... | |
void | setInputHasGridOffsets (bool b) |
void | setFormatVersion (std::istream &) |
Tag the given input stream with the input file format version number. More... | |
void | setLibraryVersion (std::istream &) |
Tag the given input stream with the version number of the library with which the input stream was created. More... | |
void | setDataCompression (std::istream &) |
Tag the given input stream with flags indicating whether the input stream contains compressed data and how it is compressed. More... | |
void | setGridCompression (std::ostream &, const GridBase &) const |
Tag an output stream with flags specifying only those compression options that are applicable to the given grid. More... | |
void | setWriteGridStatsMetadata (std::ostream &) |
Tag the given output stream with a flag indicating whether to compute and write grid statistics metadata. More... | |
void | connectInstance (const GridDescriptor &, const NamedGridMap &) const |
If the grid represented by the given grid descriptor is an instance, connect it with its instance parent. More... | |
void | writeGrid (GridDescriptor &, GridBase::ConstPtr, std::ostream &, bool seekable) const |
void | writeGridInstance (GridDescriptor &, GridBase::ConstPtr, std::ostream &, bool seekable) const |
bool | readHeader (std::istream &) |
Read the magic number, version numbers, UUID, etc. from the given input stream. More... | |
void | writeHeader (std::ostream &, bool seekable) const |
Write the magic number, version numbers, UUID, etc. to the given output stream. More... | |
void | write (std::ostream &, const GridPtrVec &, bool seekable, const MetaMap &=MetaMap()) const |
Write the given grids to an output stream. More... | |
void | write (std::ostream &, const GridCPtrVec &, bool seekable, const MetaMap &=MetaMap()) const |
Write the given grids to an output stream. More... | |
Static Protected Member Functions | |
static void | readGridCompression (std::istream &) |
Read in the compression flags for a grid and tag the given input stream with those flags. More... | |
static int32_t | readGridCount (std::istream &) |
Read in and return the number of grids on the input stream. More... | |
static void | readGrid (GridBase::Ptr, const GridDescriptor &, std::istream &) |
Populate the given grid from the input stream. More... | |
Friends | |
class | ::TestFile |
Grid serializer/unserializer.
|
protected |
Archive | ( | ) |
|
virtual |
|
inline |
Return a bit mask specifying compression options for the data stream.
|
protected |
If the grid represented by the given grid descriptor is an instance, connect it with its instance parent.
|
inline |
Return the file format version number of the input stream.
std::string getUniqueTag | ( | ) | const |
Return the UUID that was most recently written (or read, if no UUID has been written yet).
|
inlineprotected |
Return true
if the input stream contains grid offsets that allow for random access or partial reading.
bool isCompressionEnabled | ( | ) | const |
Return true
if the data stream is Zip-compressed.
|
inline |
Return true
if grid statistics (active voxel count and bounding box, etc.) are computed and written as grid metadata.
bool isIdentical | ( | const std::string & | uuidStr | ) | const |
Return true
if the given UUID matches this archive's UUID.
|
inline |
Return true
if trees shared by multiple grids are written out only once, false
if they are written out once per grid.
|
inline |
Return the (major, minor) version number of the library that was used to write the input stream.
|
staticprotected |
Populate the given grid from the input stream.
|
staticprotected |
Read in the compression flags for a grid and tag the given input stream with those flags.
|
staticprotected |
Read in and return the number of grids on the input stream.
|
protected |
Read the magic number, version numbers, UUID, etc. from the given input stream.
true
if the input UUID differs from the previously-read UUID. void setCompressionEnabled | ( | bool | ) |
Specify whether the data stream should be Zip-compressed.
Enabling Zip compression makes I/O slower, but saves space. Disable it only if raw I/O speed is a concern.
|
inline |
Specify whether and how the data stream should be compressed. [Mainly for internal use].
c | bitwise OR (e.g., COMPRESS_ZIP | COMPRESS_ACTIVE_MASK) of compression option flags (see Compression.h for the available flags) |
|
protected |
Tag the given input stream with flags indicating whether the input stream contains compressed data and how it is compressed.
|
protected |
Tag the given input stream with the input file format version number.
The tag can be retrieved with getFormatVersion().
|
protected |
Tag an output stream with flags specifying only those compression options that are applicable to the given grid.
|
inline |
Specify whether grid statistics (active voxel count and bounding box, etc.) should be computed and written as grid metadata.
|
inlineprotected |
|
inline |
Specify whether trees shared by multiple grids should be written out only once (true
) or once per grid (false
).
|
protected |
Tag the given input stream with the version number of the library with which the input stream was created.
The tag can be retrieved with getLibraryVersion().
|
protected |
Tag the given output stream with a flag indicating whether to compute and write grid statistics metadata.
std::string version | ( | ) | const |
Return a string of the form "<major>.<minor>/<format>", giving the library and file format version numbers associated with the input stream.
|
protected |
Write the given grids to an output stream.
|
protected |
Write the given grids to an output stream.
|
protected |
Write the given grid descriptor and grid to an output stream and update the GridDescriptor offsets.
seekable | if true, the output stream supports seek operations |
|
protected |
Write the given grid descriptor and grid metadata to an output stream and update the GridDescriptor offsets, but don't write the grid's tree, since it is shared with another grid.
seekable | if true, the output stream supports seek operations |
|
protected |
Write the magic number, version numbers, UUID, etc. to the given output stream.
seekable | if true, the output stream supports seek operations |
|
friend |
|
static |