Alembic Version 1.1
|
#include <OArchive.h>
Public Types | |
typedef OArchive | this_type |
Public Member Functions | |
OArchive () | |
template<class ARCHIVE_CTOR > | |
OArchive (ARCHIVE_CTOR iCtor, const std::string &iFileName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument()) | |
OArchive (AbcA::ArchiveWriterPtr iPtr, ErrorHandler::Policy iPolicy=ErrorHandler::kThrowPolicy) | |
OArchive (AbcA::ArchiveWriterPtr iPtr, WrapExistingFlag, ErrorHandler::Policy iPolicy=ErrorHandler::kThrowPolicy) | |
~OArchive () | |
std::string | getName () const |
OObject | getTop () |
int8_t | getCompressionHint () const |
void | setCompressionHint (int8_t iCh) |
uint32_t | addTimeSampling (const AbcA::TimeSampling &iTs) |
AbcA::TimeSamplingPtr | getTimeSampling (uint32_t iIndex) |
uint32_t | getNumTimeSamplings () |
AbcA::ArchiveWriterPtr | getPtr () |
void | reset () |
bool | valid () const |
ALEMBIC_OPERATOR_BOOL (valid()) | |
![]() | |
ErrorHandler & | getErrorHandler () const |
ErrorHandler::Policy | getErrorHandlerPolicy () const |
Additional Inherited Members | |
![]() | |
Base () | |
Base (ErrorHandler::Policy iPolicy) | |
Base (const Base &iCopy) | |
Base & | operator= (const Base &iCopy) |
bool | valid () const |
void | reset () |
Definition at line 52 of file OArchive.h.
By convention, we always define "this_type" in every Abc class. This convention is relied upon by the unspecified-bool-type conversion.
Definition at line 58 of file OArchive.h.
|
inline |
The default constructor creates an empty OArchive function set. ...
Definition at line 66 of file OArchive.h.
Alembic::Abc::ALEMBIC_VERSION_NS::OArchive::OArchive | ( | ARCHIVE_CTOR | iCtor, |
const std::string & | iFileName, | ||
const Argument & | iArg0 = Argument() , |
||
const Argument & | iArg1 = Argument() |
||
) |
The explicit constructor creates an archive with the given file name. Additional arguments that may be passed are the error handling policy and meta data.
iCtor | We need to pass in a constructor which provides an explicit link to the concrete implementation of AbcCoreAbstract that we're using. |
iFileName | File name |
iArg0 | Optionally could be the error handling policy, or the meta data. |
iArg1 | Optionally could be the error handling policy, or the meta data. |
Definition at line 199 of file OArchive.h.
References ALEMBIC_ABC_SAFE_CALL_BEGIN, ALEMBIC_ABC_SAFE_CALL_END_RESET, Alembic::Abc::ALEMBIC_VERSION_NS::Base::getErrorHandler(), Alembic::Abc::ALEMBIC_VERSION_NS::Arguments::getErrorHandlerPolicy(), Alembic::Abc::ALEMBIC_VERSION_NS::Arguments::getMetaData(), Alembic::Abc::ALEMBIC_VERSION_NS::ErrorHandler::kThrowPolicy, Alembic::Abc::ALEMBIC_VERSION_NS::Argument::setInto(), and Alembic::Abc::ALEMBIC_VERSION_NS::ErrorHandler::setPolicy().
|
inline |
This attaches an OArchive wrapper around an existing ArchiveWriterPtr, with an optional error handling policy.
iPtr | The pointer ... |
iPolicy | Optional error handling policy ... |
Definition at line 89 of file OArchive.h.
|
inline |
Definition at line 105 of file OArchive.h.
Alembic::Abc::ALEMBIC_VERSION_NS::OArchive::~OArchive | ( | ) |
Destructor ...
uint32_t Alembic::Abc::ALEMBIC_VERSION_NS::OArchive::addTimeSampling | ( | const AbcA::TimeSampling & | iTs | ) |
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)
Alembic::Abc::ALEMBIC_VERSION_NS::OArchive::ALEMBIC_OPERATOR_BOOL | ( | valid() | ) |
The unspecified-bool-type operator casts the object to "true" if it is valid, and "false" otherwise.
int8_t Alembic::Abc::ALEMBIC_VERSION_NS::OArchive::getCompressionHint | ( | ) | const |
Get the compression applied to array properties. The value will be -1 for uncompressed, and 0-9 for weak through strong gzip compression.
std::string Alembic::Abc::ALEMBIC_VERSION_NS::OArchive::getName | ( | ) | const |
Default copy constructor Default assignment operator Returns the file name. It is an error to do so with an invalid object.
uint32_t Alembic::Abc::ALEMBIC_VERSION_NS::OArchive::getNumTimeSamplings | ( | ) |
Returns the total number of TimeSamplingPtrs in the Archive TimeSampling pool.
|
inline |
getPtr, as usual, returns a shared ptr to the underlying AbcCoreAbstract object, in this case the ArchiveWriterPtr.
Definition at line 169 of file OArchive.h.
Referenced by Alembic::Abc::ALEMBIC_VERSION_NS::GetArchiveWriterPtr().
AbcA::TimeSamplingPtr Alembic::Abc::ALEMBIC_VERSION_NS::OArchive::getTimeSampling | ( | uint32_t | iIndex | ) |
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)
OObject Alembic::Abc::ALEMBIC_VERSION_NS::OArchive::getTop | ( | ) |
This returns the single top-level OObject that exists automatically as part of the archive.
|
inline |
Reset returns this function set to an empty, default state.
Definition at line 173 of file OArchive.h.
References Alembic::Abc::ALEMBIC_VERSION_NS::Base::reset().
void Alembic::Abc::ALEMBIC_VERSION_NS::OArchive::setCompressionHint | ( | int8_t | iCh | ) |
Set the compression applied to array properties. Value of -1 means uncompressed, and values of 0-9 indicate increasingly compressed data, at the expense of time.
|
inline |
Valid returns whether this function set is valid.
Definition at line 177 of file OArchive.h.
References Alembic::Abc::ALEMBIC_VERSION_NS::Base::valid().