openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata Class Reference

Container for metadata describing how to unserialize grids from and/or serialize grids to a stream (which file format, compression scheme, etc. to use) More...

#include <io.h>

Public Types
using	Ptr = SharedPtr< StreamMetadata >
using	ConstPtr = SharedPtr< const StreamMetadata >
using	AuxDataMap = std::map< std::string, std::any >

Public Member Functions
	StreamMetadata ()
	StreamMetadata (const StreamMetadata &)
	StreamMetadata (std::ios_base &)
	~StreamMetadata ()
StreamMetadata &	operator= (const StreamMetadata &)
void	transferTo (std::ios_base &) const
	Transfer metadata items directly to the given stream. More...
uint32_t	fileVersion () const
void	setFileVersion (uint32_t)
VersionId	libraryVersion () const
void	setLibraryVersion (VersionId)
uint32_t	compression () const
void	setCompression (uint32_t)
uint32_t	gridClass () const
void	setGridClass (uint32_t)
const void *	backgroundPtr () const
void	setBackgroundPtr (const void *)
bool	halfFloat () const
void	setHalfFloat (bool)
bool	writeGridStats () const
void	setWriteGridStats (bool)
bool	seekable () const
void	setSeekable (bool)
bool	delayedLoadMeta () const
bool	countingPasses () const
void	setCountingPasses (bool)
uint32_t	pass () const
void	setPass (uint32_t)
uint64_t	leaf () const
void	setLeaf (uint64_t)
std::string	str () const
	Return a string describing this stream metadata. More...
MetaMap &	gridMetadata ()
	Return a (reference to a) copy of the metadata of the grid currently being read or written. More...
const MetaMap &	gridMetadata () const
	Return a (reference to a) copy of the metadata of the grid currently being read or written. More...
AuxDataMap &	auxData ()
	Return a map that can be populated with arbitrary user data. More...
const AuxDataMap &	auxData () const
	Return a map that can be populated with arbitrary user data. More...

Detailed Description

Container for metadata describing how to unserialize grids from and/or serialize grids to a stream (which file format, compression scheme, etc. to use)

This class is mainly for internal use.

Definition at line 30 of file io.h.

Member Typedef Documentation

using openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::AuxDataMap = std::map<std::string, std::any>

Definition at line 92 of file io.h.

using openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::ConstPtr = SharedPtr<const StreamMetadata>

Definition at line 34 of file io.h.

using openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::Ptr = SharedPtr<StreamMetadata>

Definition at line 33 of file io.h.

Constructor & Destructor Documentation

openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::StreamMetadata

(

)

openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::StreamMetadata

(

const StreamMetadata &

)

openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::StreamMetadata ( std::ios_base &  )

explicit

openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::~StreamMetadata

(

)

Member Function Documentation

AuxDataMap& openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::auxData

(

)

Return a map that can be populated with arbitrary user data.

const AuxDataMap& openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::auxData

(

)

const

Return a map that can be populated with arbitrary user data.

const void* openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::backgroundPtr

(

)

const

uint32_t openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::compression

(

)

const

bool openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::countingPasses

(

)

const

bool openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::delayedLoadMeta

(

)

const

uint32_t openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::fileVersion

(

)

const

uint32_t openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::gridClass

(

)

const

MetaMap& openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::gridMetadata

(

)

Return a (reference to a) copy of the metadata of the grid currently being read or written.

Some grid metadata might duplicate information returned by gridClass(), backgroundPtr() and other accessors, but those values are not guaranteed to be kept in sync.

const MetaMap& openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::gridMetadata

(

)

const

Return a (reference to a) copy of the metadata of the grid currently being read or written.

Some grid metadata might duplicate information returned by gridClass(), backgroundPtr() and other accessors, but those values are not guaranteed to be kept in sync.

bool openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::halfFloat

(

)

const

uint64_t openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::leaf

(

)

const

VersionId openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::libraryVersion

(

)

const

StreamMetadata& openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::operator=

(

const StreamMetadata &

)

uint32_t openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::pass

(

)

const

bool openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::seekable

(

)

const

void openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::setBackgroundPtr

(

const void *

)

void openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::setCompression

(

uint32_t

)

void openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::setCountingPasses

(

bool

)

void openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::setFileVersion

(

uint32_t

)

void openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::setGridClass

(

uint32_t

)

void openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::setHalfFloat

(

bool

)

void openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::setLeaf

(

uint64_t

)

void openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::setLibraryVersion

(

VersionId

)

void openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::setPass

(

uint32_t

)

void openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::setSeekable

(

bool

)

void openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::setWriteGridStats

(

bool

)

std::string openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::str

(

)

const

Return a string describing this stream metadata.

void openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::transferTo

(

std::ios_base &

)

const

Transfer metadata items directly to the given stream.

Todo:

Deprecate direct transfer; use StreamMetadata structs everywhere.

bool openvdb::OPENVDB_VERSION_NAME::io::StreamMetadata::writeGridStats

(

)

const

---

The documentation for this class was generated from the following file:

• openvdb/io/io.h