Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema Class Reference

`#include <IPolyMesh.h>`

Inheritance diagram for Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema:
[legend]
Collaboration diagram for Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema:
[legend]

## 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 ()
| IPolyMeshSchema (const ICompoundProperty &iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
| IPolyMeshSchema (const ICompoundProperty &iProp, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
| IPolyMeshSchema (const IPolyMeshSchema &iCopy)
| Copy constructor. More...
const IPolyMeshSchema & | operator= (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 (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< PolyMeshSchemaInfo >
| 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 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::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 ()

## 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, IFaceSet > | m_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

## this_type

typedef IPolyMeshSchema Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::this_type

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

## IPolyMeshSchema() [1/4]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::IPolyMeshSchema | ( |  | ) |

inline

The default constructor creates an empty OPolyMeshSchema ...

Definition at line 109 of file IPolyMesh.h.

## IPolyMeshSchema() [2/4]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::IPolyMeshSchema | ( | const ICompoundProperty & | iParent,
|  | const std::string & | iName,
|  | const Abc::Argument & | iArg0 = `Abc::Argument()`,
|  | const Abc::Argument & | iArg1 = `Abc::Argument()`
| ) |  |

inline

This constructor creates a new mesh reader. The first argument is the parent ICompoundProperty, from which the error handler policy for is derived. The second argument is the name of the ICompoundProperty that contains this schemas properties. The remaining optional arguments can be used to override the ErrorHandlerPolicy and to specify schema interpretation matching.

Definition at line 117 of file IPolyMesh.h.

## IPolyMeshSchema() [3/4]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::IPolyMeshSchema | ( | const ICompoundProperty & | iProp,
|  | const Abc::Argument & | iArg0 = `Abc::Argument()`,
|  | const Abc::Argument & | iArg1 = `Abc::Argument()`
| ) |  |

inline

This constructor wraps an existing ICompoundProperty as the mesh reader, and the error handler policy is derived from it. The remaining optional arguments can be used to override the ErrorHandlerPolicy and to specify schema interpretation matching.

Definition at line 131 of file IPolyMesh.h.

## IPolyMeshSchema() [4/4]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::IPolyMeshSchema | ( | const IPolyMeshSchema & | iCopy | ) |

inline

Copy constructor.

Definition at line 140 of file IPolyMesh.h.

## Member Function Documentation

## ALEMBIC_OVERRIDE_OPERATOR_BOOL()

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

unspecified-bool-type operator overload. ...

## get()

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

inline

Definition at line 179 of file IPolyMesh.h.

References ALEMBIC_ABC_SAFE_CALL_BEGIN, ALEMBIC_ABC_SAFE_CALL_END, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::Sample::m_counts, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::Sample::m_indices, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::Sample::m_positions, Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::Sample::m_selfBounds, and Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::Sample::m_velocities.

## getFaceCountsProperty()

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

inline

Definition at line 217 of file IPolyMesh.h.

## getFaceIndicesProperty()

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

inline

Definition at line 222 of file IPolyMesh.h.

## getFaceSet()

IFaceSet Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::getFaceSet | ( | const std::string & | iFaceSetName | ) |

## getFaceSetNames()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::getFaceSetNames | ( | std::vector< std::string > & | oFaceSetNames | ) |

Appends the names of any FaceSets for this PolyMesh.

## getNormalsParam()

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

inline

Definition at line 212 of file IPolyMesh.h.

## getNumSamples()

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

## getPositionsProperty()

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

inline

Definition at line 227 of file IPolyMesh.h.

## getTimeSampling()

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

## getTopologyVariance()

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

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

## getUVsParam()

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

inline

Definition at line 207 of file IPolyMesh.h.

## getValue()

Sample Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::getValue | ( | const Abc::ISampleSelector & | iSS = `Abc::ISampleSelector()` | ) | const

inline

Definition at line 200 of file IPolyMesh.h.

## getVelocitiesProperty()

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

inline

Definition at line 232 of file IPolyMesh.h.

## hasFaceSet()

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::hasFaceSet | ( | const std::string & | iFaceSetName | ) |

## init()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::init | ( | const Abc::Argument & | iArg0,
|  | const Abc::Argument & | iArg1
| ) |  |

protected

## isConstant()

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

References Alembic::AbcGeom::ALEMBIC_VERSION_NS::kConstantTopology.

## loadFaceSetNames()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::loadFaceSetNames | ( |  | ) |

protected

## operator=()

const IPolyMeshSchema & Alembic::AbcGeom::ALEMBIC_VERSION_NS::IPolyMeshSchema::operator= | ( | const IPolyMeshSchema & | rhs | ) |

## reset()

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

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

Here is the call graph for this function:

## valid()

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

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

Here is the call graph for this function:

## Member Data Documentation

## m_countsProperty

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

protected

Definition at line 285 of file IPolyMesh.h.

## m_faceSets

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

protected

Definition at line 293 of file IPolyMesh.h.

## m_faceSetsLoaded

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

protected

Definition at line 292 of file IPolyMesh.h.

## m_faceSetsMutex

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

protected

Definition at line 294 of file IPolyMesh.h.

## m_indicesProperty

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

protected

Definition at line 284 of file IPolyMesh.h.

## m_normalsParam

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

protected

Definition at line 288 of file IPolyMesh.h.

## m_positionsProperty

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

protected

Definition at line 282 of file IPolyMesh.h.

## m_uvsParam

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

protected

Definition at line 287 of file IPolyMesh.h.

## m_velocitiesProperty

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

protected

Definition at line 283 of file IPolyMesh.h.

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

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