Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS Namespace Reference

Namespaces
namespace	IllustrationOnly
Classes
class	ArchiveReader
class	ArchiveWriter
class	ArrayPropertyReader
class	ArrayPropertyWriter
class	ArraySample
struct	TArrayDeleter
struct	ArraySampleKey
struct	ArraySampleKeyEqualTo
struct	ArraySampleKeyStdHash
struct	UnorderedMapUtil
class	BasePropertyReader
	Base Property Reader. More...
class	BasePropertyWriter
class	CompoundPropertyReader
class	CompoundPropertyWriter
class	DataType
class	MetaData
class	ObjectHeader
class	ObjectReader
class	ObjectWriter
class	PropertyHeader
class	ReadArraySampleID
class	ReadArraySampleCache
class	ScalarPropertyReader
class	ScalarPropertyWriter
class	ScalarSample
class	TimeSampling
class	TimeSamplingType
Typedefs
typedef boost::shared_ptr < ArraySample >	ArraySamplePtr
typedef boost::unordered_set < ArraySampleKey, ArraySampleKeyStdHash, ArraySampleKeyEqualTo >	UnorderedArraySampleKeySet
typedef boost::shared_ptr < ArchiveWriter >	ArchiveWriterPtr
typedef boost::shared_ptr < ObjectWriter >	ObjectWriterPtr
typedef boost::shared_ptr < CompoundPropertyWriter >	CompoundPropertyWriterPtr
typedef boost::shared_ptr < ArrayPropertyWriter >	ArrayPropertyWriterPtr
typedef boost::shared_ptr < ScalarPropertyWriter >	ScalarPropertyWriterPtr
typedef boost::shared_ptr < BasePropertyWriter >	BasePropertyWriterPtr
typedef boost::shared_ptr < ArchiveReader >	ArchiveReaderPtr
typedef boost::shared_ptr < ObjectReader >	ObjectReaderPtr
typedef boost::shared_ptr < CompoundPropertyReader >	CompoundPropertyReaderPtr
typedef boost::shared_ptr < ArrayPropertyReader >	ArrayPropertyReaderPtr
typedef boost::shared_ptr < ScalarPropertyReader >	ScalarPropertyReaderPtr
typedef boost::shared_ptr < BasePropertyReader >	BasePropertyReaderPtr
typedef int64_t	index_t
typedef float64_t	chrono_t
typedef boost::shared_ptr < ReadArraySampleCache >	ReadArraySampleCachePtr
typedef boost::shared_ptr < TimeSampling >	TimeSamplingPtr
Enumerations
enum	PropertyType { kCompoundProperty = 0, kScalarProperty = 1, kArrayProperty = 2 }
Functions
ArraySamplePtr	AllocateArraySample (const DataType &iDtype, const Dimensions &iDims)
template<class T >
ArraySamplePtr	TAllocateArraySample (size_t iDataTypeExtent, const Dimensions &iDims)
size_t	StdHash (ArraySampleKey const &a)
std::ostream &	operator<< (std::ostream &ostr, const DataType &a)
std::string	GetLibraryVersion ()
std::string	GetLibraryVersionShort ()

---

Typedef Documentation

typedef boost::shared_ptr<ArchiveReader> Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveReaderPtr

Smart Ptrs to Readers. The Ptr suffix in Alembic _ALWAYS_ refers to a boost::shared_ptr of whatever class name precedes the Ptr suffix. We consider boost::shared_ptr to be a reliable and standard feature of C++, and worthy of inclusion in a standard.

Definition at line 100 of file ForwardDeclarations.h.

typedef boost::shared_ptr<ArchiveWriter> Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriterPtr

Smart Ptrs to Writers. The Ptr suffix in Alembic _ALWAYS_ refers to a boost::shared_ptr of whatever class name precedes the Ptr suffix. We consider boost::shared_ptr to be a reliable and standard feature of C++, and worthy of inclusion in a standard.

Definition at line 87 of file ForwardDeclarations.h.

typedef boost::shared_ptr<ArrayPropertyReader> Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArrayPropertyReaderPtr

Definition at line 103 of file ForwardDeclarations.h.

typedef boost::shared_ptr<ArrayPropertyWriter> Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArrayPropertyWriterPtr

Definition at line 90 of file ForwardDeclarations.h.

typedef boost::shared_ptr< ArraySample > Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArraySamplePtr

The ArraySamplePtr can be used not only to share this ArraySample, but also to manage the data referred to by the memory address in the pointer, by way of a custom deleter. In this manner, ArraySample and ArraySamplePtr can be used both as a reference to data and as an explicit ownership of data. This greatly reduces the redundancy of this library's code.

Smart Ptrs to Helper types. The Ptr suffix in Alembic _ALWAYS_ refers to a boost::shared_ptr of whatever class name precedes the Ptr suffix. We consider boost::shared_ptr to be a reliable and standard feature of C++, and worthy of inclusion in a standard.

Definition at line 137 of file ArraySample.h.

typedef boost::shared_ptr<BasePropertyReader> Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyReaderPtr

Definition at line 105 of file ForwardDeclarations.h.

typedef boost::shared_ptr<BasePropertyWriter> Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriterPtr

Definition at line 92 of file ForwardDeclarations.h.

typedef float64_t Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::chrono_t

Chrono type. This is used whenever time values are needed in the library. They are generally assumed to be seconds, but this does not need to be explicitly enforced by the API.

Definition at line 72 of file Foundation.h.

typedef boost::shared_ptr<CompoundPropertyReader> Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyReaderPtr

Definition at line 102 of file ForwardDeclarations.h.

typedef boost::shared_ptr<CompoundPropertyWriter> Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyWriterPtr

Definition at line 89 of file ForwardDeclarations.h.

typedef int64_t Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::index_t

Index type Just being pedantic.

Definition at line 66 of file Foundation.h.

typedef boost::shared_ptr<ObjectReader> Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReaderPtr

Definition at line 101 of file ForwardDeclarations.h.

typedef boost::shared_ptr<ObjectWriter> Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectWriterPtr

Definition at line 88 of file ForwardDeclarations.h.

typedef boost::shared_ptr<ReadArraySampleCache> Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleCachePtr

Definition at line 137 of file ReadArraySampleCache.h.

typedef boost::shared_ptr<ScalarPropertyReader> Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ScalarPropertyReaderPtr

Definition at line 104 of file ForwardDeclarations.h.

typedef boost::shared_ptr<ScalarPropertyWriter> Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ScalarPropertyWriterPtr

Definition at line 91 of file ForwardDeclarations.h.

typedef boost::shared_ptr<TimeSampling> Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSamplingPtr

Definition at line 136 of file TimeSampling.h.

typedef boost::unordered_set<ArraySampleKey, ArraySampleKeyStdHash, ArraySampleKeyEqualTo> Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::UnorderedArraySampleKeySet

Definition at line 140 of file ArraySampleKey.h.

---

Enumeration Type Documentation

enum Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyType

In Alembic, Objects may have three distinct types of abstract properties. Any fancy type-specific properties are ultimately and instance of one of these three types of properties, identified here by an enum. "Simple" properties are simply "non-compound" properties - the SimpleProperty classes are simply common base classes for Scalar and Array Properties.

Enumerator:

kCompoundProperty	Compound Properties are groups of other properties, with their own unique name and set of MetaData. All objects have a single root compound property as the base of their property description.
kScalarProperty	Scalar Properties represent Rank-0 properties, which contain a single element value for any given time sample.
kArrayProperty	Array Properties represent Rank-N properties, which contain an array of values for any given time sample. Array properties may have any rank of 1 or higher, but will most often be ranks 1, 2, 3.

Definition at line 56 of file PropertyHeader.h.

---

Function Documentation

ArraySamplePtr Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::AllocateArraySample	(	const DataType &	iDtype,
		const Dimensions &	iDims
	)

When creating an actual buffer for reading an array sample into, we need to allocate an array of some number of bytes, and then delete it with a special deleter. This function will return an array sample that is managed in this way. Dimensions tells us how many instances of the DataType to create DataType tells us what the instance is - and this works for pretty much every case, including std::string and std::wstring.

std::string Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::GetLibraryVersion

(

)

Helper function which returns the version and date built in a string e.g. "Alembic 1.0.0 (built Jul 6 2011)"

std::string Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::GetLibraryVersionShort

(

)

Returns just the version number, as a string, of the Alembic library. e.g. "1.0.0"

std::ostream& Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::operator<<	(	std::ostream &	ostr,
		const DataType &	a
	)			[inline]

Outputs DataType to a std::ostream Makes use of PlainOldDataType's string conversion functions

Definition at line 132 of file DataType.h.

size_t Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::StdHash

(

ArraySampleKey const &

a

)

[inline]

Definition at line 101 of file ArraySampleKey.h.

template<class T >

ArraySamplePtr Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TAllocateArraySample	(	size_t	iDataTypeExtent,
		const Dimensions &	iDims
	)			[inline]

Definition at line 179 of file ArraySample.h.