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

#include <OFaceSet.h>

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

Classes

class  Sample
 

Public Types

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

 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. More...
 
size_t getNumSamples () const
 Default assignment operator used. More...
 
void set (const Sample &iSamp)
 Set a sample! First sample must have the list of faces in the faceset. More...
 
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. More...
 
 ALEMBIC_OVERRIDE_OPERATOR_BOOL (OFaceSetSchema::valid())
 
- Public Member Functions inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< FaceSetSchemaInfo >
 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< FaceSetSchemaInfo >
 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 _recordExclusivityHint ()
 
void init (uint32_t iTimeSamplingID)
 
- 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::OInt32ArrayProperty m_facesProperty
 
Abc::OUInt32Property m_facesExclusiveProperty
 
FaceSetExclusivity m_facesExclusive
 
- Protected Attributes inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< FaceSetSchemaInfo >
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 OSubDSchema
 
class OPolyMeshSchema
 

Additional Inherited Members

- Static Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< FaceSetSchemaInfo >
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 58 of file OFaceSet.h.

Member Typedef Documentation

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

Definition at line 118 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 125 of file OFaceSet.h.

template<class CPROP_PTR >
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 141 of file OFaceSet.h.

template<class CPROP_PTR >
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() 
)
inlineexplicit

Definition at line 178 of file OFaceSet.h.

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

Copy constructor.

Definition at line 191 of file OFaceSet.h.

Member Function Documentation

template<class CPROP_PTR >
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 155 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 219 of file OFaceSet.h.

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

Default assignment operator used.

Get number of samples written so far. ...

Definition at line 209 of file OFaceSet.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::init ( uint32_t  iTimeSamplingID)
protected
void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::reset ( )
inlinevirtual

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

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

Definition at line 228 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 ( uint32_t  iTimeSamplingID)
void Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::setTimeSampling ( AbcA::TimeSamplingPtr  iTime)
bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::valid ( ) const
inlinevirtual

Valid returns whether this instance holds real data.

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

Definition at line 236 of file OFaceSet.h.

Friends And Related Function Documentation

friend class OPolyMeshSchema
friend

Definition at line 258 of file OFaceSet.h.

friend class OSubDSchema
friend

Definition at line 257 of file OFaceSet.h.

Member Data Documentation

FaceSetExclusivity Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::m_facesExclusive
protected

Definition at line 255 of file OFaceSet.h.

Abc::OUInt32Property Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::m_facesExclusiveProperty
protected

Definition at line 254 of file OFaceSet.h.

Abc::OInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::OFaceSetSchema::m_facesProperty
protected

Definition at line 252 of file OFaceSet.h.


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