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

#include <IXform.h>

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

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 ()
 
template<class CPROP_PTR >
 IXformSchema (CPROP_PTR iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 
template<class CPROP_PTR >
 IXformSchema (CPROP_PTR iParent, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 
template<class CPROP_PTR >
 IXformSchema (CPROP_PTR iThis, Abc::WrapExistingFlag iFlag, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
 Wrap an existing IXform object. More...
 
 IXformSchema (const IXformSchema &iCopy)
 explicit copy constructor to work around Windows compiler bug More...
 
AbcA::TimeSamplingPtr getTimeSampling () const
 
bool isConstant () const
 
bool isConstantIdentity () const
 is this xform both constant and identity? More...
 
size_t getNumSamples () const
 
void get (XformSample &oSamp, const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
 fill the supplied sample reference with values More...
 
XformSample getValue (const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
 
Abc::IBox3dProperty getChildBoundsProperty () const
 
bool getInheritsXforms (const Abc::ISampleSelector &iSS=Abc::ISampleSelector())
 
size_t getNumOps () const
 
void reset ()
 
bool valid () const
 Valid returns whether this function set is valid. More...
 
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 (CPROP_PTR iParentObject, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 ISchema (CPROP_PTR iParentObject, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 ISchema (CPROP_PTR 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 ()
 
template<class CPROP_PTR >
 ICompoundProperty (CPROP_PTR iParentProp, const std::string &iName, const Argument &iArg0=Argument())
 
template<class CPROP_PTR >
 ICompoundProperty (CPROP_PTR iThisObject, WrapExistingFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
template<class OBJECT_PTR >
 ICompoundProperty (OBJECT_PTR iThisObject, 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 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 ()
 
 IBasePropertyT (AbcA::CompoundPropertyReaderPtriPtr, WrapExistingFlag iWrapFlag, 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 ()
 

Detailed Description

Definition at line 51 of file IXform.h.

Member Typedef Documentation

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.

Constructor & Destructor Documentation

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

The default constructor creates an empty OPolyMeshSchema ...

Definition at line 70 of file IXform.h.

template<class CPROP_PTR >
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::IXformSchema ( CPROP_PTR  iParent,
const std::string iName,
const Abc::Argument iArg0 = Abc::Argument(),
const Abc::Argument iArg1 = Abc::Argument() 
)
inline

This templated, primary constructor creates a new xform 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 80 of file IXform.h.

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

This constructor does the same as the above, but uses the default name from the XformSchemaInfo struct.

Definition at line 95 of file IXform.h.

template<class CPROP_PTR >
Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::IXformSchema ( CPROP_PTR  iThis,
Abc::WrapExistingFlag  iFlag,
const Abc::Argument iArg0 = Abc::Argument(),
const Abc::Argument iArg1 = Abc::Argument() 
)
inlineexplicit

Wrap an existing IXform object.

Definition at line 106 of file IXform.h.

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

explicit copy constructor to work around Windows compiler bug

Definition at line 117 of file IXform.h.

Member Function Documentation

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

unspecified-bool-type operator overload. ...

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

fill the supplied sample reference with values

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

Definition at line 173 of file IXform.h.

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

Definition at line 139 of file IXform.h.

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::getInheritsXforms ( const Abc::ISampleSelector iSS = Abc::ISampleSelector())
size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::getNumOps ( ) const
inline

Definition at line 149 of file IXform.h.

size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::getNumSamples ( ) const
AbcA::TimeSamplingPtr Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::getTimeSampling ( ) const
ICompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::getUserProperties ( ) const
inline

Definition at line 175 of file IXform.h.

XformSample Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::getValue ( const Abc::ISampleSelector iSS = Abc::ISampleSelector()) const
bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::IXformSchema::isConstant ( ) const
inline

Definition at line 125 of file IXform.h.

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

is this xform both constant and identity?

Definition at line 128 of file IXform.h.

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

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

Definition at line 153 of file IXform.h.

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

Valid returns whether this function set is valid.

Definition at line 168 of file IXform.h.

Member Data Documentation

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

Definition at line 189 of file IXform.h.

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

Definition at line 183 of file IXform.h.

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

Definition at line 187 of file IXform.h.

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

Definition at line 192 of file IXform.h.

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

Definition at line 194 of file IXform.h.

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

Definition at line 196 of file IXform.h.

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

Definition at line 190 of file IXform.h.

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

Definition at line 185 of file IXform.h.


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