Alembic Version 1.1

Loading...
Searching...
No Matches
Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS > Class Template Reference

`#include <IGeomParam.h>`

Collaboration diagram for Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >:
[legend]

## Classes
class | Sample

## Public Types
typedef TRAITS::value_type | value_type
typedef Abc::ITypedArrayProperty< TRAITS > | prop_type
typedef ITypedGeomParam< TRAITS > | this_type
typedef this_type::Sample | sample_type

## Public Member Functions
| ITypedGeomParam ()
template<class CPROP>
| ITypedGeomParam (CPROP iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
template<class PROP>
| ITypedGeomParam (PROP iThis, WrapExistingFlag iWrapFlag, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument())
void | getIndexed (sample_type &oSamp, const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
void | getExpanded (sample_type &oSamp, const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
sample_type | getIndexedValue (const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
sample_type | getExpandedValue (const Abc::ISampleSelector &iSS=Abc::ISampleSelector()) const
size_t | getNumSamples () const
AbcA::DataType | getDataType () const
size_t | getArrayExtent () const
bool | isIndexed () const
GeometryScope | getScope () const
AbcA::TimeSamplingPtr | getTimeSampling () const
const std::string & | getName () const
Abc::ICompoundProperty | getParent () const
const AbcA::PropertyHeader & | getHeader () const
const AbcA::MetaData & | getMetaData () const
bool | isConstant () const
void | reset ()
bool | valid () const
| ALEMBIC_OPERATOR_BOOL (this_type::valid())
prop_type | getValueProperty ()
Abc::IUInt32ArrayProperty | getIndexProperty ()

## Static Public Member Functions
static const char * | getInterpretation ()
static bool | matches (const AbcA::PropertyHeader &iHeader, SchemaInterpMatching iMatching=kStrictMatching)

## Protected Attributes
prop_type | m_valProp
Abc::IUInt32ArrayProperty | m_indicesProperty
Abc::ICompoundProperty | m_cprop
bool | m_isIndexed

## Detailed Description

template<class TRAITS>
class Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >

Definition at line 49 of file IGeomParam.h.

## Member Typedef Documentation

## ◆ prop_type

template<class TRAITS>

typedef Abc::ITypedArrayProperty<TRAITS> Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::prop_type

Definition at line 53 of file IGeomParam.h.

## ◆ sample_type

template<class TRAITS>

typedef this_type::Sample Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::sample_type

Definition at line 91 of file IGeomParam.h.

## ◆ this_type

template<class TRAITS>

typedef ITypedGeomParam<TRAITS> Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::this_type

Definition at line 90 of file IGeomParam.h.

## ◆ value_type

template<class TRAITS>

typedef TRAITS::value_type Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::value_type

Definition at line 52 of file IGeomParam.h.

## Constructor & Destructor Documentation

## ◆ ITypedGeomParam() [1/3]

template<class TRAITS>

Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::ITypedGeomParam | ( |  | ) |
| inline

Definition at line 119 of file IGeomParam.h.

Referenced by Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::Sample::ALEMBIC_OPERATOR_BOOL().

Here is the caller graph for this function:

## ◆ ITypedGeomParam() [2/3]

template<class TRAITS>
template<class CPROP>

Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::ITypedGeomParam | ( | CPROP | iParent,
|  | const std::string & | iName,
|  | const Abc::Argument & | iArg0 = Abc::Argument(),
|  | const Abc::Argument & | iArg1 = Abc::Argument() )

Definition at line 222 of file IGeomParam.h.

References ABCA_ASSERT, ALEMBIC_ABC_SAFE_CALL_BEGIN, ALEMBIC_ABC_SAFE_CALL_END, Alembic::Abc::ALEMBIC_VERSION_NS::GetCompoundPropertyReaderPtr(), Alembic::Abc::ALEMBIC_VERSION_NS::GetErrorHandlerPolicy(), Alembic::Abc::ALEMBIC_VERSION_NS::Arguments::getErrorHandlerPolicy(), m_cprop, m_indicesProperty, m_isIndexed, m_valProp, and Alembic::Abc::ALEMBIC_VERSION_NS::Argument::setInto().

Here is the call graph for this function:

## ◆ ITypedGeomParam() [3/3]

template<class TRAITS>
template<class PROP>

Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::ITypedGeomParam | ( | PROP | iThis,
|  | WrapExistingFlag | iWrapFlag,
|  | const Abc::Argument & | iArg0 = Abc::Argument(),
|  | const Abc::Argument & | iArg1 = Abc::Argument() )

Definition at line 275 of file IGeomParam.h.

References ABCA_ASSERT, ALEMBIC_ABC_SAFE_CALL_BEGIN, ALEMBIC_ABC_SAFE_CALL_END_RESET, Alembic::Abc::ALEMBIC_VERSION_NS::GetErrorHandlerPolicy(), Alembic::Abc::ALEMBIC_VERSION_NS::Arguments::getErrorHandlerPolicy(), Alembic::Abc::ALEMBIC_VERSION_NS::GetSchemaInterpMatching(), m_cprop, m_indicesProperty, m_isIndexed, m_valProp, matches(), and Alembic::Abc::ALEMBIC_VERSION_NS::Argument::setInto().

Here is the call graph for this function:

## Member Function Documentation

## ◆ ALEMBIC_OPERATOR_BOOL()

template<class TRAITS>

Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::ALEMBIC_OPERATOR_BOOL | ( | this_type::valid() |  | ) |

## ◆ getArrayExtent()

template<class TRAITS>

size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::getArrayExtent | ( |  | ) | const
| inline

Definition at line 159 of file IGeomParam.h.

## ◆ getDataType()

template<class TRAITS>

AbcA::DataType Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::getDataType | ( |  | ) | const
| inline

Definition at line 157 of file IGeomParam.h.

## ◆ getExpanded()

template<class TRAITS>

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::getExpanded | ( | sample_type & | oSamp,
|  | const Abc::ISampleSelector & | iSS = Abc::ISampleSelector() ) const

Definition at line 352 of file IGeomParam.h.

References getScope(), m_indicesProperty, m_isIndexed, Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::Sample::m_isIndexed, Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::Sample::m_scope, m_valProp, and Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::Sample::m_vals.

Referenced by Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< BooleanTPTraits >::getExpandedValue().

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

## ◆ getExpandedValue()

template<class TRAITS>

sample_type Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::getExpandedValue | ( | const Abc::ISampleSelector & | iSS = Abc::ISampleSelector() | ) | const
| inline

Definition at line 147 of file IGeomParam.h.

## ◆ getHeader()

template<class TRAITS>

const AbcA::PropertyHeader & Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::getHeader | ( |  | ) | const

Definition at line 469 of file IGeomParam.h.

References m_cprop, m_isIndexed, and m_valProp.

## ◆ getIndexed()

template<class TRAITS>

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::getIndexed | ( | sample_type & | oSamp,
|  | const Abc::ISampleSelector & | iSS = Abc::ISampleSelector() ) const

Definition at line 322 of file IGeomParam.h.

References getScope(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::Sample::m_indices, m_indicesProperty, m_isIndexed, Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::Sample::m_isIndexed, Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::Sample::m_scope, m_valProp, and Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::Sample::m_vals.

Referenced by Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< BooleanTPTraits >::getIndexedValue().

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

## ◆ getIndexedValue()

template<class TRAITS>

sample_type Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::getIndexedValue | ( | const Abc::ISampleSelector & | iSS = Abc::ISampleSelector() | ) | const
| inline

Definition at line 139 of file IGeomParam.h.

## ◆ getIndexProperty()

template<class TRAITS>

Abc::IUInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::getIndexProperty | ( |  | ) |
| inline

Definition at line 201 of file IGeomParam.h.

## ◆ getInterpretation()

template<class TRAITS>

const char * Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::getInterpretation | ( |  | ) |
| inline static

Definition at line 93 of file IGeomParam.h.

## ◆ getMetaData()

template<class TRAITS>

const AbcA::MetaData & Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::getMetaData | ( |  | ) | const

Definition at line 477 of file IGeomParam.h.

References m_cprop, m_isIndexed, and m_valProp.

## ◆ getName()

template<class TRAITS>

const std::string & Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::getName | ( |  | ) | const

Definition at line 447 of file IGeomParam.h.

References ALEMBIC_ABC_SAFE_CALL_BEGIN, ALEMBIC_ABC_SAFE_CALL_END, m_cprop, m_isIndexed, and m_valProp.

## ◆ getNumSamples()

template<class TRAITS>

size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::getNumSamples | ( |  | ) | const

Definition at line 402 of file IGeomParam.h.

References ALEMBIC_ABC_SAFE_CALL_BEGIN, ALEMBIC_ABC_SAFE_CALL_END, m_indicesProperty, m_isIndexed, and m_valProp.

## ◆ getParent()

template<class TRAITS>

Abc::ICompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::getParent | ( |  | ) | const

Definition at line 461 of file IGeomParam.h.

References m_cprop, m_isIndexed, and m_valProp.

## ◆ getScope()

template<class TRAITS>

GeometryScope Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::getScope | ( |  | ) | const
| inline

Definition at line 168 of file IGeomParam.h.

Referenced by getExpanded(), and getIndexed().

Here is the caller graph for this function:

## ◆ getTimeSampling()

template<class TRAITS>

AbcA::TimeSamplingPtr Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::getTimeSampling | ( |  | ) | const

Definition at line 485 of file IGeomParam.h.

References m_indicesProperty, and m_valProp.

## ◆ getValueProperty()

template<class TRAITS>

prop_type Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::getValueProperty | ( |  | ) |
| inline

Definition at line 199 of file IGeomParam.h.

## ◆ isConstant()

template<class TRAITS>

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::isConstant | ( |  | ) | const

Definition at line 424 of file IGeomParam.h.

References ALEMBIC_ABC_SAFE_CALL_BEGIN, ALEMBIC_ABC_SAFE_CALL_END, m_indicesProperty, m_isIndexed, and m_valProp.

## ◆ isIndexed()

template<class TRAITS>

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::isIndexed | ( |  | ) | const
| inline

Definition at line 166 of file IGeomParam.h.

## ◆ matches()

template<class TRAITS>

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::matches | ( | const AbcA::PropertyHeader & | iHeader,
|  | SchemaInterpMatching | iMatching = kStrictMatching )
| inline static

Definition at line 98 of file IGeomParam.h.

Referenced by ITypedGeomParam().

Here is the caller graph for this function:

## ◆ reset()

template<class TRAITS>

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::reset | ( |  | ) |
| inline

Definition at line 183 of file IGeomParam.h.

## ◆ valid()

template<class TRAITS>

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::valid | ( |  | ) | const
| inline

Definition at line 191 of file IGeomParam.h.

## Member Data Documentation

## ◆ m_cprop

template<class TRAITS>

Abc::ICompoundProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::m_cprop
| protected

Definition at line 212 of file IGeomParam.h.

Referenced by ITypedGeomParam(), ITypedGeomParam(), getHeader(), getMetaData(), getName(), and getParent().

## ◆ m_indicesProperty

template<class TRAITS>

Abc::IUInt32ArrayProperty Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::m_indicesProperty
| protected

Definition at line 211 of file IGeomParam.h.

Referenced by ITypedGeomParam(), ITypedGeomParam(), getExpanded(), getIndexed(), getNumSamples(), getTimeSampling(), and isConstant().

## ◆ m_isIndexed

template<class TRAITS>

bool Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::m_isIndexed
| protected

Definition at line 214 of file IGeomParam.h.

Referenced by ITypedGeomParam(), ITypedGeomParam(), getExpanded(), getHeader(), getIndexed(), getMetaData(), getName(), getNumSamples(), getParent(), and isConstant().

## ◆ m_valProp

template<class TRAITS>

prop_type Alembic::AbcGeom::ALEMBIC_VERSION_NS::ITypedGeomParam< TRAITS >::m_valProp
| protected

Definition at line 208 of file IGeomParam.h.

Referenced by ITypedGeomParam(), ITypedGeomParam(), getExpanded(), getHeader(), getIndexed(), getMetaData(), getName(), getNumSamples(), getParent(), getTimeSampling(), and isConstant().

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

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