Alembic::Abc::ALEMBIC_VERSION_NS::IObject Class Reference
#include <IObject.h>
Public Types | |
| typedef IObject | this_type |
| typedef IObject | operator_bool_base_type |
Public Member Functions | |
| IObject () | |
| template<class OBJECT_PTR > | |
| IObject (OBJECT_PTR iParentObject, const std::string &iName, ErrorHandler::Policy iPcy=ErrorHandler::kThrowPolicy) | |
| template<class OBJECT_PTR > | |
| IObject (OBJECT_PTR iPtr, WrapExistingFlag iFlag, ErrorHandler::Policy iPcy=ErrorHandler::kThrowPolicy) | |
| template<class ARCHIVE_PTR > | |
| IObject (ARCHIVE_PTR iPtr, TopFlag iFlag, ErrorHandler::Policy iPcy=ErrorHandler::kThrowPolicy) | |
| ~IObject () | |
| const AbcA::ObjectHeader & | getHeader () const |
| const std::string & | getName () const |
| const std::string & | getFullName () const |
| const AbcA::MetaData & | getMetaData () const |
| IArchive | getArchive () |
| IObject | getParent () |
| size_t | getNumChildren () |
| const AbcA::ObjectHeader & | getChildHeader (size_t i) |
| const AbcA::ObjectHeader * | getChildHeader (const std::string &iName) |
| ICompoundProperty | getProperties () |
| IObject | getChild (size_t iChildIndex) |
| IObject | getChild (const std::string &iChildName) |
| AbcA::ObjectReaderPtr | getPtr () |
| void | reset () |
| bool | valid () const |
| ALEMBIC_OPERATOR_BOOL (valid()) | |
Public Attributes | |
| AbcA::ObjectReaderPtr | m_object |
Detailed Description
Definition at line 52 of file IObject.h.
Member Typedef Documentation
By convention, we always define "this_type" in every Abc class. This convention is relied upon by the unspecified-bool-type conversion.
Reimplemented in Alembic::Abc::ALEMBIC_VERSION_NS::ISchemaObject< SCHEMA >.
Constructor & Destructor Documentation
| Alembic::Abc::ALEMBIC_VERSION_NS::IObject::IObject | ( | ) | [inline] |
| Alembic::Abc::ALEMBIC_VERSION_NS::IObject::IObject | ( | OBJECT_PTR | iParentObject, | |
| const std::string & | iName, | |||
| ErrorHandler::Policy | iPcy = ErrorHandler::kThrowPolicy | |||
| ) | [inline] |
This templated, explicit function creates a new object reader. The first argument is any Abc (or AbcCoreAbstract) object which can intrusively be converted to an AbcA::ObjectReaderPtr to use as a parent, from which the error handler policy for inheritance is also derived. The remaining optional arguments can be used to override the ErrorHandlerPolicy.
| Alembic::Abc::ALEMBIC_VERSION_NS::IObject::IObject | ( | OBJECT_PTR | iPtr, | |
| WrapExistingFlag | iFlag, | |||
| ErrorHandler::Policy | iPcy = ErrorHandler::kThrowPolicy | |||
| ) | [inline] |
| Alembic::Abc::ALEMBIC_VERSION_NS::IObject::IObject | ( | ARCHIVE_PTR | iPtr, | |
| TopFlag | iFlag, | |||
| ErrorHandler::Policy | iPcy = ErrorHandler::kThrowPolicy | |||
| ) | [inline] |
| Alembic::Abc::ALEMBIC_VERSION_NS::IObject::~IObject | ( | ) |
Default copy constructor used Default assignment operator used. Destructor ...
Member Function Documentation
| Alembic::Abc::ALEMBIC_VERSION_NS::IObject::ALEMBIC_OPERATOR_BOOL | ( | valid() | ) |
The unspecified-bool-type operator casts the object to "true" if it is valid, and "false" otherwise.
| IArchive Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getArchive | ( | ) |
This function returns the object's archive, handily wrapped in an IArchive wrapper.
| IObject Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getChild | ( | const std::string & | iChildName | ) |
This function returns an IObject wrapped constructed from the header referenced by the name. If the child of the given name does not exist, this will fail in the same way as if the equivalent constructor was called.
| IObject Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getChild | ( | size_t | iChildIndex | ) |
This function returns an IObject constructed from the indexed object.
| const AbcA::ObjectHeader* Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getChildHeader | ( | const std::string & | iName | ) |
Return the header of an object by name. This will return a NULL pointer if no header by that name is found.
| const AbcA::ObjectHeader& Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getChildHeader | ( | size_t | i | ) |
This function returns the headers of each of the child objects that were written as children of this object.
| const std::string& Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getFullName | ( | ) | const [inline] |
| const AbcA::ObjectHeader& Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getHeader | ( | ) | const |
All objects have a header, which contains all the MetaData that was specified upon their creation. This function returns a constant reference to that Header.
| const AbcA::MetaData& Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getMetaData | ( | ) | const [inline] |
All objects have metadata. This metadata is identical to the Metadata of the top level compoundProperty "properties". Because the metadata must exist and be initialized in order to bootstrap the object, it is guaranteed to exist and is returned by reference. This is a convenience function which returns the header's MetaData.
| const std::string& Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getName | ( | ) | const [inline] |
| size_t Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getNumChildren | ( | ) |
This function returns the number of child objects that this object has.
| IObject Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getParent | ( | ) |
| ICompoundProperty Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getProperties | ( | ) |
This returns the single top-level CompoundPropertyReader that exists automatically as part of the object.
| AbcA::ObjectReaderPtr Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getPtr | ( | ) | [inline] |
getPtr, as usual, returns a shared ptr to the underlying AbcCoreAbstract object, in this case the ObjectReaderPtr.
| void Alembic::Abc::ALEMBIC_VERSION_NS::IObject::reset | ( | ) | [inline] |
Reset returns this function set to an empty, default state.
Reimplemented from Alembic::Abc::ALEMBIC_VERSION_NS::Base.
Reimplemented in Alembic::Abc::ALEMBIC_VERSION_NS::ISchemaObject< SCHEMA >.
| bool Alembic::Abc::ALEMBIC_VERSION_NS::IObject::valid | ( | ) | const [inline] |
Valid returns whether this function set is valid.
Reimplemented from Alembic::Abc::ALEMBIC_VERSION_NS::Base.
Reimplemented in Alembic::Abc::ALEMBIC_VERSION_NS::ISchemaObject< SCHEMA >.
Member Data Documentation
| AbcA::ObjectReaderPtr Alembic::Abc::ALEMBIC_VERSION_NS::IObject::m_object |
The documentation for this class was generated from the following file:
- Alembic/Abc/IObject.h
