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

#include <OPolyMesh.h>

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

Classes

class  Sample
 

Public Types

typedef OPolyMeshSchema this_type
 
- Public Types inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< PolyMeshSchemaInfo >
typedef PolyMeshSchemaInfo info_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< PolyMeshSchemaInfo >
typedef PolyMeshSchemaInfo info_type
 
typedef OSchema
< PolyMeshSchemaInfo > 
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

 OPolyMeshSchema ()
 
template<class CPROP_PTR >
 OPolyMeshSchema (CPROP_PTR iParent, 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 >
 OPolyMeshSchema (CPROP_PTR iParent, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument(), const Abc::Argument &iArg2=Abc::Argument())
 
 OPolyMeshSchema (const OPolyMeshSchema &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 PolyMesh. More...
 
OFaceSet getFaceSet (const std::string &iFaceSetName)
 
bool hasFaceSet (const std::string &iFaceSetName)
 
void setUVSourceName (const std::string &iName)
 
 ALEMBIC_OVERRIDE_OPERATOR_BOOL (OPolyMeshSchema::valid())
 
- Public Member Functions inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< PolyMeshSchemaInfo >
 OGeomBaseSchema ()
 
 OGeomBaseSchema (CPROP_PTR iParentCompound, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument())
 
 OGeomBaseSchema (CPROP_PTR iParentCompound, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument())
 
 OGeomBaseSchema (const OGeomBaseSchema &iCopy)
 Copy constructor. More...
 
void init (uint32_t iTsHandle)
 
Abc::OCompoundProperty getArbGeomParams ()
 
Abc::OCompoundProperty getUserProperties ()
 
Abc::OBox3dProperty getChildBoundsProperty ()
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< PolyMeshSchemaInfo >
 OSchema ()
 
 OSchema (CPROP_PTR iParentObject, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument())
 
 OSchema (CPROP_PTR iParentObject, 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 ()
 
template<class CPROP_PTR >
 OCompoundProperty (CPROP_PTR iParentObject, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
template<class CPROP_PTR >
 OCompoundProperty (CPROP_PTR iThisObject, WrapExistingFlag iWrapFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
template<class OBJECT_PTR >
 OCompoundProperty (OBJECT_PTR iObject, TopFlag, 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)
 
- Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >
 OBasePropertyT ()
 
 OBasePropertyT (AbcA::CompoundPropertyWriterPtriPtr, WrapExistingFlag, 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::OV3fArrayProperty m_velocitiesProperty
 
Abc::OInt32ArrayProperty m_indicesProperty
 
Abc::OInt32ArrayProperty m_countsProperty
 
std::map< std::string, OFaceSetm_faceSets
 
OV2fGeomParam m_uvsParam
 
ON3fGeomParam m_normalsParam
 
std::string m_uvSourceName
 
- Protected Attributes inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< PolyMeshSchemaInfo >
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
 

Additional Inherited Members

- Static Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< PolyMeshSchemaInfo >
static const char * getSchemaTitle ()
 
static const char * getSchemaBaseType ()
 
static const char * getDefaultSchemaName ()
 
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 52 of file OPolyMesh.h.

Member Typedef Documentation

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

Definition at line 151 of file OPolyMesh.h.

Constructor & Destructor Documentation

Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPolyMeshSchema::OPolyMeshSchema ( )
inline

The default constructor creates an empty OPolyMeshSchema ...

Definition at line 159 of file OPolyMesh.h.

template<class CPROP_PTR >
Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPolyMeshSchema::OPolyMeshSchema ( CPROP_PTR  iParent,
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 poly mesh 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.

Definition at line 169 of file OPolyMesh.h.

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

Definition at line 200 of file OPolyMesh.h.

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

Copy constructor.

Definition at line 229 of file OPolyMesh.h.

Member Function Documentation

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

unspecified-bool-type operator overload. ...

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

Appends the names of any FaceSets for this PolyMesh.

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

Get number of samples written so far. ...

Definition at line 252 of file OPolyMesh.h.

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

Default assignment operator used.

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

Definition at line 243 of file OPolyMesh.h.

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPolyMeshSchema::hasFaceSet ( const std::string iFaceSetName)
void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPolyMeshSchema::init ( uint32_t  iTsIdx)
protected
void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPolyMeshSchema::reset ( )
inlinevirtual

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

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

Definition at line 274 of file OPolyMesh.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPolyMeshSchema::set ( const Sample iSamp)

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

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

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

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPolyMeshSchema::setTimeSampling ( uint32_t  iIndex)
void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPolyMeshSchema::setTimeSampling ( AbcA::TimeSamplingPtr  iTime)
void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPolyMeshSchema::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::OPolyMeshSchema::valid ( ) const
inlinevirtual

Valid returns whether this function set is valid.

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

Definition at line 290 of file OPolyMesh.h.

Member Data Documentation

Abc::OInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPolyMeshSchema::m_countsProperty
protected

Definition at line 319 of file OPolyMesh.h.

std::map<std::string, OFaceSet> Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPolyMeshSchema::m_faceSets
protected

Definition at line 322 of file OPolyMesh.h.

Abc::OInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPolyMeshSchema::m_indicesProperty
protected

Definition at line 318 of file OPolyMesh.h.

ON3fGeomParam Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPolyMeshSchema::m_normalsParam
protected

Definition at line 325 of file OPolyMesh.h.

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

Definition at line 316 of file OPolyMesh.h.

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

Definition at line 328 of file OPolyMesh.h.

OV2fGeomParam Alembic::AbcGeom::ALEMBIC_VERSION_NS::OPolyMeshSchema::m_uvsParam
protected

Definition at line 324 of file OPolyMesh.h.

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

Definition at line 317 of file OPolyMesh.h.


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