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

#include <IGeomBase.h>

+ Inheritance diagram for Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase:

Classes

class  Sample
 

Public Types

typedef IGeomBase this_type
 
- Public Types inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< GeomBaseSchemaInfo >
typedef GeomBaseSchemaInfo info_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< GeomBaseSchemaInfo >
typedef GeomBaseSchemaInfo info_type
 
typedef ISchema
< GeomBaseSchemaInfo > 
this_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
typedef ICompoundProperty this_type
 

Public Member Functions

 IGeomBase ()
 The default constructor creates an empty GeomBase. More...
 
template<class CPROP_PTR >
 IGeomBase (CPROP_PTR iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 
template<class CPROP_PTR >
 IGeomBase (CPROP_PTR iThis, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 
template<class CPROP_PTR >
 IGeomBase (CPROP_PTR iThis, Abc::WrapExistingFlag iFlag, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 
 IGeomBase (const IGeomBase &iCopy)
 Copy constructor. More...
 
size_t getNumSamples () const
 Default assignment operator used. More...
 
bool isConstant () const
 
AbcA::TimeSamplingPtr getTimeSampling () const
 
void get (Sample &oSample, const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
 
Sample getValue (const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
 
Abc::ICompoundProperty getArbGeomParams () const
 
Abc::ICompoundProperty getUserProperties () const
 
void reset ()
 
bool valid () const
 
 ALEMBIC_OVERRIDE_OPERATOR_BOOL (IGeomBase::valid())
 
- Public Member Functions inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< GeomBaseSchemaInfo >
 IGeomBaseSchema ()
 
 IGeomBaseSchema (CPROP_PTR iParentCompound, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 IGeomBaseSchema (CPROP_PTR iParentCompound, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 IGeomBaseSchema (CPROP_PTR iThis, Abc::WrapExistingFlag iFlag, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 Wrap an existing schema object. More...
 
 IGeomBaseSchema (const IGeomBaseSchema &iCopy)
 Copy constructor. More...
 
void init (const Abc::Argument &iArg0, const Abc::Argument &iArg1)
 
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< GeomBaseSchemaInfo >
 ISchema ()
 
 ISchema (CPROP_PTR iParentObject, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 ISchema (CPROP_PTR iParentObject, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 ISchema (CPROP_PTR 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 ()
 
template<class CPROP_PTR >
 ICompoundProperty (CPROP_PTR iParentProp, const std::string &iName, const Argument &iArg0=Argument())
 
template<class CPROP_PTR >
 ICompoundProperty (CPROP_PTR iThisObject, WrapExistingFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
template<class OBJECT_PTR >
 ICompoundProperty (OBJECT_PTR iThisObject, 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::PropertyHeadergetPropertyHeader (size_t i) const
 
const AbcA::PropertyHeadergetPropertyHeader (const std::string &iName) const
 
ICompoundProperty getParent () const
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >
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
 
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
ErrorHandlergetErrorHandler () const
 
ErrorHandler::Policy getErrorHandlerPolicy () const
 

Static Public Member Functions

static bool matches (const AbcA::MetaData &iMetaData, SchemaInterpMatching iMatching=kStrictMatching)
 
static bool matches (const AbcA::PropertyHeader &iHeader, SchemaInterpMatching iMatching=kStrictMatching)
 
- Static Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< GeomBaseSchemaInfo >
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)
 

Additional Inherited Members

- 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::CompoundPropertyReaderPtriPtr, WrapExistingFlag iWrapFlag, 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::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< GeomBaseSchemaInfo >
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
 

Detailed Description

IGeomBase - A generic base set of properties and methods that encapsulate things common to AbcGeom types that have a physical volume.

  • self bounds
  • children bounds (optional)
  • argbGeomParams (optional)
  • userProperties (optional) This class is a concrete instantiation of IGeomBaseSchema. Your archive might contain PolyMesh and SubD and Curves and Points objects etc. This class, IGeomBase, gives you access to the generic parts of those objects. For example, if you just wish to iterate through an archive's hierarchy to examine bounding regions this class could be helpful to you. Then when you actually need to access the real data in the geometric type you can always create the needed type of I<geom type> object> via kWrapExisting.

Definition at line 210 of file IGeomBase.h.

Member Typedef Documentation

Constructor & Destructor Documentation

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase::IGeomBase ( )
inline

The default constructor creates an empty GeomBase.

By convention we always define this_type in AbcGeom classes. Used by unspecified-bool-type conversion below

Definition at line 244 of file IGeomBase.h.

template<class CPROP_PTR >
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase::IGeomBase ( CPROP_PTR  iParent,
const std::string iName,
const Abc::Argument iArg0 = Abc::Argument(),
const Abc::Argument iArg1 = Abc::Argument() 
)
inline

Definition at line 247 of file IGeomBase.h.

template<class CPROP_PTR >
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase::IGeomBase ( CPROP_PTR  iThis,
const Abc::Argument iArg0 = Abc::Argument(),
const Abc::Argument iArg1 = Abc::Argument() 
)
inlineexplicit

Definition at line 260 of file IGeomBase.h.

template<class CPROP_PTR >
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase::IGeomBase ( CPROP_PTR  iThis,
Abc::WrapExistingFlag  iFlag,
const Abc::Argument iArg0 = Abc::Argument(),
const Abc::Argument iArg1 = Abc::Argument() 
)
inlineexplicit

Definition at line 271 of file IGeomBase.h.

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase::IGeomBase ( const IGeomBase iCopy)
inline

Copy constructor.

Definition at line 283 of file IGeomBase.h.

Member Function Documentation

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase::ALEMBIC_OVERRIDE_OPERATOR_BOOL ( IGeomBase::  valid())

unspecified-bool-type operator overload. ...

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase::get ( Sample oSample,
const Abc::ISampleSelector iSS = Abc::ISampleSelector() 
) const
inline

Definition at line 322 of file IGeomBase.h.

Abc::ICompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase::getArbGeomParams ( ) const
inline

Definition at line 341 of file IGeomBase.h.

size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase::getNumSamples ( ) const
inline

Default assignment operator used.

Return the number of samples contained in the property. This can be any number, including zero. This returns the number of samples that were written, independently of whether or not they were constant.

Definition at line 299 of file IGeomBase.h.

AbcA::TimeSamplingPtr Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase::getTimeSampling ( ) const
inline

Time sampling Information.

Definition at line 309 of file IGeomBase.h.

Abc::ICompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase::getUserProperties ( ) const
inline

Definition at line 344 of file IGeomBase.h.

Sample Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase::getValue ( const Abc::ISampleSelector iSS = Abc::ISampleSelector()) const
inline

Definition at line 333 of file IGeomBase.h.

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase::isConstant ( ) const
inline

Ask if we're constant - no change in value amongst samples, regardless of the time sampling.

Definition at line 304 of file IGeomBase.h.

static bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase::matches ( const AbcA::MetaData iMetaData,
SchemaInterpMatching  iMatching = kStrictMatching 
)
inlinestatic

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

Definition at line 371 of file IGeomBase.h.

static bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase::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 390 of file IGeomBase.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase::reset ( )
inlinevirtual

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

Reimplemented from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< GeomBaseSchemaInfo >.

Definition at line 349 of file IGeomBase.h.

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBase::valid ( ) const
inlinevirtual

Valid returns whether this function set is valid.

Reimplemented from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< GeomBaseSchemaInfo >.

Definition at line 357 of file IGeomBase.h.


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