Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter Class Reference
#include <ArchiveWriter.h>
Public Member Functions | |
| virtual | ~ArchiveWriter () |
| virtual const std::string & | getName () const =0 |
| virtual const MetaData & | getMetaData () const =0 |
| virtual ObjectWriterPtr | getTop ()=0 |
| int8_t | getCompressionHint () const |
| void | setCompressionHint (int8_t iCh) |
| virtual ArchiveWriterPtr | asArchivePtr ()=0 |
| virtual uint32_t | addTimeSampling (const TimeSampling &iTs)=0 |
| virtual TimeSamplingPtr | getTimeSampling (uint32_t iIndex)=0 |
| virtual uint32_t | getNumTimeSamplings ()=0 |
Protected Member Functions | |
| ArchiveWriter () | |
Detailed Description
The Archive is "the file". It has a single object, it's top object. It has no properties, but does have metadata.Definition at line 68 of file ArchiveWriter.h.
Constructor & Destructor Documentation
| Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::ArchiveWriter | ( | ) | [inline, protected] |
Definition at line 72 of file ArchiveWriter.h.
| virtual Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::~ArchiveWriter | ( | ) | [virtual] |
Virtual destructor ...
Member Function Documentation
| virtual uint32_t Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::addTimeSampling | ( | const TimeSampling & | iTs | ) | [pure virtual] |
Adds the TimeSampling to the Archive TimeSampling pool. If the TimeSampling already exists in the pool, the index for the match should be returned. index 0 is automatically reserved for uniform time sampling with a start time of 0 and time per cycle of 1 (aka identity sampling)
Implemented in Alembic::AbcCoreHDF5::ALEMBIC_VERSION_NS::AwImpl.
| virtual ArchiveWriterPtr Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::asArchivePtr | ( | ) | [pure virtual] |
Return self May sometimes be spoofed.
Implemented in Alembic::AbcCoreHDF5::ALEMBIC_VERSION_NS::AwImpl.
| int8_t Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::getCompressionHint | ( | ) | const [inline] |
Get the compression applied to array properties. Implementations are free to disregard this.
Definition at line 99 of file ArchiveWriter.h.
| virtual const MetaData& Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::getMetaData | ( | ) | const [pure virtual] |
The meta data of the archive is the same as the meta data of the top-level object writer.
Implemented in Alembic::AbcCoreHDF5::ALEMBIC_VERSION_NS::AwImpl.
| virtual const std::string& Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::getName | ( | ) | const [pure virtual] |
Return the archive (file) name. This is the name of the file which the archive writer is associated with.
Implemented in Alembic::AbcCoreHDF5::ALEMBIC_VERSION_NS::AwImpl.
| virtual uint32_t Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::getNumTimeSamplings | ( | ) | [pure virtual] |
Returns the total number of TimeSamplingPtrs in the Archive TimeSampling pool.
Implemented in Alembic::AbcCoreHDF5::ALEMBIC_VERSION_NS::AwImpl.
| virtual TimeSamplingPtr Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::getTimeSampling | ( | uint32_t | iIndex | ) | [pure virtual] |
Returns the TimeSampling at a given index. index 0 is automatically reserved for uniform time sampling with a start time of 0 and time per cycle of 1 (aka identity sampling)
Implemented in Alembic::AbcCoreHDF5::ALEMBIC_VERSION_NS::AwImpl.
| virtual ObjectWriterPtr Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::getTop | ( | ) | [pure virtual] |
Get the top object writer. Archives always have this single top-level object created automatically.
Implemented in Alembic::AbcCoreHDF5::ALEMBIC_VERSION_NS::AwImpl.
| void Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriter::setCompressionHint | ( | int8_t | iCh | ) | [inline] |
Set the compression applied to array properties. Implementations are free to disregard this. -1 means off, 0 means "litte", where 9 means "alot"
Definition at line 104 of file ArchiveWriter.h.
The documentation for this class was generated from the following file:
- Alembic/AbcCoreAbstract/ArchiveWriter.h
