HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Alembic::Abc::ALEMBIC_VERSION_NS::OObject Class Reference

#include <OObject.h>

+ Inheritance diagram for Alembic::Abc::ALEMBIC_VERSION_NS::OObject:

Public Types

typedef OObject this_type
 
typedef OObject operator_bool_base_type
 

Public Member Functions

 OObject ()
 
template<class OBJECT_PTR >
 OObject (OBJECT_PTR iParentObject, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument())
 
template<class OBJECT_PTR >
 OObject (OBJECT_PTR iPtr, WrapExistingFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument())
 
template<class ARCHIVE_PTR >
 OObject (ARCHIVE_PTR iPtr, TopFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument())
 
virtual ~OObject ()
 
const AbcA::ObjectHeadergetHeader () const
 
const std::stringgetName () const
 
const std::stringgetFullName () const
 
const AbcA::MetaDatagetMetaData () const
 
OArchive getArchive ()
 
OObject getParent ()
 
size_t getNumChildren ()
 
const AbcA::ObjectHeadergetChildHeader (size_t i)
 
const AbcA::ObjectHeadergetChildHeader (const std::string &iName)
 
OCompoundProperty getProperties ()
 
OObject getChild (size_t iChildIndex)
 
OObject getChild (const std::string &iChildName)
 
bool addChildInstance (OObject iTarget, const std::string &iName)
 -************************************************************************ More...
 
AbcA::ObjectWriterPtr getPtr ()
 
void reset ()
 
bool valid () const
 
 ALEMBIC_OPERATOR_BOOL (valid())
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::Base
ErrorHandlergetErrorHandler () const
 
ErrorHandler::Policy getErrorHandlerPolicy () const
 

Protected Attributes

AbcA::ObjectWriterPtr m_object
 

Additional Inherited Members

- Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::Base
 Base ()
 
 Base (ErrorHandler::Policy iPolicy)
 
 Base (const Base &iCopy)
 
Baseoperator= (const Base &iCopy)
 
bool valid () const
 
void reset ()
 

Detailed Description

Definition at line 53 of file OObject.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.

Definition at line 59 of file OObject.h.

Constructor & Destructor Documentation

Alembic::Abc::ALEMBIC_VERSION_NS::OObject::OObject ( )
inline

The default constructor creates an empty OObject function set. ...

Definition at line 68 of file OObject.h.

template<class OBJECT_PTR >
Alembic::Abc::ALEMBIC_VERSION_NS::OObject::OObject ( OBJECT_PTR  iParentObject,
const std::string iName,
const Argument iArg0 = Argument(),
const Argument iArg1 = Argument(),
const Argument iArg2 = Argument() 
)
inline

This templated, explicit function creates a new object writer. The first argument is any Abc (or AbcCoreAbstract) object which can intrusively be converted to an ObjectWriterPtr 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, to specify MetaData, and that's it.

Definition at line 260 of file OObject.h.

template<class OBJECT_PTR >
Alembic::Abc::ALEMBIC_VERSION_NS::OObject::OObject ( OBJECT_PTR  iPtr,
WrapExistingFlag  ,
const Argument iArg0 = Argument(),
const Argument iArg1 = Argument(),
const Argument iArg2 = Argument() 
)
inline

This attaches an OObject wrapper around an existing ObjectWriterPtr, with an optional error handling policy. Arguments can be used to set error handling policy.

Definition at line 89 of file OObject.h.

template<class ARCHIVE_PTR >
Alembic::Abc::ALEMBIC_VERSION_NS::OObject::OObject ( ARCHIVE_PTR  iPtr,
TopFlag  ,
const Argument iArg0 = Argument(),
const Argument iArg1 = Argument(),
const Argument iArg2 = Argument() 
)
inline

This attaches an OObject wrapper around the top object in an archive. Arguments can be used to set error handling policy.

Definition at line 107 of file OObject.h.

virtual Alembic::Abc::ALEMBIC_VERSION_NS::OObject::~OObject ( )
virtual

Default copy constructor used Default assignment operator used. Destructor ...

Member Function Documentation

bool Alembic::Abc::ALEMBIC_VERSION_NS::OObject::addChildInstance ( OObject  iTarget,
const std::string iName 
)

-************************************************************************

-************************************************************************

Alembic::Abc::ALEMBIC_VERSION_NS::OObject::ALEMBIC_OPERATOR_BOOL ( valid()  )

The unspecified-bool-type operator casts the object to "true" if it is valid, and "false" otherwise.

OArchive Alembic::Abc::ALEMBIC_VERSION_NS::OObject::getArchive ( )

This function returns the object's archive, handily wrapped in an OArchive wrapper.

OObject Alembic::Abc::ALEMBIC_VERSION_NS::OObject::getChild ( size_t  iChildIndex)

This function returns an OObject wrapped around a pointer to an already created child. This is distinct from creating a new OObject as a child. If the writer associated with this child no longer exists, this function will return an empty OObject.

OObject Alembic::Abc::ALEMBIC_VERSION_NS::OObject::getChild ( const std::string iChildName)

This function returns an OObject wrapped around a pointer to an already created child. This is distinct from creating a new OObject as a child. If the writer associated with this child no longer exists, this function will return an empty OObject.

const AbcA::ObjectHeader& Alembic::Abc::ALEMBIC_VERSION_NS::OObject::getChildHeader ( size_t  i)

This function returns the headers of each of the child objects created so far.

const AbcA::ObjectHeader* Alembic::Abc::ALEMBIC_VERSION_NS::OObject::getChildHeader ( const std::string iName)

This function returns the header of a named object if it has been created - even if the object no longer exists.

const std::string& Alembic::Abc::ALEMBIC_VERSION_NS::OObject::getFullName ( ) const
inline

This function returns the object's full (unique with the archive) name

Definition at line 148 of file OObject.h.

const AbcA::ObjectHeader& Alembic::Abc::ALEMBIC_VERSION_NS::OObject::getHeader ( ) const

Return the object's header. ...

const AbcA::MetaData& Alembic::Abc::ALEMBIC_VERSION_NS::OObject::getMetaData ( ) const
inline

This function returns the object's metadata. ...

Definition at line 153 of file OObject.h.

const std::string& Alembic::Abc::ALEMBIC_VERSION_NS::OObject::getName ( ) const
inline

This function returns the object's local name ...

Definition at line 143 of file OObject.h.

size_t Alembic::Abc::ALEMBIC_VERSION_NS::OObject::getNumChildren ( )

This function returns the number of child objects that this object has. This may change as new children are created for writing.

OObject Alembic::Abc::ALEMBIC_VERSION_NS::OObject::getParent ( )

This function returns the object's parent, handily wrapped in an OObject wrapper. If the object is the top level object, the OObject returned will be NULL.

OCompoundProperty Alembic::Abc::ALEMBIC_VERSION_NS::OObject::getProperties ( )

This returns the single top-level OCompoundProperty that exists automatically as part of the object.

AbcA::ObjectWriterPtr Alembic::Abc::ALEMBIC_VERSION_NS::OObject::getPtr ( )
inline

getPtr, as usual, returns a shared ptr to the underlying AbcCoreAbstract object, in this case the ObjectWriterPtr.

Definition at line 217 of file OObject.h.

void Alembic::Abc::ALEMBIC_VERSION_NS::OObject::reset ( )
inline

Reset returns this function set to an empty, default state.

Definition at line 221 of file OObject.h.

bool Alembic::Abc::ALEMBIC_VERSION_NS::OObject::valid ( ) const
inline

Valid returns whether this function set is valid.

Definition at line 225 of file OObject.h.

Member Data Documentation

AbcA::ObjectWriterPtr Alembic::Abc::ALEMBIC_VERSION_NS::OObject::m_object
protected

Definition at line 244 of file OObject.h.


The documentation for this class was generated from the following file: