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

#include <ICurves.h>

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

Classes

class  Sample
 

Public Types

typedef ICurvesSchema this_type
 
typedef ICurvesSchema::Sample sample_type
 
- Public Types inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< CurvesSchemaInfo >
typedef CurvesSchemaInfo info_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< CurvesSchemaInfo >
typedef CurvesSchemaInfo info_type
 
typedef ISchema< CurvesSchemaInfo > this_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
typedef ICompoundProperty this_type
 

Public Member Functions

 ICurvesSchema ()
 
 ICurvesSchema (const ICompoundProperty &iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 
 ICurvesSchema (const ICompoundProperty &iProp, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 
 ICurvesSchema (const ICurvesSchema &iCopy)
 Default assignment operator used. More...
 
size_t getNumSamples () const
 
MeshTopologyVariance getTopologyVariance () const
 
bool isConstant () const
 
AbcA::TimeSamplingPtr getTimeSampling () const
 
void get (sample_type &oSample, const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
 
sample_type getValue (const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
 
Abc::IV3fArrayProperty getVelocitiesProperty () const
 
Abc::IP3fArrayProperty getPositionsProperty () const
 
Abc::IInt32ArrayProperty getNumVerticesProperty () const
 
Abc::IFloatArrayProperty getPositionWeightsProperty () const
 
IV2fGeomParam getUVsParam () const
 
IN3fGeomParam getNormalsParam () const
 
IFloatGeomParam getWidthsParam () const
 
Abc::IUcharArrayProperty getOrdersProperty () const
 
Abc::IFloatArrayProperty getKnotsProperty () const
 
void reset ()
 
bool valid () const
 
 ALEMBIC_OVERRIDE_OPERATOR_BOOL (this_type::valid())
 
- Public Member Functions inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< CurvesSchemaInfo >
 IGeomBaseSchema ()
 
 IGeomBaseSchema (const ICompoundProperty &iParent, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 IGeomBaseSchema (const ICompoundProperty &iProp, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 Wrap an existing schema object. More...
 
 IGeomBaseSchema (const ICompoundProperty &iProp, Abc::WrapExistingFlag iFlag, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 
 IGeomBaseSchema (const IGeomBaseSchema &iCopy)
 Copy constructor. More...
 
void init (const Abc::Argument &iArg0, const Abc::Argument &iArg1)
 
Abc::IBox3dProperty getSelfBoundsProperty () const
 
Abc::IBox3dProperty getChildBoundsProperty () const
 
ICompoundProperty getArbGeomParams () const
 
ICompoundProperty getUserProperties () const
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< CurvesSchemaInfo >
 ISchema ()
 
 ISchema (const ICompoundProperty &iParent, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 ISchema (const ICompoundProperty &iProperty, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 ISchema (const ICompoundProperty &iProperty, WrapExistingFlag iFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
virtual ~ISchema ()
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
 ICompoundProperty ()
 
 ICompoundProperty (const ICompoundProperty &iParent, const std::string &iName, const Argument &iArg0=Argument())
 
 ICompoundProperty (AbcA::CompoundPropertyReaderPtr iPtr, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 ICompoundProperty (AbcA::CompoundPropertyReaderPtr iPtr, WrapExistingFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 ICompoundProperty (const IObject &iObject, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 ICompoundProperty (const IObject &iObject, TopFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 ~ICompoundProperty ()
 
size_t getNumProperties () const
 Returns the number of properties contained in this ICompoundProperty. More...
 
const AbcA::PropertyHeadergetPropertyHeader (size_t i) const
 
const AbcA::PropertyHeadergetPropertyHeader (const std::string &iName) const
 
ICompoundProperty getParent () const
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >
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
 
IObject getObject () const
 
AbcA::CompoundPropertyReaderPtr 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 (const Abc::Argument &iArg0, const Abc::Argument &iArg1)
 
- Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >
 IBasePropertyT ()
 
 IBasePropertyT (AbcA::CompoundPropertyReaderPtriPtr, 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::IP3fArrayProperty m_positionsProperty
 
Abc::IV3fArrayProperty m_velocitiesProperty
 
Abc::IInt32ArrayProperty m_nVerticesProperty
 
Abc::IScalarProperty m_basisAndTypeProperty
 
IFloatGeomParam m_widthsParam
 
IV2fGeomParam m_uvsParam
 
IN3fGeomParam m_normalsParam
 
Abc::IFloatArrayProperty m_positionWeightsProperty
 
Abc::IUcharArrayProperty m_ordersProperty
 
Abc::IFloatArrayProperty m_knotsProperty
 
- Protected Attributes inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< CurvesSchemaInfo >
Abc::IBox3dProperty m_selfBoundsProperty
 
Abc::IBox3dProperty m_childBoundsProperty
 
Abc::ICompoundProperty m_arbGeomParams
 
Abc::ICompoundProperty m_userProperties
 
- Protected Attributes inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >
AbcA::CompoundPropertyReaderPtr m_property
 

Additional Inherited Members

- Static Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< CurvesSchemaInfo >
static const char * getSchemaTitle ()
 
static const char * getDefaultSchemaName ()
 
static bool matches (const AbcA::MetaData &iMetaData, SchemaInterpMatching iMatching=kStrictMatching)
 
static bool matches (const AbcA::PropertyHeader &iHeader, SchemaInterpMatching iMatching=kStrictMatching)
 
- Protected Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >
typedef IBasePropertyT
< AbcA::CompoundPropertyReaderPtr
this_type
 
typedef IBasePropertyT
< AbcA::CompoundPropertyReaderPtr
operator_bool_base_type
 

Detailed Description

Definition at line 53 of file ICurves.h.

Member Typedef Documentation

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

Definition at line 139 of file ICurves.h.

Constructor & Destructor Documentation

Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::ICurvesSchema ( )
inline

The default constructor creates an empty ICurvesSchema ...

Definition at line 149 of file ICurves.h.

Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::ICurvesSchema ( const ICompoundProperty iParent,
const std::string iName,
const Abc::Argument iArg0 = Abc::Argument(),
const Abc::Argument iArg1 = Abc::Argument() 
)
inline

This constructor creates a new curves reader. The first argument is the parent ICompoundProperty, from which the error handler policy for is derived. The second argument is the name of the ICompoundProperty that contains this schemas properties. The remaining optional arguments can be used to override the ErrorHandlerPolicy and to specify schema interpretation matching.

Definition at line 157 of file ICurves.h.

Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::ICurvesSchema ( const ICompoundProperty iProp,
const Abc::Argument iArg0 = Abc::Argument(),
const Abc::Argument iArg1 = Abc::Argument() 
)
inline

This constructor wraps an existing ICompoundProperty as the curves reader, and the error handler policy is derived from it. The remaining optional arguments can be used to override the ErrorHandlerPolicy and to specify schema interpretation matching.

Definition at line 170 of file ICurves.h.

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

Default assignment operator used.

Definition at line 180 of file ICurves.h.

Member Function Documentation

Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::ALEMBIC_OVERRIDE_OPERATOR_BOOL ( this_type::  valid())

unspecified-bool-type operator overload. ...

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::get ( sample_type oSample,
const Abc::ISampleSelector iSS = Abc::ISampleSelector() 
) const
Abc::IFloatArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::getKnotsProperty ( ) const
inline

Definition at line 258 of file ICurves.h.

IN3fGeomParam Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::getNormalsParam ( ) const
inline

Definition at line 243 of file ICurves.h.

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

Definition at line 186 of file ICurves.h.

Abc::IInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::getNumVerticesProperty ( ) const
inline

Definition at line 227 of file ICurves.h.

Abc::IUcharArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::getOrdersProperty ( ) const
inline

Definition at line 253 of file ICurves.h.

Abc::IP3fArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::getPositionsProperty ( ) const
inline

Definition at line 222 of file ICurves.h.

Abc::IFloatArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::getPositionWeightsProperty ( ) const
inline

Definition at line 233 of file ICurves.h.

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

Time sampling type.

Definition at line 200 of file ICurves.h.

MeshTopologyVariance Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::getTopologyVariance ( ) const

Return the topological variance. This indicates how the mesh may change.

IV2fGeomParam Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::getUVsParam ( ) const
inline

Definition at line 238 of file ICurves.h.

sample_type Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::getValue ( const Abc::ISampleSelector iSS = Abc::ISampleSelector()) const
inline

Definition at line 209 of file ICurves.h.

Abc::IV3fArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::getVelocitiesProperty ( ) const
inline

Definition at line 217 of file ICurves.h.

IFloatGeomParam Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::getWidthsParam ( ) const
inline

Definition at line 248 of file ICurves.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::init ( const Abc::Argument iArg0,
const Abc::Argument iArg1 
)
protected
bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::isConstant ( ) const
inline

Ask if we're constant - no change in value amongst samples, regardless of the time sampling.

Definition at line 195 of file ICurves.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::reset ( )
inlinevirtual

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

Reimplemented from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< CurvesSchemaInfo >.

Definition at line 271 of file ICurves.h.

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::valid ( ) const
inlinevirtual

Valid returns whether this function set is valid.

Reimplemented from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< CurvesSchemaInfo >.

Definition at line 292 of file ICurves.h.

Member Data Documentation

Abc::IScalarProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::m_basisAndTypeProperty
protected

Definition at line 310 of file ICurves.h.

Abc::IFloatArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::m_knotsProperty
protected

Definition at line 319 of file ICurves.h.

IN3fGeomParam Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::m_normalsParam
protected

Definition at line 314 of file ICurves.h.

Abc::IInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::m_nVerticesProperty
protected

Definition at line 307 of file ICurves.h.

Abc::IUcharArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::m_ordersProperty
protected

Definition at line 318 of file ICurves.h.

Abc::IP3fArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::m_positionsProperty
protected

Definition at line 305 of file ICurves.h.

Abc::IFloatArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::m_positionWeightsProperty
protected

Definition at line 317 of file ICurves.h.

IV2fGeomParam Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::m_uvsParam
protected

Definition at line 313 of file ICurves.h.

Abc::IV3fArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::m_velocitiesProperty
protected

Definition at line 306 of file ICurves.h.

IFloatGeomParam Alembic::AbcGeom::ALEMBIC_VERSION_NS::ICurvesSchema::m_widthsParam
protected

Definition at line 312 of file ICurves.h.


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