HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< INFO > Class Template Reference

#include <OSchema.h>

+ Inheritance diagram for Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< INFO >:

Public Types

typedef INFO info_type
 
typedef OSchema< INFO > this_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty
typedef OCompoundProperty this_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >
typedef OBasePropertyT
< AbcA::CompoundPropertyWriterPtr
this_type
 
typedef OBasePropertyT
< AbcA::CompoundPropertyWriterPtr
operator_bool_base_type
 

Public Member Functions

 OSchema ()
 
template<class CPROP_PTR >
 OSchema (CPROP_PTR iParentObject, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument())
 
template<class CPROP_PTR >
 OSchema (CPROP_PTR iParentObject, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument())
 
virtual ~OSchema ()
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty
 OCompoundProperty ()
 
template<class CPROP_PTR >
 OCompoundProperty (CPROP_PTR iParentObject, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
template<class CPROP_PTR >
 OCompoundProperty (CPROP_PTR iThisObject, WrapExistingFlag iWrapFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
template<class OBJECT_PTR >
 OCompoundProperty (OBJECT_PTR iObject, TopFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 ~OCompoundProperty ()
 
size_t getNumProperties () const
 
const AbcA::PropertyHeadergetPropertyHeader (size_t i) const
 
const AbcA::PropertyHeadergetPropertyHeader (const std::string &iName) const
 
OBaseProperty getProperty (size_t i) const
 
OBaseProperty getProperty (const std::string &iName) const
 
OCompoundProperty getParent () const
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >
const AbcA::PropertyHeadergetHeader () const
 
const std::stringgetName () const
 
AbcA::PropertyType getPropertyType () const
 
bool isScalar () const
 
bool isArray () const
 
bool isCompound () const
 
bool isSimple () const
 
const AbcA::MetaDatagetMetaData () const
 
const AbcA::DataTypegetDataType () const
 
AbcA::TimeSamplingPtr getTimeSampling () const
 
OObject getObject () const
 
AbcA::CompoundPropertyWriterPtr getPtr () const
 
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
 

Static Public Member Functions

static const char * getSchemaTitle ()
 
static const char * getSchemaBaseType ()
 
static const char * getDefaultSchemaName ()
 
static bool matches (const AbcA::MetaData &iMetaData, SchemaInterpMatching iMatching=kStrictMatching)
 
static bool matches (const AbcA::PropertyHeader &iHeader, SchemaInterpMatching iMatching=kStrictMatching)
 

Additional Inherited Members

- Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >
 OBasePropertyT ()
 
 OBasePropertyT (AbcA::CompoundPropertyWriterPtriPtr, WrapExistingFlag, ErrorHandler::Policy iPolicy)
 
- 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 ()
 
- Protected Attributes inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >
AbcA::CompoundPropertyWriterPtr m_property
 

Detailed Description

template<class INFO>
class Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< INFO >

Usually used as a base class, but could also theoretically be used as a standalone

Definition at line 98 of file OSchema.h.

Member Typedef Documentation

template<class INFO>
typedef INFO Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< INFO >::info_type

Definition at line 105 of file OSchema.h.

template<class INFO>
typedef OSchema<INFO> Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< INFO >::this_type

Definition at line 106 of file OSchema.h.

Constructor & Destructor Documentation

template<class INFO>
Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< INFO >::OSchema ( )
inline

The default constructor creates an empty OSchema function set.

Definition at line 161 of file OSchema.h.

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

Creates a new Compound Property Writer with the schema information added to the metadata.

Definition at line 166 of file OSchema.h.

template<class INFO>
template<class CPROP_PTR >
Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< INFO >::OSchema ( CPROP_PTR  iParentObject,
const Argument iArg0 = Argument(),
const Argument iArg1 = Argument(),
const Argument iArg2 = Argument() 
)
inlineexplicit

Creates a new Compound Property Writer with the schema information and also the default name.

Definition at line 179 of file OSchema.h.

template<class INFO>
virtual Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< INFO >::~OSchema ( )
inlinevirtual

Definition at line 190 of file OSchema.h.

Member Function Documentation

template<class INFO>
static const char* Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< INFO >::getDefaultSchemaName ( )
inlinestatic

Return the default name for instances of this schema. Often something like ".geom"

Definition at line 124 of file OSchema.h.

template<class INFO>
static const char* Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< INFO >::getSchemaBaseType ( )
inlinestatic

Return the schema base type expected of this property. An empty base type means it's the root type.

Definition at line 117 of file OSchema.h.

template<class INFO>
static const char* Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< INFO >::getSchemaTitle ( )
inlinestatic

Return the schema title expected of this property. An empty title matches everything

Definition at line 110 of file OSchema.h.

template<class INFO>
static bool Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< INFO >::matches ( const AbcA::MetaData iMetaData,
SchemaInterpMatching  iMatching = kStrictMatching 
)
inlinestatic

This will check whether or not a given entity (as represented by a metadata) strictly matches the interpretation of this schema object

Definition at line 132 of file OSchema.h.

template<class INFO>
static bool Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< INFO >::matches ( const AbcA::PropertyHeader iHeader,
SchemaInterpMatching  iMatching = kStrictMatching 
)
inlinestatic

This will check whether or not a given object (as represented by an object header) strictly matches the interpretation of this schema object, as well as the data type.

Definition at line 149 of file OSchema.h.


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