Alembic Version 1.1

Public Types | Public Member Functions | Protected Attributes | List of all members
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO > Class Template Reference

`#include <IGeomBase.h>`

Inheritance diagram for Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >:
[legend]
Collaboration diagram for Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >:
[legend]

## Public Types
typedef INFO | info_type
Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< INFO >
typedef INFO | info_type
typedef ISchema< INFO > | this_type
Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
typedef ICompoundProperty | this_type

## Public Member Functions
| IGeomBaseSchema ()
| IGeomBaseSchema (const ICompoundProperty &iParent, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
| IGeomBaseSchema (const ICompoundProperty &iProp, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
| Wrap an existing schema object. More...
| IGeomBaseSchema (const ICompoundProperty &iProp, Abc::WrapExistingFlag iFlag, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
| IGeomBaseSchema (const IGeomBaseSchema &iCopy)
| Copy constructor. More...
void | init (const Abc::Argument &iArg0, const Abc::Argument &iArg1)
virtual void | reset ()
virtual bool | valid () const
Abc::IBox3dProperty | getSelfBoundsProperty () const
Abc::IBox3dProperty | getChildBoundsProperty () const
ICompoundProperty | getArbGeomParams () const
ICompoundProperty | getUserProperties () const
Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< INFO >
| ISchema ()
| ISchema (const ICompoundProperty &iParent, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
| ISchema (const ICompoundProperty &iProperty, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
| ISchema (const ICompoundProperty &iProperty, WrapExistingFlag iFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
virtual | ~ISchema ()
Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
| ICompoundProperty ()
| ICompoundProperty (const ICompoundProperty &iParent, const std::string &iName, const Argument &iArg0=Argument())
| ICompoundProperty (AbcA::CompoundPropertyReaderPtr iPtr, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
| ICompoundProperty (AbcA::CompoundPropertyReaderPtr iPtr, WrapExistingFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
| ICompoundProperty (const IObject &iObject, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
| ICompoundProperty (const IObject &iObject, TopFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
| ~ICompoundProperty ()
size_t | getNumProperties () const
| Returns the number of properties contained in this ICompoundProperty. More...
const AbcA::PropertyHeader & | getPropertyHeader (size_t i) const
const AbcA::PropertyHeader * | getPropertyHeader (const std::string &iName) const
ICompoundProperty | getParent () const
Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >
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
AbcA::CompoundPropertyReaderPtr | 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 Attributes
Abc::IBox3dProperty | m_selfBoundsProperty
Abc::IBox3dProperty | m_childBoundsProperty
Abc::ICompoundProperty | m_arbGeomParams
Abc::ICompoundProperty | m_userProperties
Protected Attributes inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >
AbcA::CompoundPropertyReaderPtr | m_property

## Additional Inherited Members
Static Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< INFO >
static const char * | getSchemaTitle ()
static const char * | getDefaultSchemaName ()
static bool | matches (const AbcA::MetaData &iMetaData, SchemaInterpMatching iMatching=kStrictMatching)
static bool | matches (const AbcA::PropertyHeader &iHeader, SchemaInterpMatching iMatching=kStrictMatching)
Protected Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >
typedef IBasePropertyT< AbcA::CompoundPropertyReaderPtr > | this_type
typedef IBasePropertyT< AbcA::CompoundPropertyReaderPtr > | operator_bool_base_type
Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >
| IBasePropertyT ()
| IBasePropertyT (AbcA::CompoundPropertyReaderPtr 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 ()

## Detailed Description

template<class INFO>
class Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >

This class holds properties common to all geometric classes that have a physical volume.

- selfBounds
- childBounds (optional)
- GeomParams (optional)
- UserProperties (optional)

This class is used to encapsulate common functionality of the real Geometry schema classes, like IPoints and IPolyMesh and so on

Definition at line 60 of file IGeomBase.h.

## Member Typedef Documentation

## ◆ info_type

template<class INFO >

typedef INFO Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::info_type

Definition at line 67 of file IGeomBase.h.

## Constructor & Destructor Documentation

## ◆ IGeomBaseSchema() [1/5]

template<class INFO >

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::IGeomBaseSchema | ( |  | ) |
| inline

The default constructor creates an empty ISchema. Used to create "NULL/invalid" instances.

Definition at line 76 of file IGeomBase.h.

## ◆ IGeomBaseSchema() [2/5]

template<class INFO >

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::IGeomBaseSchema | ( | const ICompoundProperty & | iParent,
|  | const std::string & | iName,
|  | const Argument & | iArg0 = `Argument()`,
|  | const Argument & | iArg1 = `Argument()`
| ) |  |
| inline

Delegates to Abc/ISchema, and then creates properties that are present.

Definition at line 80 of file IGeomBase.h.

References Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::init().

Here is the call graph for this function:

## ◆ IGeomBaseSchema() [3/5]

template<class INFO >

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::IGeomBaseSchema | ( | const ICompoundProperty & | iProp,
|  | const Abc::Argument & | iArg0 = `Abc::Argument()`,
|  | const Abc::Argument & | iArg1 = `Abc::Argument()`
| ) |  |
| inline

Wrap an existing schema object.

Definition at line 90 of file IGeomBase.h.

References Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::init().

Here is the call graph for this function:

## ◆ IGeomBaseSchema() [4/5]

template<class INFO >

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::IGeomBaseSchema | ( | const ICompoundProperty & | iProp,
|  | Abc::WrapExistingFlag | iFlag,
|  | const Abc::Argument & | iArg0 = `Abc::Argument()`,
|  | const Abc::Argument & | iArg1 = `Abc::Argument()`
| ) |  |
| inline

Definition at line 99 of file IGeomBase.h.

References Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::init().

Here is the call graph for this function:

## ◆ IGeomBaseSchema() [5/5]

template<class INFO >

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::IGeomBaseSchema | ( | const IGeomBaseSchema< INFO > & | iCopy | ) |
| inline

Copy constructor.

Definition at line 109 of file IGeomBase.h.

## Member Function Documentation

## ◆ getArbGeomParams()

template<class INFO >

ICompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::getArbGeomParams | ( |  | ) | const
| inline

Definition at line 175 of file IGeomBase.h.

References Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::m_arbGeomParams.

## ◆ getChildBoundsProperty()

template<class INFO >

Abc::IBox3dProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::getChildBoundsProperty | ( |  | ) | const
| inline

Definition at line 168 of file IGeomBase.h.

References Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::m_childBoundsProperty.

## ◆ getSelfBoundsProperty()

template<class INFO >

Abc::IBox3dProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::getSelfBoundsProperty | ( |  | ) | const
| inline

Definition at line 163 of file IGeomBase.h.

References Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::m_selfBoundsProperty.

## ◆ getUserProperties()

template<class INFO >

ICompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::getUserProperties | ( |  | ) | const
| inline

Definition at line 179 of file IGeomBase.h.

References Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::m_userProperties.

## ◆ init()

template<class INFO >

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::init | ( | const Abc::Argument & | iArg0,
|  | const Abc::Argument & | iArg1
| ) |  |
| inline

Definition at line 115 of file IGeomBase.h.

References ALEMBIC_ABC_SAFE_CALL_BEGIN, ALEMBIC_ABC_SAFE_CALL_END, Alembic::Abc::ALEMBIC_VERSION_NS::Arguments::getErrorHandlerPolicy(), Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty::getPropertyHeader(), Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >::getPtr(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::m_arbGeomParams, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::m_childBoundsProperty, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::m_selfBoundsProperty, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::m_userProperties, and Alembic::Abc::ALEMBIC_VERSION_NS::Argument::setInto().

Referenced by Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::IGeomBaseSchema().

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ reset()

template<class INFO >

virtual void Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::reset | ( |  | ) |
| inline virtual

Reimplemented in Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IFaceSetSchema, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase, Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema, and Alembic::AbcGeom::ALEMBIC_VERSION_NS::ISubDSchema.

Definition at line 147 of file IGeomBase.h.

References Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::m_arbGeomParams, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::m_childBoundsProperty, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::m_selfBoundsProperty, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::m_userProperties, Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >::reset(), and Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::reset().

Referenced by Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::reset(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::IFaceSetSchema::reset(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase::reset(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::reset(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::reset(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::reset(), and Alembic::AbcGeom::ALEMBIC_VERSION_NS::ISubDSchema::reset().

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ valid()

template<class INFO >

virtual bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::valid | ( |  | ) | const
| inline virtual

Reimplemented in Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IFaceSetSchema, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase, Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema, and Alembic::AbcGeom::ALEMBIC_VERSION_NS::ISubDSchema.

Definition at line 156 of file IGeomBase.h.

References Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::m_selfBoundsProperty, and Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::valid().

Referenced by Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::valid(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::IFaceSetSchema::valid(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::valid(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPointsSchema::valid(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::valid(), and Alembic::AbcGeom::ALEMBIC_VERSION_NS::ISubDSchema::valid().

Here is the call graph for this function:
Here is the caller graph for this function:

## Member Data Documentation

## ◆ m_arbGeomParams

template<class INFO >

Abc::ICompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::m_arbGeomParams
| protected

Definition at line 186 of file IGeomBase.h.

Referenced by Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::getArbGeomParams(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::init(), and Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::reset().

## ◆ m_childBoundsProperty

template<class INFO >

Abc::IBox3dProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::m_childBoundsProperty
| protected

Definition at line 184 of file IGeomBase.h.

Referenced by Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::getChildBoundsProperty(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::init(), and Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::reset().

## ◆ m_selfBoundsProperty

template<class INFO >

Abc::IBox3dProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::m_selfBoundsProperty
| protected

Definition at line 183 of file IGeomBase.h.

Referenced by Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::getSelfBoundsProperty(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::init(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::reset(), and Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::valid().

## ◆ m_userProperties

template<class INFO >

Abc::ICompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::m_userProperties
| protected

Definition at line 187 of file IGeomBase.h.

Referenced by Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::getUserProperties(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::init(), and Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< INFO >::reset().

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

- opt/local/include/Alembic/AbcGeom/IGeomBase.h