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

#include <OScalarProperty.h>

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

Public Types

typedef OScalarProperty this_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::ScalarPropertyWriterPtr >
typedef OBasePropertyT
< AbcA::ScalarPropertyWriterPtr
this_type
 
typedef OBasePropertyT
< AbcA::ScalarPropertyWriterPtr
operator_bool_base_type
 

Public Member Functions

 OScalarProperty ()
 
template<class OBJECT_PTR >
 OScalarProperty (OBJECT_PTR iParentObject, const std::string &iName, const AbcA::DataType &iDataType, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument())
 
 OScalarProperty (AbcA::ScalarPropertyWriterPtr iPtr, WrapExistingFlag iWrapFlag, ErrorHandler::Policy iPolicy=ErrorHandler::kThrowPolicy)
 
 ~OScalarProperty ()
 
size_t getNumSamples () const
 
void set (const void *iSample)
 
void setFromPrevious ()
 
void setTimeSampling (uint32_t iIndex)
 
void setTimeSampling (AbcA::TimeSamplingPtr iTime)
 
OCompoundProperty getParent () const
 
template<class CPROP_PTR >
 OScalarProperty (CPROP_PTR iParentProp, const std::string &iName, const AbcA::DataType &iDataType, const Argument &iArg0, const Argument &iArg1, const Argument &iArg2)
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::ScalarPropertyWriterPtr >
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
 
OObject getObject () const
 
AbcA::ScalarPropertyWriterPtr 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 Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::ScalarPropertyWriterPtr >
 OBasePropertyT ()
 
 OBasePropertyT (AbcA::ScalarPropertyWriterPtriPtr, WrapExistingFlag, 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::OBasePropertyT< AbcA::ScalarPropertyWriterPtr >
AbcA::ScalarPropertyWriterPtr m_property
 

Detailed Description

Definition at line 51 of file OScalarProperty.h.

Member Typedef Documentation

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

Definition at line 57 of file OScalarProperty.h.

Constructor & Destructor Documentation

Alembic::Abc::ALEMBIC_VERSION_NS::OScalarProperty::OScalarProperty ( )
inline

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

Definition at line 65 of file OScalarProperty.h.

template<class OBJECT_PTR >
Alembic::Abc::ALEMBIC_VERSION_NS::OScalarProperty::OScalarProperty ( OBJECT_PTR  iParentObject,
const std::string iName,
const AbcA::DataType iDataType,
const Argument iArg0 = Argument(),
const Argument iArg1 = Argument(),
const Argument iArg2 = Argument() 
)

This templated, explicit function creates a new scalar property writer. The first argument is any Abc (or AbcCoreAbstract) object which can intrusively be converted to a 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 specify time sampling or time sampling index.

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

This attaches an OScalarProperty wrapper around an existing ScalarPropertyWriterPtr, arguments are there to specify ErrorHandling policy,

Parameters
iPtrThe pointer ...
iWrapFlagThe flag indicating that wrapping is intended. Even though it's nonambiguous here, we use it anyway for readability
iPolicyError Handling Policy ..

Definition at line 86 of file OScalarProperty.h.

Alembic::Abc::ALEMBIC_VERSION_NS::OScalarProperty::~OScalarProperty ( )

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

template<class CPROP_PTR >
Alembic::Abc::ALEMBIC_VERSION_NS::OScalarProperty::OScalarProperty ( CPROP_PTR  iParentProp,
const std::string iName,
const AbcA::DataType iDataType,
const Argument iArg0,
const Argument iArg1,
const Argument iArg2 
)
inline

Definition at line 164 of file OScalarProperty.h.

Member Function Documentation

size_t Alembic::Abc::ALEMBIC_VERSION_NS::OScalarProperty::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. It make change over time as more samples are written.

OCompoundProperty Alembic::Abc::ALEMBIC_VERSION_NS::OScalarProperty::getParent ( ) const

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

void Alembic::Abc::ALEMBIC_VERSION_NS::OScalarProperty::set ( const void iSample)

Set a sample from the address of a datum. ...

void Alembic::Abc::ALEMBIC_VERSION_NS::OScalarProperty::setFromPrevious ( )

Set a sample from the previous sample. ...

void Alembic::Abc::ALEMBIC_VERSION_NS::OScalarProperty::setTimeSampling ( uint32_t  iIndex)

Changes the TimeSampling used by this property. If the TimeSampling is changed to Acyclic and the number of samples currently set is more than the number of times provided in the Acyclic TimeSampling, an exception will be thrown.

void Alembic::Abc::ALEMBIC_VERSION_NS::OScalarProperty::setTimeSampling ( AbcA::TimeSamplingPtr  iTime)

Changes the TimeSampling used by this property. If the TimeSampling is changed to Acyclic and the number of samples currently set is more than the number of times provided in the Acyclic TimeSampling, an exception will be thrown.


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