Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema Class Reference
#include <OFaceSet.h>
Classes | |
| class | Sample |
Public Types | |
| typedef OFaceSetSchema | this_type |
Public Member Functions | |
| OFaceSetSchema () | |
| template<class CPROP_PTR > | |
| OFaceSetSchema (CPROP_PTR iParentCompound, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument(), const Abc::Argument &iArg2=Abc::Argument()) | |
| template<class CPROP_PTR > | |
| void | _initTimeSampling (CPROP_PTR iParentCompound, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument(), const Abc::Argument &iArg2=Abc::Argument()) |
| template<class CPROP_PTR > | |
| OFaceSetSchema (CPROP_PTR iParentCompound, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument(), const Abc::Argument &iArg2=Abc::Argument()) | |
| OFaceSetSchema (const OFaceSetSchema &iCopy) | |
| Copy constructor. | |
| size_t | getNumSamples () |
| Default assignment operator used. | |
| void | set (const Sample &iSamp) |
| Set a sample! First sample must have the list of faces in the faceset. | |
| void | setTimeSampling (uint32_t iTimeSamplingID) |
| void | setTimeSampling (AbcA::TimeSamplingPtr iTime) |
| void | setFaceExclusivity (FaceSetExclusivity iFacesExclusive) |
| FaceSetExclusivity | getFaceExclusivity () |
| void | reset () |
| bool | valid () const |
| Valid returns whether this instance holds real data. | |
| ALEMBIC_OVERRIDE_OPERATOR_BOOL (OFaceSetSchema::valid()) | |
Protected Member Functions | |
| void | _recordExclusivityHint () |
| void | init (uint32_t iTimeSamplingID) |
Protected Attributes | |
| Abc::OInt32ArrayProperty | m_facesProperty |
| Abc::OUInt32Property | m_facesExclusiveProperty |
| FaceSetExclusivity | m_facesExclusive |
Friends | |
| class | OSubDSchema |
| class | OPolyMeshSchema |
Detailed Description
Definition at line 57 of file OFaceSet.h.
Member Typedef Documentation
By convention we always define this_type in AbcGeom classes. Used by unspecified-bool-type conversion below
Reimplemented from Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< FaceSetSchemaInfo >.
Definition at line 123 of file OFaceSet.h.
Constructor & Destructor Documentation
| Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::OFaceSetSchema | ( | ) | [inline] |
The default constructor creates an empty OFaceSetSchema. OFaceSetSchema instances created this evaluate to a boolean value of false.
Definition at line 130 of file OFaceSet.h.
| Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::OFaceSetSchema | ( | CPROP_PTR | iParentCompound, | |
| const std::string & | iName, | |||
| const Abc::Argument & | iArg0 = Abc::Argument(), |
|||
| const Abc::Argument & | iArg1 = Abc::Argument(), |
|||
| const Abc::Argument & | iArg2 = Abc::Argument() | |||
| ) | [inline] |
This templated, primary constructor creates a new faceset writer. 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, to specify MetaData, and to set TimeSamplingType. Most typically you won't need to use this ctor because the name argument here is only needed if you need to specially override the name of the compound property used internally by Alembic (for example if you needed to created your own dervied class from OFaceSet that needed to hold multiple faceset schema compound properties)
Definition at line 146 of file OFaceSet.h.
| Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::OFaceSetSchema | ( | CPROP_PTR | iParentCompound, | |
| const Abc::Argument & | iArg0 = Abc::Argument(), |
|||
| const Abc::Argument & | iArg1 = Abc::Argument(), |
|||
| const Abc::Argument & | iArg2 = Abc::Argument() | |||
| ) | [inline, explicit] |
Definition at line 181 of file OFaceSet.h.
| Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::OFaceSetSchema | ( | const OFaceSetSchema & | iCopy | ) | [inline] |
Member Function Documentation
| void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::_initTimeSampling | ( | CPROP_PTR | iParentCompound, | |
| const Abc::Argument & | iArg0 = Abc::Argument(), |
|||
| const Abc::Argument & | iArg1 = Abc::Argument(), |
|||
| const Abc::Argument & | iArg2 = Abc::Argument() | |||
| ) | [inline] |
Definition at line 158 of file OFaceSet.h.
| void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::_recordExclusivityHint | ( | ) | [protected] |
| Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::ALEMBIC_OVERRIDE_OPERATOR_BOOL | ( | OFaceSetSchema:: | valid() | ) |
unspecified-bool-type operator overload. ...
| FaceSetExclusivity Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::getFaceExclusivity | ( | ) | [inline] |
Definition at line 220 of file OFaceSet.h.
| size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::getNumSamples | ( | ) | [inline] |
Default assignment operator used.
Get number of samples written so far. ...
Definition at line 210 of file OFaceSet.h.
| void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::init | ( | uint32_t | iTimeSamplingID | ) | [protected] |
Reimplemented from Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< FaceSetSchemaInfo >.
| void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::reset | ( | ) | [inline, virtual] |
Reset returns this function set to an empty, default state.
Reimplemented from Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< FaceSetSchemaInfo >.
Definition at line 229 of file OFaceSet.h.
| void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::set | ( | const Sample & | iSamp | ) |
Set a sample! First sample must have the list of faces in the faceset.
| void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::setFaceExclusivity | ( | FaceSetExclusivity | iFacesExclusive | ) |
| void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::setTimeSampling | ( | AbcA::TimeSamplingPtr | iTime | ) |
| void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::setTimeSampling | ( | uint32_t | iTimeSamplingID | ) |
| bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::valid | ( | ) | const [inline, virtual] |
Valid returns whether this instance holds real data.
Reimplemented from Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< FaceSetSchemaInfo >.
Definition at line 239 of file OFaceSet.h.
Friends And Related Function Documentation
friend class OPolyMeshSchema [friend] |
Definition at line 261 of file OFaceSet.h.
friend class OSubDSchema [friend] |
Definition at line 260 of file OFaceSet.h.
Member Data Documentation
FaceSetExclusivity Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::m_facesExclusive [protected] |
Definition at line 258 of file OFaceSet.h.
Abc::OUInt32Property Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::m_facesExclusiveProperty [protected] |
Definition at line 257 of file OFaceSet.h.
Abc::OInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::m_facesProperty [protected] |
Definition at line 255 of file OFaceSet.h.
The documentation for this class was generated from the following file:
- Alembic/AbcGeom/OFaceSet.h
