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

#include <IFaceSet.h>

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

Classes

class  Sample
 

Public Types

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

Public Member Functions

 IFaceSetSchema ()
 
template<class CPROP_PTR >
 IFaceSetSchema (CPROP_PTR iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 
template<class CPROP_PTR >
 IFaceSetSchema (CPROP_PTR iParent, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 
template<class CPROP_PTR >
 IFaceSetSchema (CPROP_PTR iThis, Abc::WrapExistingFlag iFlag, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 wrap an existing schema object More...
 
 IFaceSetSchema (const IFaceSetSchema &iCopy)
 Copy constructor. (explicit copy ctor for msvc bug workaround) More...
 
bool isConstant () const
 Default assignment operator used. More...
 
size_t getNumSamples () const
 
AbcA::TimeSamplingPtr getTimeSampling () const
 Return the time sampling. More...
 
void get (Sample &iSamp, const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
 
Sample getValue (const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
 
FaceSetExclusivity getFaceExclusivity () const
 
Abc::IInt32ArrayProperty getFacesProperty () const
 
void reset ()
 
bool valid () const
 
 ALEMBIC_OVERRIDE_OPERATOR_BOOL (IFaceSetSchema::valid())
 
- Public Member Functions inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< FaceSetSchemaInfo >
 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< FaceSetSchemaInfo >
 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
 

Protected Member Functions

void init (const Abc::Argument &iArg0, const Abc::Argument &iArg1)
 
- 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

Abc::IInt32ArrayProperty m_facesProperty
 
- Protected Attributes inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< FaceSetSchemaInfo >
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< FaceSetSchemaInfo >
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
 

Detailed Description

Definition at line 52 of file IFaceSet.h.

Member Typedef Documentation

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

Definition at line 103 of file IFaceSet.h.

Constructor & Destructor Documentation

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IFaceSetSchema::IFaceSetSchema ( )
inline

The default constructor creates an empty IFaceSetSchema ...

Definition at line 111 of file IFaceSet.h.

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

This templated, primary constructor creates a new faceset reader. The first argument is any Abc (or AbcCoreAbstract) object which can intrusively be converted to an CompoundPropertyWriterPtr to use as a parent, from which the error handler policy for inheritance is also derived. The remaining optional arguments can be used to override the ErrorHandlerPolicy and to specify schema interpretation matching.

Definition at line 121 of file IFaceSet.h.

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

Same constructor as above, but use the default schema name, ie, ".geom".

Definition at line 135 of file IFaceSet.h.

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

wrap an existing schema object

Definition at line 146 of file IFaceSet.h.

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

Copy constructor. (explicit copy ctor for msvc bug workaround)

Definition at line 157 of file IFaceSet.h.

Member Function Documentation

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

unspecified-bool-type operator overload. ...

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::IFaceSetSchema::get ( Sample iSamp,
const Abc::ISampleSelector iSS = Abc::ISampleSelector() 
) const
FaceSetExclusivity Alembic::AbcGeom::ALEMBIC_VERSION_NS::IFaceSetSchema::getFaceExclusivity ( ) const
Abc::IInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IFaceSetSchema::getFacesProperty ( ) const
inline

Definition at line 201 of file IFaceSet.h.

size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::IFaceSetSchema::getNumSamples ( ) const

Get number of samples written so far. ...

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

Return the time sampling.

Definition at line 182 of file IFaceSet.h.

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

Definition at line 192 of file IFaceSet.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::IFaceSetSchema::init ( const Abc::Argument iArg0,
const Abc::Argument iArg1 
)
protected
bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::IFaceSetSchema::isConstant ( ) const
inline

Default assignment operator used.

if isConstant() is true, the mesh contains no time-varying values

Definition at line 171 of file IFaceSet.h.

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

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

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

Definition at line 214 of file IFaceSet.h.

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

Valid returns whether this function set is valid.

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

Definition at line 223 of file IFaceSet.h.

Member Data Documentation

Abc::IInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IFaceSetSchema::m_facesProperty
protected

Definition at line 236 of file IFaceSet.h.


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