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

#include <OSubD.h>

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

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
 
OFaceSetcreateFaceSet (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...
 
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::PropertyHeadergetPropertyHeader (size_t i) const
 
const AbcA::PropertyHeadergetPropertyHeader (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::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
 
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
ErrorHandlergetErrorHandler () 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::CompoundPropertyWriterPtriPtr, 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::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

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

Definition at line 306 of file OSubD.h.

Constructor & Destructor Documentation

Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::OSubDSchema ( )
inline

The default constructor creates an empty OSubDSchema ...

Definition at line 314 of file OSubD.h.

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.

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.

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

Copy constructor.

Definition at line 347 of file OSubD.h.

Member Function Documentation

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

unspecified-bool-type operator overload. ...

OFaceSet& Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::createFaceSet ( const std::string iFaceSetName)
OFaceSet Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::getFaceSet ( const std::string iFaceSetName)
void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::getFaceSetNames ( std::vector< std::string > &  oFaceSetNames)

Appends the names of any FaceSets for this SubD.

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

Get number of samples written so far. ...

Definition at line 379 of file OSubD.h.

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 361 of file OSubD.h.

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::hasFaceSet ( const std::string iFaceSetName)
void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::init ( uint32_t  iTsIdx,
bool  isSparse 
)
protected
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 401 of file OSubD.h.

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.

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.

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

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

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::setTimeSampling ( uint32_t  iIndex)
void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OSubDSchema::setTimeSampling ( AbcA::TimeSamplingPtr  iTime)
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.

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 433 of file OSubD.h.

Friends And Related Function Documentation

friend class OFaceSetSchema
friend

Definition at line 530 of file OSubD.h.

Member Data Documentation

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

Definition at line 481 of file OSubD.h.

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

Definition at line 482 of file OSubD.h.

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

Definition at line 476 of file OSubD.h.

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

Definition at line 477 of file OSubD.h.

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

Definition at line 478 of file OSubD.h.

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

Definition at line 468 of file OSubD.h.

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

Definition at line 467 of file OSubD.h.

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

Definition at line 471 of file OSubD.h.

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

Definition at line 472 of file OSubD.h.

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

Definition at line 485 of file OSubD.h.

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

Definition at line 473 of file OSubD.h.

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

Definition at line 466 of file OSubD.h.

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

Definition at line 488 of file OSubD.h.

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

Definition at line 497 of file OSubD.h.

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

Definition at line 493 of file OSubD.h.

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

Definition at line 490 of file OSubD.h.


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