Alembic Version 1.1

Loading...
Searching...
No Matches
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema Class Reference

`#include <IXform.h>`

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

## Public Types
typedef Abc::ISchema< XformSchemaInfo > | super_type
typedef IXformSchema | this_type
typedef XformSample | sample_type
Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< XformSchemaInfo >
typedef XformSchemaInfo | info_type
typedef ISchema< XformSchemaInfo > | this_type
Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
typedef ICompoundProperty | this_type

## Public Member Functions
| IXformSchema ()
| IXformSchema (const ICompoundProperty &iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
| IXformSchema (const ICompoundProperty &iProp, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
| IXformSchema (const IXformSchema &iCopy)
| explicit copy constructor to work around Windows compiler bug
AbcA::TimeSamplingPtr | getTimeSampling () const
bool | isConstant () const
bool | isConstantIdentity () const
| is this xform both constant and identity?
size_t | getNumSamples () const
void | get (XformSample &oSamp, const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
| fill the supplied sample reference with values
XformSample | getValue (const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
Abc::IBox3dProperty | getChildBoundsProperty () const
bool | getInheritsXforms (const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
size_t | getNumOps () const
void | reset ()
bool | valid () const
| Valid returns whether this function set is valid.
ICompoundProperty | getArbGeomParams () const
ICompoundProperty | getUserProperties () const
| ALEMBIC_OVERRIDE_OPERATOR_BOOL (this_type::valid())
Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< XformSchemaInfo >
| 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.
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 Attributes
Abc::IBox3dProperty | m_childBoundsProperty
AbcA::BasePropertyReaderPtr | m_valsProperty
Abc::IBoolProperty | m_inheritsProperty
Abc::ICompoundProperty | m_arbGeomParams
Abc::ICompoundProperty | m_userProperties
bool | m_isConstant
bool | m_isConstantIdentity
XformSample | m_sample
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< XformSchemaInfo >
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
Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >
| IBasePropertyT ()
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 ()

## Detailed Description

Definition at line 51 of file IXform.h.

## Member Typedef Documentation

## ◆ sample_type

typedef XformSample Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::sample_type

Definition at line 62 of file IXform.h.

## ◆ super_type

typedef Abc::ISchema<XformSchemaInfo> Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::super_type

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

Definition at line 60 of file IXform.h.

## ◆ this_type

typedef IXformSchema Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::this_type

Definition at line 61 of file IXform.h.

## Constructor & Destructor Documentation

## ◆ IXformSchema() [1/4]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::IXformSchema | ( |  | ) |
| inline

The default constructor creates an empty OPolyMeshSchema ...

Definition at line 70 of file IXform.h.

References m_isConstant, and m_isConstantIdentity.

Referenced by IXformSchema().

Here is the caller graph for this function:

## ◆ IXformSchema() [2/4]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::IXformSchema | ( | 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 xform 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 83 of file IXform.h.

References Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< XformSchemaInfo >::ISchema().

Here is the call graph for this function:

## ◆ IXformSchema() [3/4]

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

This constructor wraps an existing ICompoundProperty as the xform 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 98 of file IXform.h.

References Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< XformSchemaInfo >::ISchema().

Here is the call graph for this function:

## ◆ IXformSchema() [4/4]

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::IXformSchema | ( | const IXformSchema & | iCopy | ) |
| inline

explicit copy constructor to work around Windows compiler bug

Definition at line 107 of file IXform.h.

References Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< XformSchemaInfo >::ISchema(), and IXformSchema().

Here is the call graph for this function:

## Member Function Documentation

## ◆ ALEMBIC_OVERRIDE_OPERATOR_BOOL()

Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::ALEMBIC_OVERRIDE_OPERATOR_BOOL | ( | this_type::valid() |  | ) |

unspecified-bool-type operator overload. ...

References valid().

Here is the call graph for this function:

## ◆ get()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::get | ( | XformSample & | oSamp,
|  | const Abc::ISampleSelector & | iSS = Abc::ISampleSelector() ) const

fill the supplied sample reference with values

## ◆ getArbGeomParams()

ICompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::getArbGeomParams | ( |  | ) | const
| inline

Definition at line 163 of file IXform.h.

References m_arbGeomParams.

## ◆ getChildBoundsProperty()

Abc::IBox3dProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::getChildBoundsProperty | ( |  | ) | const
| inline

Definition at line 129 of file IXform.h.

References m_childBoundsProperty.

## ◆ getInheritsXforms()

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::getInheritsXforms | ( | const Abc::ISampleSelector & | iSS = Abc::ISampleSelector() | ) | const

## ◆ getNumOps()

size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::getNumOps | ( |  | ) | const
| inline

Definition at line 139 of file IXform.h.

References m_sample.

## ◆ getNumSamples()

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

## ◆ getTimeSampling()

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

## ◆ getUserProperties()

ICompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::getUserProperties | ( |  | ) | const
| inline

Definition at line 165 of file IXform.h.

References m_userProperties.

## ◆ getValue()

XformSample Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::getValue | ( | const Abc::ISampleSelector & | iSS = Abc::ISampleSelector() | ) | const

## ◆ isConstant()

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::isConstant | ( |  | ) | const
| inline

Definition at line 115 of file IXform.h.

References m_isConstant.

## ◆ isConstantIdentity()

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::isConstantIdentity | ( |  | ) | const
| inline

is this xform both constant and identity?

Definition at line 118 of file IXform.h.

References m_isConstantIdentity.

## ◆ reset()

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::reset | ( |  | ) |
| inline

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

Definition at line 143 of file IXform.h.

References m_arbGeomParams, m_childBoundsProperty, m_inheritsProperty, m_isConstant, m_isConstantIdentity, m_sample, m_userProperties, and Alembic::Abc::ALEMBIC_VERSION_NS::Base::reset().

Here is the call graph for this function:

## ◆ valid()

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::valid | ( |  | ) | const
| inline

Valid returns whether this function set is valid.

Definition at line 158 of file IXform.h.

References Alembic::Abc::ALEMBIC_VERSION_NS::Base::valid().

Referenced by ALEMBIC_OVERRIDE_OPERATOR_BOOL().

Here is the call graph for this function:
Here is the caller graph for this function:

## Member Data Documentation

## ◆ m_arbGeomParams

Abc::ICompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::m_arbGeomParams
| protected

Definition at line 179 of file IXform.h.

Referenced by getArbGeomParams(), and reset().

## ◆ m_childBoundsProperty

Abc::IBox3dProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::m_childBoundsProperty
| protected

Definition at line 173 of file IXform.h.

Referenced by getChildBoundsProperty(), and reset().

## ◆ m_inheritsProperty

Abc::IBoolProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::m_inheritsProperty
| protected

Definition at line 177 of file IXform.h.

Referenced by reset().

## ◆ m_isConstant

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::m_isConstant
| protected

Definition at line 182 of file IXform.h.

Referenced by IXformSchema(), isConstant(), and reset().

## ◆ m_isConstantIdentity

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::m_isConstantIdentity
| protected

Definition at line 184 of file IXform.h.

Referenced by IXformSchema(), isConstantIdentity(), and reset().

## ◆ m_sample

XformSample Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::m_sample
| protected

Definition at line 186 of file IXform.h.

Referenced by getNumOps(), and reset().

## ◆ m_userProperties

Abc::ICompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::m_userProperties
| protected

Definition at line 180 of file IXform.h.

Referenced by getUserProperties(), and reset().

## ◆ m_valsProperty

AbcA::BasePropertyReaderPtr Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::m_valsProperty
| protected

Definition at line 175 of file IXform.h.

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

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