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

#include <IPolyMesh.h>

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

Classes

class  Sample
 

Public Types

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

Public Member Functions

 IPolyMeshSchema ()
 
template<class CPROP_PTR >
 IPolyMeshSchema (CPROP_PTR iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 
template<class CPROP_PTR >
 IPolyMeshSchema (CPROP_PTR iParent, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 
template<class CPROP_PTR >
 IPolyMeshSchema (CPROP_PTR iThis, Abc::WrapExistingFlag iFlag, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 Wrap an existing schema object. More...
 
 IPolyMeshSchema (const IPolyMeshSchema &iCopy)
 Copy constructor. More...
 
const IPolyMeshSchemaoperator= (const IPolyMeshSchema &rhs)
 
size_t getNumSamples () const
 
MeshTopologyVariance getTopologyVariance () const
 
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
 
IV2fGeomParam getUVsParam () const
 
IN3fGeomParam getNormalsParam () const
 
Abc::IInt32ArrayProperty getFaceCountsProperty () const
 
Abc::IInt32ArrayProperty getFaceIndicesProperty () const
 
Abc::IP3fArrayProperty getPositionsProperty () const
 
Abc::IV3fArrayProperty getVelocitiesProperty () const
 
void reset ()
 
bool valid () const
 
void getFaceSetNames (std::vector< std::string > &oFaceSetNames)
 Appends the names of any FaceSets for this PolyMesh. More...
 
IFaceSet getFaceSet (const std::string &iFaceSetName)
 
bool hasFaceSet (const std::string &iFaceSetName)
 
 ALEMBIC_OVERRIDE_OPERATOR_BOOL (IPolyMeshSchema::valid())
 
- Public Member Functions inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< PolyMeshSchemaInfo >
 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< PolyMeshSchemaInfo >
 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)
 
void loadFaceSetNames ()
 
- 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::IP3fArrayProperty m_positionsProperty
 
Abc::IV3fArrayProperty m_velocitiesProperty
 
Abc::IInt32ArrayProperty m_indicesProperty
 
Abc::IInt32ArrayProperty m_countsProperty
 
IV2fGeomParam m_uvsParam
 
IN3fGeomParam m_normalsParam
 
bool m_faceSetsLoaded
 
std::map< std::string, IFaceSetm_faceSets
 
Alembic::Util::mutex m_faceSetsMutex
 
- Protected Attributes inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< PolyMeshSchemaInfo >
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< PolyMeshSchemaInfo >
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 IPolyMesh.h.

Member Typedef Documentation

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

Definition at line 101 of file IPolyMesh.h.

Constructor & Destructor Documentation

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::IPolyMeshSchema ( )
inline

The default constructor creates an empty OPolyMeshSchema ...

Definition at line 109 of file IPolyMesh.h.

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

This templated, explicit function creates a new scalar property reader. The first argument is any Abc (or AbcCoreAbstract) object which can intrusively be converted to an CompoundPropertyReaderPtr 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 119 of file IPolyMesh.h.

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

This constructor is the same as above, but with default schema name used.

Definition at line 133 of file IPolyMesh.h.

template<class CPROP_PTR >
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::IPolyMeshSchema ( 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 144 of file IPolyMesh.h.

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

Copy constructor.

Definition at line 155 of file IPolyMesh.h.

Member Function Documentation

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

unspecified-bool-type operator overload. ...

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

Definition at line 194 of file IPolyMesh.h.

Abc::IInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::getFaceCountsProperty ( ) const
inline

Definition at line 232 of file IPolyMesh.h.

Abc::IInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::getFaceIndicesProperty ( ) const
inline

Definition at line 237 of file IPolyMesh.h.

IFaceSet Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::getFaceSet ( const std::string iFaceSetName)
void Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::getFaceSetNames ( std::vector< std::string > &  oFaceSetNames)

Appends the names of any FaceSets for this PolyMesh.

IN3fGeomParam Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::getNormalsParam ( ) const
inline

Definition at line 227 of file IPolyMesh.h.

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

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 167 of file IPolyMesh.h.

Abc::IP3fArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::getPositionsProperty ( ) const
inline

Definition at line 242 of file IPolyMesh.h.

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

Time information. Any of the properties could be the bearer of the time sampling information, which otherwise defaults to Identity.

Definition at line 181 of file IPolyMesh.h.

MeshTopologyVariance Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::getTopologyVariance ( ) const

Return the topological variance. This indicates how the mesh may change.

IV2fGeomParam Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::getUVsParam ( ) const
inline

Definition at line 222 of file IPolyMesh.h.

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

Definition at line 215 of file IPolyMesh.h.

Abc::IV3fArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::getVelocitiesProperty ( ) const
inline

Definition at line 247 of file IPolyMesh.h.

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::hasFaceSet ( const std::string iFaceSetName)
void Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::init ( const Abc::Argument iArg0,
const Abc::Argument iArg1 
)
protected
bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::isConstant ( ) const
inline

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

Definition at line 176 of file IPolyMesh.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::loadFaceSetNames ( )
protected
const IPolyMeshSchema& Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::operator= ( const IPolyMeshSchema rhs)
void Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::reset ( )
inlinevirtual

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

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

Definition at line 260 of file IPolyMesh.h.

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

Valid returns whether this function set is valid.

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

Definition at line 275 of file IPolyMesh.h.

Member Data Documentation

Abc::IInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::m_countsProperty
protected

Definition at line 300 of file IPolyMesh.h.

std::map<std::string, IFaceSet> Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::m_faceSets
protected

Definition at line 308 of file IPolyMesh.h.

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::m_faceSetsLoaded
protected

Definition at line 307 of file IPolyMesh.h.

Alembic::Util::mutex Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::m_faceSetsMutex
protected

Definition at line 309 of file IPolyMesh.h.

Abc::IInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::m_indicesProperty
protected

Definition at line 299 of file IPolyMesh.h.

IN3fGeomParam Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::m_normalsParam
protected

Definition at line 303 of file IPolyMesh.h.

Abc::IP3fArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::m_positionsProperty
protected

Definition at line 297 of file IPolyMesh.h.

IV2fGeomParam Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::m_uvsParam
protected

Definition at line 302 of file IPolyMesh.h.

Abc::IV3fArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::m_velocitiesProperty
protected

Definition at line 298 of file IPolyMesh.h.


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