#include <IObject.h>
|
| IObject () |
|
| IObject (const IObject &iParent, const std::string &iName, const Argument &iArg0=Argument()) |
|
| IObject (AbcA::ObjectReaderPtr iPtr, const Argument &iArg0=Argument()) |
|
| IObject (AbcA::ObjectReaderPtr iPtr, WrapExistingFlag, const Argument &iArg0=Argument()) |
|
| IObject (IArchive &iArchive, const Argument &iArg0=Argument()) |
|
| IObject (IArchive &iArchive, TopFlag iFlag, const Argument &iArg0=Argument()) |
|
virtual | ~IObject () |
|
const AbcA::ObjectHeader & | getHeader () const |
|
const std::string & | getName () const |
|
const std::string & | getFullName () const |
|
const AbcA::MetaData & | getMetaData () const |
|
IArchive | getArchive () const |
|
IObject | getParent () const |
|
size_t | getNumChildren () const |
|
const AbcA::ObjectHeader & | getChildHeader (size_t i) const |
|
const AbcA::ObjectHeader * | getChildHeader (const std::string &iName) const |
|
ICompoundProperty | getProperties () const |
|
IObject | getChild (size_t iChildIndex) const |
|
IObject | getChild (const std::string &iChildName) const |
|
bool | isInstanceRoot () const |
| -************************************************************************ More...
|
|
bool | isInstanceDescendant () const |
|
std::string | instanceSourcePath () const |
|
bool | isChildInstance (size_t iChildIndex) const |
|
bool | isChildInstance (const std::string &iChildName) const |
|
AbcA::ObjectReaderPtr | getInstancePtr () const |
| Returns the original ObjectReaderPtr, if this object is an instance. More...
|
|
AbcA::ObjectReaderPtr | getPtr () const |
|
void | reset () |
| Reset returns this function set to an empty, default state. More...
|
|
bool | valid () const |
|
bool | getPropertiesHash (Util::Digest &oDigest) |
|
bool | getChildrenHash (Util::Digest &oDigest) |
|
| ALEMBIC_OPERATOR_BOOL (valid()) |
|
ErrorHandler & | getErrorHandler () const |
|
ErrorHandler::Policy | getErrorHandlerPolicy () const |
|
Definition at line 53 of file IObject.h.
◆ operator_bool_base_type
◆ this_type
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 59 of file IObject.h.
◆ IObject() [1/6]
Alembic::Abc::ALEMBIC_VERSION_NS::IObject::IObject |
( |
| ) |
|
|
inline |
The default constructor creates an empty IObject function set. ...
Definition at line 68 of file IObject.h.
◆ IObject() [2/6]
Alembic::Abc::ALEMBIC_VERSION_NS::IObject::IObject |
( |
const IObject & |
iParent, |
|
|
const std::string & |
iName, |
|
|
const Argument & |
iArg0 = Argument() |
|
) |
| |
|
inline |
◆ IObject() [3/6]
◆ IObject() [4/6]
◆ IObject() [5/6]
This attaches an IObject wrapper around the top object of an archive.
Definition at line 113 of file IObject.h.
◆ IObject() [6/6]
◆ ~IObject()
virtual Alembic::Abc::ALEMBIC_VERSION_NS::IObject::~IObject |
( |
| ) |
|
|
virtual |
Default copy constructor used Default assignment operator used. Destructor ...
◆ ALEMBIC_OPERATOR_BOOL()
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.
◆ getArchive()
IArchive Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getArchive |
( |
| ) |
const |
◆ getChild() [1/2]
IObject Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getChild |
( |
const std::string & |
iChildName | ) |
const |
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.
◆ getChild() [2/2]
IObject Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getChild |
( |
size_t |
iChildIndex | ) |
const |
This function returns an IObject constructed from the indexed object.
◆ getChildHeader() [1/2]
const AbcA::ObjectHeader * Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getChildHeader |
( |
const std::string & |
iName | ) |
const |
Return the header of an object by name. This will return a NULL pointer if no header by that name is found.
◆ getChildHeader() [2/2]
const AbcA::ObjectHeader & Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getChildHeader |
( |
size_t |
i | ) |
const |
This function returns the headers of each of the child objects that were written as children of this object.
◆ getChildrenHash()
bool Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getChildrenHash |
( |
Util::Digest & |
oDigest | ) |
|
If an aggregated child objects hash exists fill oDigest with it and return true, if it doesn't exist return false
◆ getFullName()
const std::string & Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getFullName |
( |
| ) |
const |
The full name of an object is the complete path name all the way to the root object of the archive. It is guaranteed to be fully unique within the entire archive. This is a convenience function which returns the header's full name.
◆ getHeader()
◆ getInstancePtr()
Returns the original ObjectReaderPtr, if this object is an instance.
Definition at line 232 of file IObject.h.
◆ getMetaData()
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.
Definition at line 161 of file IObject.h.
◆ getName()
const std::string & Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getName |
( |
| ) |
const |
All objects have a name. This name is unique amongst their siblings Returned by reference, since it is guaranteed to exist and be unchanging. This is a convenience function which returns the header's name.
◆ getNumChildren()
size_t Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getNumChildren |
( |
| ) |
const |
This function returns the number of child objects that this object has.
◆ getParent()
IObject Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getParent |
( |
| ) |
const |
This function returns the object's parent, handily wrapped in an IObject wrapper. If the object is the top level object, the IObject returned will be NULL.
◆ getProperties()
◆ getPropertiesHash()
bool Alembic::Abc::ALEMBIC_VERSION_NS::IObject::getPropertiesHash |
( |
Util::Digest & |
oDigest | ) |
|
If an aggregated properties hash exists fill oDigest with it and return true, if it doesn't exist return false
◆ getPtr()
◆ instanceSourcePath()
std::string Alembic::Abc::ALEMBIC_VERSION_NS::IObject::instanceSourcePath |
( |
| ) |
const |
If this object is an instance (isInstanceRoot), returns the source path that the instance points at. Otherwise and empty string is returned.
◆ isChildInstance() [1/2]
bool Alembic::Abc::ALEMBIC_VERSION_NS::IObject::isChildInstance |
( |
const std::string & |
iChildName | ) |
const |
◆ isChildInstance() [2/2]
bool Alembic::Abc::ALEMBIC_VERSION_NS::IObject::isChildInstance |
( |
size_t |
iChildIndex | ) |
const |
◆ isInstanceDescendant()
bool Alembic::Abc::ALEMBIC_VERSION_NS::IObject::isInstanceDescendant |
( |
| ) |
const |
Returns whether this object has been arrived at via an instance, or if this object is an instance itself.
◆ isInstanceRoot()
bool Alembic::Abc::ALEMBIC_VERSION_NS::IObject::isInstanceRoot |
( |
| ) |
const |
-************************************************************************
-************************************************************************ Returns whether this object directly instances another object.
◆ reset()
void Alembic::Abc::ALEMBIC_VERSION_NS::IObject::reset |
( |
| ) |
|
◆ valid()
bool Alembic::Abc::ALEMBIC_VERSION_NS::IObject::valid |
( |
| ) |
const |
|
inline |
◆ m_object
The documentation for this class was generated from the following file: