#include <OBaseProperty.h>
Public Types | |
| typedef OBasePropertyT< PROP_PTR > | this_type |
| typedef OBasePropertyT< PROP_PTR > | operator_bool_base_type |
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 |
| OObject | getObject () const |
| PROP_PTR | getPtr () const |
| void | reset () |
| bool | valid () const |
| ALEMBIC_OPERATOR_BOOL (valid()) | |
| Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::Base | |
| ErrorHandler & | getErrorHandler () const |
| ErrorHandler::Policy | getErrorHandlerPolicy () const |
Protected Member Functions | |
| OBasePropertyT () | |
| OBasePropertyT (PROP_PTR iPtr, ErrorHandler::Policy iPolicy) | |
| Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::Base | |
| 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 |
Friends | |
| class | OCompoundProperty |
Detailed Description
class Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >
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 OBaseProperty.h.
Member Typedef Documentation
◆ operator_bool_base_type
| typedef OBasePropertyT<PROP_PTR> Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::operator_bool_base_type |
Definition at line 63 of file OBaseProperty.h.
◆ this_type
| typedef OBasePropertyT<PROP_PTR> Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::this_type |
By convention we always define this_type in Abc classes Used by unspecified-bool-type conversion below
Definition at line 62 of file OBaseProperty.h.
Constructor & Destructor Documentation
◆ OBasePropertyT() [1/2]
|
inlineprotected |
The default constructor creates an empty OBaseProperty function set. ...
Definition at line 74 of file OBaseProperty.h.
◆ OBasePropertyT() [2/2]
|
inlineprotected |
This attaches an OBaseProperty wrapper around an existing PROP_PTR, with the given error handler policy
- Parameters
-
iPtr The pointer ... iPolicy The error handling. ...
Definition at line 192 of file OBaseProperty.h.
References Alembic::Abc::ALEMBIC_VERSION_NS::Base::getErrorHandler(), m_property, and Alembic::Abc::ALEMBIC_VERSION_NS::ErrorHandler::setPolicy().
Member Function Documentation
◆ ALEMBIC_OPERATOR_BOOL()
| Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::ALEMBIC_OPERATOR_BOOL | ( | valid() | ) |
The unspecified-bool-type operator casts the object to "true" if it is valid, and "false" otherwise.
◆ getDataType()
|
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 136 of file OBaseProperty.h.
◆ getHeader()
| const AbcA::PropertyHeader & Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::getHeader | ( | ) | const |
Default copy constructor used Default assignment operator used.
Return the property's header. ...
Definition at line 211 of file OBaseProperty.h.
References ALEMBIC_ABC_SAFE_CALL_BEGIN, ALEMBIC_ABC_SAFE_CALL_END, and m_property.
Referenced by Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::BasePropertyWriterPtr >::getDataType(), Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::BasePropertyWriterPtr >::getMetaData(), Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::BasePropertyWriterPtr >::getName(), Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::BasePropertyWriterPtr >::getPropertyType(), and Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::BasePropertyWriterPtr >::getTimeSampling().
◆ getMetaData()
|
inline |
All properties have MetaData. This just returns the MetaData portion of the header that was used in creation.
Definition at line 129 of file OBaseProperty.h.
◆ getName()
|
inline |
This function returns the property's local name ...
Definition at line 102 of file OBaseProperty.h.
◆ getObject()
| OObject Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::getObject | ( | ) | const |
This function returns the property's object, handily wrapped in an OObject wrapper.
Definition at line 225 of file OBaseProperty.h.
References ALEMBIC_ABC_SAFE_CALL_BEGIN, ALEMBIC_ABC_SAFE_CALL_END, Alembic::Abc::ALEMBIC_VERSION_NS::Base::getErrorHandlerPolicy(), Alembic::Abc::ALEMBIC_VERSION_NS::kWrapExisting, and m_property.
◆ getPropertyType()
|
inline |
This function returns the property's type ...
Definition at line 107 of file OBaseProperty.h.
Referenced by Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::BasePropertyWriterPtr >::isArray(), Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::BasePropertyWriterPtr >::isCompound(), and Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::BasePropertyWriterPtr >::isScalar().
◆ getPtr()
|
inline |
Can't wrap OCompoundProperty getParent();
getPtr, as usual, returns a shared ptr to the underlying AbcCoreAbstract object, in this case the PROP_PTR.
Definition at line 162 of file OBaseProperty.h.
Referenced by Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< XformSchemaInfo >::OSchema(), Alembic::Abc::ALEMBIC_VERSION_NS::OTypedArrayProperty< BooleanTPTraits >::OTypedArrayProperty(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::OTypedGeomParam< BooleanTPTraits >::OTypedGeomParam(), Alembic::Abc::ALEMBIC_VERSION_NS::OTypedScalarProperty< BooleanTPTraits >::OTypedScalarProperty(), and Alembic::Abc::ALEMBIC_VERSION_NS::GetCompoundPropertyWriterPtr().
◆ getTimeSampling()
|
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 143 of file OBaseProperty.h.
◆ isArray()
|
inline |
Convenience to return whether the property is array. Same as getPropertyType() == kArrayProperty
Definition at line 116 of file OBaseProperty.h.
◆ isCompound()
|
inline |
Convenience to return whether the property is compound. Same as getPropertyType() == kCompoundProperty
Definition at line 120 of file OBaseProperty.h.
Referenced by Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::BasePropertyWriterPtr >::isSimple().
◆ isScalar()
|
inline |
Convenience to return whether the property is scalar. Same as getPropertyType() == kScalarProperty
Definition at line 112 of file OBaseProperty.h.
◆ isSimple()
|
inline |
Convenience to return whether the property is simple (non-compound) Same as getPropertyType() != kCompoundProperty
Definition at line 125 of file OBaseProperty.h.
◆ reset()
|
inline |
Reset returns this function set to an empty, default state.
Definition at line 166 of file OBaseProperty.h.
◆ valid()
|
inline |
Valid returns whether this function set is valid.
Definition at line 170 of file OBaseProperty.h.
Friends And Related Symbol Documentation
◆ OCompoundProperty
|
friend |
Definition at line 66 of file OBaseProperty.h.
Member Data Documentation
◆ m_property
|
protected |
Definition at line 180 of file OBaseProperty.h.
Referenced by OBasePropertyT(), getHeader(), and getObject().
The documentation for this class was generated from the following file:
- opt/local/include/Alembic/Abc/OBaseProperty.h
