Alembic Version 1.1
|
#include <IBaseProperty.h>
Public Member Functions | |
const AbcA::PropertyHeader & | getHeader () const |
const std::string & | getName () const |
AbcA::PropertyType | getPropertyType () const |
bool | isScalar () const |
bool | isArray () const |
bool | isCompound () const |
bool | isSimple () const |
const AbcA::MetaData & | getMetaData () const |
const AbcA::DataType & | getDataType () const |
AbcA::TimeSamplingPtr | getTimeSampling () const |
IObject | getObject () const |
PROP_PTR | getPtr () const |
void | reset () |
bool | valid () const |
ALEMBIC_OPERATOR_BOOL (valid()) | |
![]() | |
ErrorHandler & | getErrorHandler () const |
ErrorHandler::Policy | getErrorHandlerPolicy () const |
Protected Types | |
typedef IBasePropertyT< PROP_PTR > | this_type |
typedef IBasePropertyT< PROP_PTR > | operator_bool_base_type |
Protected Member Functions | |
IBasePropertyT () | |
IBasePropertyT (PROP_PTR iPtr, ErrorHandler::Policy iPolicy) | |
![]() | |
Base () | |
Base (ErrorHandler::Policy iPolicy) | |
Base (const Base &iCopy) | |
Base & | operator= (const Base &iCopy) |
bool | valid () const |
void | reset () |
Protected Attributes | |
PROP_PTR | m_property |
Most of the functionality of properties (getting information about the properties and so on) is common to all property types, so we create a base class to contain all that functionality. This is purely a base class for other properties to derive from, it will never be created directly.
Definition at line 57 of file IBaseProperty.h.
|
protected |
Definition at line 64 of file IBaseProperty.h.
|
protected |
Definition at line 63 of file IBaseProperty.h.
|
inlineprotected |
The default constructor creates an empty IBasePropertyT function set. ...
Definition at line 72 of file IBaseProperty.h.
|
inlineprotected |
This attaches an IBasePropertyT wrapper around an existing PROP_PTR, with an optional error handling policy.
iPtr | The pointer ... |
iPolicy | Optional error handling policy ... |
Definition at line 181 of file IBaseProperty.h.
References Alembic::Abc::ALEMBIC_VERSION_NS::Base::getErrorHandler(), and Alembic::Abc::ALEMBIC_VERSION_NS::ErrorHandler::setPolicy().
Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::ALEMBIC_OPERATOR_BOOL | ( | valid() | ) |
The unspecified-bool-type operator casts the object to "true" if it is valid, and "false" otherwise.
|
inline |
Non-compound properties have a DataType. It is an error to call this function for CompoundProperties, and an exception will be thrown. This is a convenience function which just returns the DataType from the header that was used in creation.
Definition at line 133 of file IBaseProperty.h.
References Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::getDataType(), and Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getHeader().
const AbcA::PropertyHeader & Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getHeader | ( | ) | const |
Default copy constructor used Default assignment operator used. Return the property's header. ...
Definition at line 192 of file IBaseProperty.h.
References ALEMBIC_ABC_SAFE_CALL_BEGIN, and ALEMBIC_ABC_SAFE_CALL_END.
Referenced by Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getDataType(), Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getMetaData(), Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getName(), Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getPropertyType(), and Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getTimeSampling().
|
inline |
All properties have MetaData. This just returns the MetaData portion of the header that was used in creation.
Definition at line 126 of file IBaseProperty.h.
References Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getHeader(), and Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::getMetaData().
Referenced by Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::getArrayExtent(), and Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::getScope().
|
inline |
This function returns the property's local name ...
Definition at line 100 of file IBaseProperty.h.
References Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getHeader(), and Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::getName().
IObject Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getObject | ( | ) | const |
This function returns the property's object, handily wrapped in an IObject wrapper.
Definition at line 207 of file IBaseProperty.h.
References ALEMBIC_ABC_SAFE_CALL_BEGIN, ALEMBIC_ABC_SAFE_CALL_END, and Alembic::Abc::ALEMBIC_VERSION_NS::kWrapExisting.
|
inline |
This function returns the property's type ...
Definition at line 105 of file IBaseProperty.h.
References Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getHeader(), and Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::getPropertyType().
Referenced by Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::isArray(), Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::isCompound(), and Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::isScalar().
|
inline |
getPtr, as usual, returns a shared ptr to the underlying AbcCoreAbstract object, in this case the PROP_PTR.
Definition at line 156 of file IBaseProperty.h.
References Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::m_property.
Referenced by Alembic::Abc::ALEMBIC_VERSION_NS::ITypedArrayProperty< TRAITS >::ITypedArrayProperty(), Alembic::Abc::ALEMBIC_VERSION_NS::ITypedScalarProperty< TRAITS >::ITypedScalarProperty(), and Alembic::Abc::ALEMBIC_VERSION_NS::GetCompoundPropertyReaderPtr().
|
inline |
Non-compound properties have a TimeSamplingPtr. It is an error to call this function for CompoundProperties, and an exception will be thrown. This is a convenience function which just returns the TimeSamplingPtr from the header that was used in creation.
Definition at line 140 of file IBaseProperty.h.
References Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getHeader(), and Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::getTimeSampling().
|
inline |
Convenience to return whether the property is array. Same as getPropertyType() == kArrayProperty
Definition at line 114 of file IBaseProperty.h.
References Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getPropertyType(), and Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::kArrayProperty.
|
inline |
Convenience to return whether the property is compound. Same as getPropertyType() == kCompoundProperty
Definition at line 118 of file IBaseProperty.h.
References Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getPropertyType(), and Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::kCompoundProperty.
Referenced by Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::isSimple().
|
inline |
Convenience to return whether the property is scalar. Same as getPropertyType() == kScalarProperty
Definition at line 110 of file IBaseProperty.h.
References Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getPropertyType(), and Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::kScalarProperty.
|
inline |
Convenience to return whether the property is simple (non-compound) Same as getPropertyType() != kCompoundProperty
Definition at line 122 of file IBaseProperty.h.
References Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::isCompound().
|
inline |
Reset returns this function set to an empty, default state.
Definition at line 160 of file IBaseProperty.h.
References Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::m_property, and Alembic::Abc::ALEMBIC_VERSION_NS::Base::reset().
Referenced by Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::reset(), and Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::reset().
|
inline |
Valid returns whether this function set is valid.
Definition at line 164 of file IBaseProperty.h.
References Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::m_property, and Alembic::Abc::ALEMBIC_VERSION_NS::Base::valid().
Referenced by Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< INFO >::ISchema(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase::getTimeSampling(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICameraSchema::valid(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::valid(), and Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::valid().
|
protected |