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

#include <IArrayProperty.h>

+ Inheritance diagram for Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty:

Public Types

typedef IArrayProperty this_type
 

Public Member Functions

 IArrayProperty ()
 
template<class OBJECT_PTR >
 IArrayProperty (OBJECT_PTR iParentObject, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 IArrayProperty (AbcA::ArrayPropertyReaderPtr iPtr, WrapExistingFlag iWrapFlag, ErrorHandler::Policy iPolicy=ErrorHandler::kThrowPolicy)
 
 ~IArrayProperty ()
 
size_t getNumSamples () const
 
bool isConstant () const
 
bool isScalarLike () const
 Ask if we are like a scalar - we have 1 and only 1 DataType per sample. More...
 
AbcA::TimeSamplingPtr getTimeSampling () const
 Time information. More...
 
void get (AbcA::ArraySamplePtr &oSample, const ISampleSelector &iSS=ISampleSelector()) const
 
void getAs (void *oSample, AbcA::PlainOldDataType iPod, const ISampleSelector &iSS=ISampleSelector())
 Get a sample into the address of a datum as a particular POD type. More...
 
void getAs (void *oSample, const ISampleSelector &iSS=ISampleSelector())
 
bool getKey (AbcA::ArraySampleKey &oKey, const ISampleSelector &iSS=ISampleSelector()) const
 
void getDimensions (Util::Dimensions &oDim, const ISampleSelector &iSS=ISampleSelector()) const
 Get the dimensions of the datum. More...
 
ICompoundProperty getParent () const
 
template<class CPROP_PTR >
 IArrayProperty (CPROP_PTR iParentProp, const std::string &iName, const Argument &iArg0, const Argument &iArg1)
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::ArrayPropertyReaderPtr >
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::ArrayPropertyReaderPtr 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
 

Additional Inherited Members

- Protected Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::ArrayPropertyReaderPtr >
typedef IBasePropertyT
< AbcA::ArrayPropertyReaderPtr
this_type
 
typedef IBasePropertyT
< AbcA::ArrayPropertyReaderPtr
operator_bool_base_type
 
- Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::ArrayPropertyReaderPtr >
 IBasePropertyT ()
 
 IBasePropertyT (AbcA::ArrayPropertyReaderPtriPtr, 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 ()
 
- Protected Attributes inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::ArrayPropertyReaderPtr >
AbcA::ArrayPropertyReaderPtr m_property
 

Detailed Description

Definition at line 52 of file IArrayProperty.h.

Member Typedef Documentation

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

Definition at line 58 of file IArrayProperty.h.

Constructor & Destructor Documentation

Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::IArrayProperty ( )
inline

The default constructor creates an empty IArrayProperty function set. ...

Definition at line 66 of file IArrayProperty.h.

template<class OBJECT_PTR >
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::IArrayProperty ( OBJECT_PTR  iParentObject,
const std::string iName,
const Argument iArg0 = Argument(),
const Argument iArg1 = Argument() 
)

This templated, explicit function creates a new array property reader. The first argument is any Abc (or AbcCoreAbstract) object which can intrusively be converted to a CompoundPropertyReaderPtr 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 protocol matching policy, and that's it.

Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::IArrayProperty ( AbcA::ArrayPropertyReaderPtr  iPtr,
WrapExistingFlag  iWrapFlag,
ErrorHandler::Policy  iPolicy = ErrorHandler::kThrowPolicy 
)
inline

This attaches an IArrayProperty wrapper around an existing ArrayPropertyReaderPtr, with an optional error handling policy.

Parameters
iPtrThe pointer ...
iWrapFlagThe flag indicating that wrapping is intended. Even though it's nonambiguous here, we use it anyway for readability
iPolicyOptional error handling policy ...

Definition at line 84 of file IArrayProperty.h.

Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::~IArrayProperty ( )

Default copy constructor used Default assignment operator used. Destructor ...

template<class CPROP_PTR >
Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::IArrayProperty ( CPROP_PTR  iParentProp,
const std::string iName,
const Argument iArg0,
const Argument iArg1 
)
inline

Definition at line 171 of file IArrayProperty.h.

Member Function Documentation

void Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::get ( AbcA::ArraySamplePtr oSample,
const ISampleSelector iSS = ISampleSelector() 
) const

Get a sample into the address of a datum. ...

void Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::getAs ( void oSample,
AbcA::PlainOldDataType  iPod,
const ISampleSelector iSS = ISampleSelector() 
)

Get a sample into the address of a datum as a particular POD type.

void Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::getAs ( void oSample,
const ISampleSelector iSS = ISampleSelector() 
)

Get a sample into the address of a datum as the POD type of this array property.

void Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::getDimensions ( Util::Dimensions oDim,
const ISampleSelector iSS = ISampleSelector() 
) const

Get the dimensions of the datum.

bool Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::getKey ( AbcA::ArraySampleKey oKey,
const ISampleSelector iSS = ISampleSelector() 
) const

Get a key from an address of a datum. ...

size_t Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::getNumSamples ( ) const

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.

ICompoundProperty Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::getParent ( ) const

Return the parent compound property, handily wrapped in a ICompoundProperty wrapper.

AbcA::TimeSamplingPtr Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::getTimeSampling ( ) const

Time information.

bool Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::isConstant ( ) const

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

bool Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty::isScalarLike ( ) const

Ask if we are like a scalar - we have 1 and only 1 DataType per sample.


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