Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema Class Reference

`#include <OSubD.h>`

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

## Classes

class | Sample

## Public Types

typedef OSubDSchema | this_type
Public Types inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< SubDSchemaInfo >
typedef SubDSchemaInfo | info_type
Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< SubDSchemaInfo >
typedef SubDSchemaInfo | info_type
typedef OSchema< SubDSchemaInfo > | this_type
Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty
typedef OCompoundProperty | this_type
Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >
typedef OBasePropertyT< AbcA::CompoundPropertyWriterPtr > | this_type
typedef OBasePropertyT< AbcA::CompoundPropertyWriterPtr > | operator_bool_base_type

## Public Member Functions

| OSubDSchema ()
| OSubDSchema (AbcA::CompoundPropertyWriterPtr iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument(), const Abc::Argument &iArg2=Abc::Argument(), const Abc::Argument &iArg3=Abc::Argument())
| OSubDSchema (Abc::OCompoundProperty iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument(), const Abc::Argument &iArg2=Abc::Argument())
| OSubDSchema (const OSubDSchema &iCopy)
| Copy constructor. More...
AbcA::TimeSamplingPtr | getTimeSampling () const
| Default assignment operator used. More...
size_t | getNumSamples () const
void | set (const Sample &iSamp)
void | setFromPrevious ()
void | setTimeSampling (uint32_t iIndex)
void | setTimeSampling (AbcA::TimeSamplingPtr iTime)
void | reset ()
bool | valid () const
OFaceSet & | createFaceSet (const std::string &iFaceSetName)
void | getFaceSetNames (std::vector< std::string > &oFaceSetNames)
| Appends the names of any FaceSets for this SubD. More...
OFaceSet | getFaceSet (const std::string &iFaceSetName)
bool | hasFaceSet (const std::string &iFaceSetName)
void | setUVSourceName (const std::string &iName)
| ALEMBIC_OVERRIDE_OPERATOR_BOOL (OSubDSchema::valid())
Public Member Functions inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< SubDSchemaInfo >
| OGeomBaseSchema ()
| OGeomBaseSchema (AbcA::CompoundPropertyWriterPtr iParent, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument(), const Argument &iArg3=Argument())
| OGeomBaseSchema (const OGeomBaseSchema &iCopy)
| Copy constructor. More...
virtual void | reset ()
virtual bool | valid () const
Abc::OCompoundProperty | getArbGeomParams ()
Abc::OCompoundProperty | getUserProperties ()
Abc::OBox3dProperty | getChildBoundsProperty ()
Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< SubDSchemaInfo >
| OSchema ()
| OSchema (AbcA::CompoundPropertyWriterPtr iParent, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument(), const Argument &iArg3=Argument())
| OSchema (OCompoundProperty iParent, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument())
virtual | ~OSchema ()
Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty
| OCompoundProperty ()
| OCompoundProperty (AbcA::CompoundPropertyWriterPtr iParent, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
| OCompoundProperty (OCompoundProperty iParent, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
| OCompoundProperty (AbcA::CompoundPropertyWriterPtr iProp, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
| OCompoundProperty (AbcA::CompoundPropertyWriterPtr iProp, WrapExistingFlag iWrapFlag=kWrapExisting, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
| OCompoundProperty (OObject iObject, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
| OCompoundProperty (OObject iObject, TopFlag iTopFlag=kTop, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
| ~OCompoundProperty ()
size_t | getNumProperties () const
const AbcA::PropertyHeader & | getPropertyHeader (size_t i) const
const AbcA::PropertyHeader * | getPropertyHeader (const std::string &iName) const
OBaseProperty | getProperty (size_t i) const
OBaseProperty | getProperty (const std::string &iName) const
OCompoundProperty | getParent () const
Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >
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
OObject | getObject () const
AbcA::CompoundPropertyWriterPtr | 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 (uint32_t iTsIdx, bool isSparse)
void | selectiveSet (const Sample &iSamp)
Protected Member Functions inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< SubDSchemaInfo >
void | init (uint32_t iTsIndex, bool isSparse)
void | createSelfBoundsProperty (uint32_t iTsIndex, size_t iNumSamples)
| Creates the self bounds. More...
Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >
| OBasePropertyT ()
| OBasePropertyT (AbcA::CompoundPropertyWriterPtr 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::OP3fArrayProperty | m_positionsProperty
Abc::OInt32ArrayProperty | m_faceIndicesProperty
Abc::OInt32ArrayProperty | m_faceCountsProperty
Abc::OInt32Property | m_faceVaryingInterpolateBoundaryProperty
Abc::OInt32Property | m_faceVaryingPropagateCornersProperty
Abc::OInt32Property | m_interpolateBoundaryProperty
Abc::OInt32ArrayProperty | m_creaseIndicesProperty
Abc::OInt32ArrayProperty | m_creaseLengthsProperty
Abc::OFloatArrayProperty | m_creaseSharpnessesProperty
Abc::OInt32ArrayProperty | m_cornerIndicesProperty
Abc::OFloatArrayProperty | m_cornerSharpnessesProperty
Abc::OInt32ArrayProperty | m_holesProperty
Abc::OStringProperty | m_subdSchemeProperty
Abc::OV3fArrayProperty | m_velocitiesProperty
OV2fGeomParam | m_uvsParam
std::string | m_uvSourceName
Protected Attributes inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< SubDSchemaInfo >
Abc::OBox3dProperty | m_selfBoundsProperty
Abc::OBox3dProperty | m_childBoundsProperty
Abc::OCompoundProperty | m_arbGeomParams
Abc::OCompoundProperty | m_userProperties
Protected Attributes inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >
AbcA::CompoundPropertyWriterPtr | m_property

## Friends

class | OFaceSetSchema

## Additional Inherited Members

Static Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< SubDSchemaInfo >
static const char * | getSchemaTitle ()
static const char * | getSchemaBaseType ()
static const char * | getDefaultSchemaName ()
static bool | replaceOnSparse ()
static bool | matches (const AbcA::MetaData &iMetaData, SchemaInterpMatching iMatching=kStrictMatching)
static bool | matches (const AbcA::PropertyHeader &iHeader, SchemaInterpMatching iMatching=kStrictMatching)

## Detailed Description

Definition at line 58 of file OSubD.h.

## Member Typedef Documentation

## this_type

typedef OSubDSchema Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::this_type

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

Definition at line 308 of file OSubD.h.

## Constructor & Destructor Documentation

## OSubDSchema() [1/4]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::OSubDSchema | ( |  | ) |

inline

The default constructor creates an empty OSubDSchema ...

Definition at line 316 of file OSubD.h.

## OSubDSchema() [2/4]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::OSubDSchema | ( | AbcA::CompoundPropertyWriterPtr | iParent,
|  | const std::string & | iName,
|  | const Abc::Argument & | iArg0 = `Abc::Argument()`,
|  | const Abc::Argument & | iArg1 = `Abc::Argument()`,
|  | const Abc::Argument & | iArg2 = `Abc::Argument()`,
|  | const Abc::Argument & | iArg3 = `Abc::Argument()`
| ) |  |

This constructor creates a new subd writer. The first argument is an CompoundPropertyWriterPtr to use as a parent. The next is the name to give the schema which is usually the default name given by OSubD (.geom) The remaining optional arguments can be used to override the ErrorHandlerPolicy, to specify MetaData, specify sparse sampling and to set TimeSampling.

## OSubDSchema() [3/4]

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

This constructor creates a new subd writer. The first argument is an OCompundProperty to use as a parent, and from which the ErrorHandlerPolicy is derived. The next is the name to give the schema which is usually the default name given by OSubD (.geom) The remaining optional arguments can be used to specify MetaData, specify sparse sampling and to set TimeSampling.

## OSubDSchema() [4/4]

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

inline

Copy constructor.

Definition at line 349 of file OSubD.h.

## Member Function Documentation

## ALEMBIC_OVERRIDE_OPERATOR_BOOL()

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

unspecified-bool-type operator overload. ...

## createFaceSet()

OFaceSet & Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::createFaceSet | ( | const std::string & | iFaceSetName | ) |

## getFaceSet()

OFaceSet Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::getFaceSet | ( | const std::string & | iFaceSetName | ) |

## getFaceSetNames()

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

Appends the names of any FaceSets for this SubD.

## getNumSamples()

size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::getNumSamples | ( |  | ) | const

inline

Get number of samples written so far. ...

Definition at line 381 of file OSubD.h.

## getTimeSampling()

AbcA::TimeSamplingPtr Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::getTimeSampling | ( |  | ) | const

inline

Default assignment operator used.

Return the time sampling, which is stored on each of the sub properties.

Definition at line 363 of file OSubD.h.

## hasFaceSet()

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

## init()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::init | ( | uint32_t | iTsIdx,
|  | bool | isSparse
| ) |  |

protected

## reset()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::reset | ( |  | ) |

inlinevirtual

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

Reimplemented from Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< SubDSchemaInfo >.

Definition at line 403 of file OSubD.h.

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

Here is the call graph for this function:

## selectiveSet()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::selectiveSet | ( | const Sample & | iSamp | ) |

protected

Set only some property data. Does not need to be a valid schema sample This is to be used when created a file which will be layered in to another file.

## set()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::set | ( | const Sample & | iSamp | ) |

Set a sample! Sample zero has to have non-degenerate positions, indices and counts.

## setFromPrevious()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::setFromPrevious | ( |  | ) |

Set from previous sample. Will apply to each of positions, indices, and counts.

## setTimeSampling() [1/2]

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::setTimeSampling | ( | AbcA::TimeSamplingPtr | iTime | ) |

## setTimeSampling() [2/2]

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::setTimeSampling | ( | uint32_t | iIndex | ) |

## setUVSourceName()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::setUVSourceName | ( | const std::string & | iName | ) |

Optional source name for the UV param. Must be set before the first UV sample is set.

## valid()

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::valid | ( |  | ) | const

inlinevirtual

Valid returns whether this function set is valid.

Reimplemented from Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< SubDSchemaInfo >.

Definition at line 435 of file OSubD.h.

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

Here is the call graph for this function:

## Friends And Related Function Documentation

## OFaceSetSchema

friend class OFaceSetSchema

friend

Definition at line 532 of file OSubD.h.

## Member Data Documentation

## m_cornerIndicesProperty

Abc::OInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::m_cornerIndicesProperty

protected

Definition at line 483 of file OSubD.h.

## m_cornerSharpnessesProperty

Abc::OFloatArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::m_cornerSharpnessesProperty

protected

Definition at line 484 of file OSubD.h.

## m_creaseIndicesProperty

Abc::OInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::m_creaseIndicesProperty

protected

Definition at line 478 of file OSubD.h.

## m_creaseLengthsProperty

Abc::OInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::m_creaseLengthsProperty

protected

Definition at line 479 of file OSubD.h.

## m_creaseSharpnessesProperty

Abc::OFloatArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::m_creaseSharpnessesProperty

protected

Definition at line 480 of file OSubD.h.

## m_faceCountsProperty

Abc::OInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::m_faceCountsProperty

protected

Definition at line 470 of file OSubD.h.

## m_faceIndicesProperty

Abc::OInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::m_faceIndicesProperty

protected

Definition at line 469 of file OSubD.h.

## m_faceVaryingInterpolateBoundaryProperty

Abc::OInt32Property Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::m_faceVaryingInterpolateBoundaryProperty

protected

Definition at line 473 of file OSubD.h.

## m_faceVaryingPropagateCornersProperty

Abc::OInt32Property Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::m_faceVaryingPropagateCornersProperty

protected

Definition at line 474 of file OSubD.h.

## m_holesProperty

Abc::OInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::m_holesProperty

protected

Definition at line 487 of file OSubD.h.

## m_interpolateBoundaryProperty

Abc::OInt32Property Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::m_interpolateBoundaryProperty

protected

Definition at line 475 of file OSubD.h.

## m_positionsProperty

Abc::OP3fArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::m_positionsProperty

protected

Definition at line 468 of file OSubD.h.

## m_subdSchemeProperty

Abc::OStringProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::m_subdSchemeProperty

protected

Definition at line 490 of file OSubD.h.

## m_uvSourceName

std::string Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::m_uvSourceName

protected

Definition at line 499 of file OSubD.h.

## m_uvsParam

OV2fGeomParam Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::m_uvsParam

protected

Definition at line 495 of file OSubD.h.

## m_velocitiesProperty

Abc::OV3fArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::m_velocitiesProperty

protected

Definition at line 492 of file OSubD.h.

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

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