Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema Class Reference

`#include <INuPatch.h>`

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

## Classes

class | Sample

## Public Types

typedef INuPatchSchema | this_type
typedef Sample | sample_type
Public Types inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< NuPatchSchemaInfo >
typedef NuPatchSchemaInfo | info_type
Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< NuPatchSchemaInfo >
typedef NuPatchSchemaInfo | info_type
typedef ISchema< NuPatchSchemaInfo > | this_type
Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
typedef ICompoundProperty | this_type

## Public Member Functions

| INuPatchSchema ()
| The default constructor. More...
| INuPatchSchema (const INuPatchSchema &iCopy)
| copy constructor More...
| INuPatchSchema (const ICompoundProperty &iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
| INuPatchSchema (const ICompoundProperty &iProp, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
size_t | getNumSamples () const
MeshTopologyVariance | getTopologyVariance () const
bool | isConstant () const
AbcA::TimeSamplingPtr | getTimeSampling () const
| Time information. More...
void | get (sample_type &oSample, const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
Sample | getValue (const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
Abc::IP3fArrayProperty | getPositionsProperty () const
Abc::IFloatArrayProperty | getUKnotsProperty () const
Abc::IFloatArrayProperty | getVKnotsProperty () const
Abc::IV3fArrayProperty | getVelocitiesProperty () const
Abc::IFloatArrayProperty | getPositionWeightsProperty () const
IN3fGeomParam | getNormalsParam () const
IV2fGeomParam | getUVsParam () const
bool | hasTrimCurve () const
bool | trimCurveTopologyIsHomogenous () const
bool | trimCurveTopologyIsConstant () const
void | reset ()
bool | valid () const
| ALEMBIC_OVERRIDE_OPERATOR_BOOL (INuPatchSchema::valid())
Public Member Functions inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< NuPatchSchemaInfo >
| 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)
virtual void | reset ()
virtual bool | valid () const
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< NuPatchSchemaInfo >
| 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::PropertyHeader & | getPropertyHeader (size_t i) const
const AbcA::PropertyHeader * | getPropertyHeader (const std::string &iName) const
ICompoundProperty | getParent () const
Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >
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
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
ErrorHandler & | getErrorHandler () const
ErrorHandler::Policy | getErrorHandlerPolicy () const

## Protected Member Functions

bool | hasTrimProps () const
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::CompoundPropertyReaderPtr 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::IP3fArrayProperty | m_positionsProperty
Abc::IInt32Property | m_numUProperty
Abc::IInt32Property | m_numVProperty
Abc::IInt32Property | m_uOrderProperty
Abc::IInt32Property | m_vOrderProperty
Abc::IFloatArrayProperty | m_uKnotProperty
Abc::IFloatArrayProperty | m_vKnotProperty
Abc::IV3fArrayProperty | m_velocitiesProperty
Abc::IFloatArrayProperty | m_positionWeightsProperty
IN3fGeomParam | m_normalsParam
IV2fGeomParam | m_uvsParam
Abc::IInt32Property | m_trimNumLoopsProperty
Abc::IInt32ArrayProperty | m_trimNumVerticesProperty
Abc::IInt32ArrayProperty | m_trimNumCurvesProperty
Abc::IInt32ArrayProperty | m_trimOrderProperty
Abc::IFloatArrayProperty | m_trimKnotProperty
Abc::IFloatArrayProperty | m_trimMinProperty
Abc::IFloatArrayProperty | m_trimMaxProperty
Abc::IFloatArrayProperty | m_trimUProperty
Abc::IFloatArrayProperty | m_trimVProperty
Abc::IFloatArrayProperty | m_trimWProperty
bool | m_hasTrimCurve
Protected Attributes inherited from Alembic::AbcGeom::ALEMBIC_VERSION_NS::IGeomBaseSchema< NuPatchSchemaInfo >
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< NuPatchSchemaInfo >
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 51 of file INuPatch.h.

## Member Typedef Documentation

## sample_type

typedef Sample Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::sample_type

Definition at line 165 of file INuPatch.h.

## this_type

typedef INuPatchSchema Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::this_type

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

Definition at line 164 of file INuPatch.h.

## Constructor & Destructor Documentation

## INuPatchSchema() [1/4]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::INuPatchSchema | ( |  | ) |

inline

The default constructor.

Definition at line 172 of file INuPatch.h.

## INuPatchSchema() [2/4]

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

inline

copy constructor

Definition at line 178 of file INuPatch.h.

## INuPatchSchema() [3/4]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::INuPatchSchema | ( | 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 nurbs patch 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 190 of file INuPatch.h.

## INuPatchSchema() [4/4]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::INuPatchSchema | ( | const ICompoundProperty & | iProp,
|  | const Abc::Argument & | iArg0 = `Abc::Argument()`,
|  | const Abc::Argument & | iArg1 = `Abc::Argument()`
| ) |  |

inlineexplicit

This constructor wraps an existing ICompoundProperty as the nurbs 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 203 of file INuPatch.h.

## Member Function Documentation

## ALEMBIC_OVERRIDE_OPERATOR_BOOL()

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

unspecified-bool-type operator overload. ...

## get()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::get | ( | sample_type & | oSample,
|  | const Abc::ISampleSelector & | iSS = `Abc::ISampleSelector()`
| ) |  | const

## getNormalsParam()

IN3fGeomParam Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::getNormalsParam | ( |  | ) | const

inline

Definition at line 258 of file INuPatch.h.

## getNumSamples()

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

inline

Return the number of samples contained in the property. This can be any number, including zero. This returns the number of samples that were written, independently of whether or not they were constant.

Definition at line 216 of file INuPatch.h.

## getPositionsProperty()

Abc::IP3fArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::getPositionsProperty | ( |  | ) | const

inline

Definition at line 243 of file INuPatch.h.

## getPositionWeightsProperty()

Abc::IFloatArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::getPositionWeightsProperty | ( |  | ) | const

inline

Definition at line 253 of file INuPatch.h.

## getTimeSampling()

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

inline

Time information.

Definition at line 228 of file INuPatch.h.

## getTopologyVariance()

MeshTopologyVariance Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::getTopologyVariance | ( |  | ) | const

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

## getUKnotsProperty()

Abc::IFloatArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::getUKnotsProperty | ( |  | ) | const

inline

Definition at line 244 of file INuPatch.h.

## getUVsParam()

IV2fGeomParam Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::getUVsParam | ( |  | ) | const

inline

Definition at line 263 of file INuPatch.h.

## getValue()

Sample Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::getValue | ( | const Abc::ISampleSelector & | iSS = `Abc::ISampleSelector()` | ) | const

inline

Definition at line 236 of file INuPatch.h.

## getVelocitiesProperty()

Abc::IV3fArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::getVelocitiesProperty | ( |  | ) | const

inline

Definition at line 247 of file INuPatch.h.

## getVKnotsProperty()

Abc::IFloatArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::getVKnotsProperty | ( |  | ) | const

inline

Definition at line 245 of file INuPatch.h.

## hasTrimCurve()

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::hasTrimCurve | ( |  | ) | const

inline

Definition at line 269 of file INuPatch.h.

## hasTrimProps()

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::hasTrimProps | ( |  | ) | const

protected

## init()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::init | ( | const Abc::Argument & | iArg0,
|  | const Abc::Argument & | iArg1
| ) |  |

protected

## isConstant()

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::isConstant | ( |  | ) | const

inline

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

Definition at line 225 of file INuPatch.h.

References Alembic::AbcGeom::ALEMBIC_VERSION_NS::kConstantTopology.

## reset()

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

inlinevirtual

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

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

Definition at line 282 of file INuPatch.h.

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

Here is the call graph for this function:

## trimCurveTopologyIsConstant()

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::trimCurveTopologyIsConstant | ( |  | ) | const

## trimCurveTopologyIsHomogenous()

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::trimCurveTopologyIsHomogenous | ( |  | ) | const

## valid()

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

inlinevirtual

Valid returns whether this function set is valid.

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

Definition at line 314 of file INuPatch.h.

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

Here is the call graph for this function:

## Member Data Documentation

## m_hasTrimCurve

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_hasTrimCurve

protected

Definition at line 364 of file INuPatch.h.

## m_normalsParam

IN3fGeomParam Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_normalsParam

protected

Definition at line 349 of file INuPatch.h.

## m_numUProperty

Abc::IInt32Property Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_numUProperty

protected

Definition at line 339 of file INuPatch.h.

## m_numVProperty

Abc::IInt32Property Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_numVProperty

protected

Definition at line 340 of file INuPatch.h.

## m_positionsProperty

Abc::IP3fArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_positionsProperty

protected

Definition at line 338 of file INuPatch.h.

## m_positionWeightsProperty

Abc::IFloatArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_positionWeightsProperty

protected

Definition at line 348 of file INuPatch.h.

## m_trimKnotProperty

Abc::IFloatArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_trimKnotProperty

protected

Definition at line 357 of file INuPatch.h.

## m_trimMaxProperty

Abc::IFloatArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_trimMaxProperty

protected

Definition at line 359 of file INuPatch.h.

## m_trimMinProperty

Abc::IFloatArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_trimMinProperty

protected

Definition at line 358 of file INuPatch.h.

## m_trimNumCurvesProperty

Abc::IInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_trimNumCurvesProperty

protected

Definition at line 355 of file INuPatch.h.

## m_trimNumLoopsProperty

Abc::IInt32Property Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_trimNumLoopsProperty

protected

Definition at line 353 of file INuPatch.h.

## m_trimNumVerticesProperty

Abc::IInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_trimNumVerticesProperty

protected

Definition at line 354 of file INuPatch.h.

## m_trimOrderProperty

Abc::IInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_trimOrderProperty

protected

Definition at line 356 of file INuPatch.h.

## m_trimUProperty

Abc::IFloatArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_trimUProperty

protected

Definition at line 360 of file INuPatch.h.

## m_trimVProperty

Abc::IFloatArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_trimVProperty

protected

Definition at line 361 of file INuPatch.h.

## m_trimWProperty

Abc::IFloatArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_trimWProperty

protected

Definition at line 362 of file INuPatch.h.

## m_uKnotProperty

Abc::IFloatArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_uKnotProperty

protected

Definition at line 343 of file INuPatch.h.

## m_uOrderProperty

Abc::IInt32Property Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_uOrderProperty

protected

Definition at line 341 of file INuPatch.h.

## m_uvsParam

IV2fGeomParam Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_uvsParam

protected

Definition at line 350 of file INuPatch.h.

## m_velocitiesProperty

Abc::IV3fArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_velocitiesProperty

protected

Definition at line 347 of file INuPatch.h.

## m_vKnotProperty

Abc::IFloatArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_vKnotProperty

protected

Definition at line 344 of file INuPatch.h.

## m_vOrderProperty

Abc::IInt32Property Alembic::AbcGeom::ALEMBIC_VERSION_NS::INuPatchSchema::m_vOrderProperty

protected

Definition at line 342 of file INuPatch.h.

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

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