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

#include <IScalarProperty.h>

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

Public Types

typedef IScalarProperty this_type
 

Public Member Functions

 IScalarProperty ()
 
template<class OBJECT_PTR >
 IScalarProperty (OBJECT_PTR iParentObject, const std::string &iName, const Argument &iArg0=Argument())
 
 IScalarProperty (AbcA::ScalarPropertyReaderPtr iPtr, WrapExistingFlag iWrapFlag, const Argument &iArg0=Argument())
 
 ~IScalarProperty ()
 
size_t getNumSamples () const
 
bool isConstant () const
 
AbcA::TimeSamplingPtr getTimeSampling () const
 
void get (void *oSample, const ISampleSelector &iSS=ISampleSelector()) const
 
ICompoundProperty getParent () const
 
template<class CPROP_PTR >
 IScalarProperty (CPROP_PTR iParentProp, const std::string &iName, const Argument &iArg0)
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::ScalarPropertyReaderPtr >
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::ScalarPropertyReaderPtr 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::ScalarPropertyReaderPtr >
typedef IBasePropertyT
< AbcA::ScalarPropertyReaderPtr
this_type
 
typedef IBasePropertyT
< AbcA::ScalarPropertyReaderPtr
operator_bool_base_type
 
- Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::ScalarPropertyReaderPtr >
 IBasePropertyT ()
 
 IBasePropertyT (AbcA::ScalarPropertyReaderPtriPtr, 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::ScalarPropertyReaderPtr >
AbcA::ScalarPropertyReaderPtr m_property
 

Detailed Description

Definition at line 52 of file IScalarProperty.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 IScalarProperty.h.

Constructor & Destructor Documentation

Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::IScalarProperty ( )
inline

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

Definition at line 66 of file IScalarProperty.h.

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

This templated, explicit function creates a new scalar 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, and that's it.

Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::IScalarProperty ( AbcA::ScalarPropertyReaderPtr  iPtr,
WrapExistingFlag  iWrapFlag,
const Argument iArg0 = Argument() 
)
inline

This attaches an IScalarProperty wrapper around an existing ScalarPropertyReaderPtr, 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
iArg0Optional error handling policy ...

Definition at line 82 of file IScalarProperty.h.

Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::~IScalarProperty ( )

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

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

Definition at line 148 of file IScalarProperty.h.

Member Function Documentation

void Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::get ( void oSample,
const ISampleSelector iSS = ISampleSelector() 
) const

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

size_t Alembic::Abc::ALEMBIC_VERSION_NS::IScalarProperty::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::IScalarProperty::getParent ( ) const

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

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

Time information. This will be valid regardless of TimeSamplingType or number of samples.

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

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


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