HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GABC_NAMESPACE::GABC_OScalarProperty Class Reference

#include <GABC_OScalarProperty.h>

+ Inheritance diagram for GABC_NAMESPACE::GABC_OScalarProperty:

Public Types

typedef
Alembic::Abc::OCompoundProperty 
OCompoundProperty
 
typedef
Alembic::Abc::OScalarProperty 
OScalarProperty
 
typedef
Alembic::Util::PlainOldDataType 
PlainOldDataType
 
- Public Types inherited from GABC_NAMESPACE::GABC_OProperty
typedef
Alembic::Abc::OCompoundProperty 
OCompoundProperty
 
typedef
Alembic::Util::PlainOldDataType 
PlainOldDataType
 

Public Member Functions

 GABC_OScalarProperty (GABC_LayerOptions::LayerType ltype)
 
 ~GABC_OScalarProperty ()
 
bool start (OCompoundProperty &parent, const char *name, const GT_DataArrayHandle &array, GABC_OError &err, const GABC_OOptions &options, const PlainOldDataType pod=Alembic::Util::kUnknownPOD)
 See GABC_OProperty for information about methods. More...
 
bool update (const GT_DataArrayHandle &array, GABC_OError &err, const GABC_OOptions &options, const PlainOldDataType pod=Alembic::Abc::kUnknownPOD)
 Write GT_DataArray conents as samples to the property. More...
 
bool updateFromPrevious ()
 Reuse the previous sample . More...
 
exint getNumSamples () const
 Get number of samples written to property so far. More...
 
- Public Member Functions inherited from GABC_NAMESPACE::GABC_OProperty
 GABC_OProperty (GABC_LayerOptions::LayerType ltype)
 
virtual ~GABC_OProperty ()
 

Static Public Member Functions

static bool isValidScalarData (const GT_DataArrayHandle &array)
 true if 'array' can be represented as an Alembic scalar More...
 

Additional Inherited Members

- Protected Attributes inherited from GABC_NAMESPACE::GABC_OProperty
GT_DataArrayHandle myCache
 
GT_Size myTupleSize
 
GT_Storage myStorage
 
GT_Type myType
 
PlainOldDataType myPOD
 
voidmyBuffer
 
GABC_LayerOptions::LayerType myLayerType
 

Detailed Description

Class for exporting user property data from a GT_DataArray to an OScalarProperty.

See GABC_OProperty for more details.

Definition at line 49 of file GABC_OScalarProperty.h.

Member Typedef Documentation

Constructor & Destructor Documentation

GABC_NAMESPACE::GABC_OScalarProperty::GABC_OScalarProperty ( GABC_LayerOptions::LayerType  ltype)
inline

Definition at line 57 of file GABC_OScalarProperty.h.

GABC_NAMESPACE::GABC_OScalarProperty::~GABC_OScalarProperty ( )

Member Function Documentation

exint GABC_NAMESPACE::GABC_OScalarProperty::getNumSamples ( ) const
inlinevirtual

Get number of samples written to property so far.

Implements GABC_NAMESPACE::GABC_OProperty.

Definition at line 81 of file GABC_OScalarProperty.h.

static bool GABC_NAMESPACE::GABC_OScalarProperty::isValidScalarData ( const GT_DataArrayHandle array)
static

true if 'array' can be represented as an Alembic scalar

bool GABC_NAMESPACE::GABC_OScalarProperty::start ( OCompoundProperty parent,
const char *  name,
const GT_DataArrayHandle array,
GABC_OError err,
const GABC_OOptions options,
const PlainOldDataType  pod = Alembic::Util::kUnknownPOD 
)
virtual

See GABC_OProperty for information about methods.

Implements GABC_NAMESPACE::GABC_OProperty.

bool GABC_NAMESPACE::GABC_OScalarProperty::update ( const GT_DataArrayHandle array,
GABC_OError err,
const GABC_OOptions options,
const PlainOldDataType  pod = Alembic::Abc::kUnknownPOD 
)
virtual

Write GT_DataArray conents as samples to the property.

Implements GABC_NAMESPACE::GABC_OProperty.

bool GABC_NAMESPACE::GABC_OScalarProperty::updateFromPrevious ( )
virtual

Reuse the previous sample .

Implements GABC_NAMESPACE::GABC_OProperty.


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