GABC_NAMESPACE::GABC_IArray Class Reference

#include <GABC_IArray.h>

Inheritance diagram for GABC_NAMESPACE::GABC_IArray:

Classes
class	Container

Public Types
using	index_t = Alembic::Abc::index_t
using	chrono_t = Alembic::Abc::chrono_t
using	ArraySamplePtr = Alembic::Abc::ArraySamplePtr
using	IArrayProperty = Alembic::Abc::IArrayProperty
using	ISampleSelector = Alembic::Abc::ISampleSelector
using	PlainOldDataType = Alembic::Abc::PlainOldDataType

Public Member Functions
	GABC_IArray ()
	GABC_IArray (const GABC_IArray &src)
	GABC_IArray (GABC_IArchive &archive, const ArraySamplePtr &array, GT_Size size, int tuple_size, GT_Storage storage, GT_Type tinfo, bool is_constant)
	~GABC_IArray () override
GABC_IArray &	operator= (const GABC_IArray &src)
bool	valid () const
const void *	data () const
PlainOldDataType	abcType () const
int	tupleSize () const
GT_Size	entries () const
GT_Type	gtType () const
bool	isConstant () const
void	purge () override
Public Member Functions inherited from GABC_NAMESPACE::GABC_IItem
	GABC_IItem (const GABC_IArchivePtr &arch=NULL)
	GABC_IItem (const GABC_IItem &src)
virtual	~GABC_IItem ()
GABC_IItem &	operator= (const GABC_IItem &src)
const GABC_IArchivePtr &	archive () const
void	setArchive (const GABC_IArchivePtr &a)

Static Public Member Functions
static GABC_IArray	getSample (GABC_IArchive &arch, const ArraySamplePtr &sample, GT_Type type, int array_extent, bool is_constant)
static GABC_IArray	getSample (GABC_IArchive &arch, const IArrayProperty &prop, index_t index, GT_Type type=GT_TYPE_NONE)
static GABC_IArray	getSample (GABC_IArchive &arch, const IArrayProperty &prop, chrono_t time, GT_Type type=GT_TYPE_NONE)
static GABC_IArray	getSample (GABC_IArchive &arch, const IArrayProperty &prop, const ISampleSelector &iss, GT_Type type)

Detailed Description

This class wraps an Alembic data array and provides convenience methods that allow thread-safe access to its data.

Do not grab and hold onto the contained data array as this may cause referencing issues on archives.

Definition at line 47 of file GABC_IArray.h.

Member Typedef Documentation

using GABC_NAMESPACE::GABC_IArray::ArraySamplePtr = Alembic::Abc::ArraySamplePtr

Definition at line 52 of file GABC_IArray.h.

using GABC_NAMESPACE::GABC_IArray::chrono_t = Alembic::Abc::chrono_t

Definition at line 51 of file GABC_IArray.h.

using GABC_NAMESPACE::GABC_IArray::IArrayProperty = Alembic::Abc::IArrayProperty

Definition at line 53 of file GABC_IArray.h.

using GABC_NAMESPACE::GABC_IArray::index_t = Alembic::Abc::index_t

Definition at line 50 of file GABC_IArray.h.

using GABC_NAMESPACE::GABC_IArray::ISampleSelector = Alembic::Abc::ISampleSelector

Definition at line 54 of file GABC_IArray.h.

using GABC_NAMESPACE::GABC_IArray::PlainOldDataType = Alembic::Abc::PlainOldDataType

Definition at line 55 of file GABC_IArray.h.

Constructor & Destructor Documentation

GABC_NAMESPACE::GABC_IArray::GABC_IArray ( )

inline

Definition at line 80 of file GABC_IArray.h.

GABC_NAMESPACE::GABC_IArray::GABC_IArray ( const GABC_IArray &  src )

inline

Definition at line 89 of file GABC_IArray.h.

GABC_NAMESPACE::GABC_IArray::GABC_IArray ( GABC_IArchive &  archive, const ArraySamplePtr &  array, GT_Size  size, int  tuple_size, GT_Storage  storage, GT_Type  tinfo, bool  is_constant  )

inline

Definition at line 98 of file GABC_IArray.h.

GABC_NAMESPACE::GABC_IArray::~GABC_IArray ( )

override

Member Function Documentation

PlainOldDataType GABC_NAMESPACE::GABC_IArray::abcType ( ) const

inline

Definition at line 157 of file GABC_IArray.h.

const void* GABC_NAMESPACE::GABC_IArray::data ( ) const

inline

Definition at line 156 of file GABC_IArray.h.

GT_Size GABC_NAMESPACE::GABC_IArray::entries ( ) const

inline

Definition at line 160 of file GABC_IArray.h.

static GABC_IArray GABC_NAMESPACE::GABC_IArray::getSample ( GABC_IArchive &  arch, const ArraySamplePtr &  sample, GT_Type  type, int  array_extent, bool  is_constant  )

static

Create an array wrapper for the given array sample with the specified GT_Type as the interpretation.

static GABC_IArray GABC_NAMESPACE::GABC_IArray::getSample ( GABC_IArchive &  arch, const IArrayProperty &  prop, index_t  index, GT_Type  type = GT_TYPE_NONE  )

inlinestatic

Definition at line 63 of file GABC_IArray.h.

static GABC_IArray GABC_NAMESPACE::GABC_IArray::getSample ( GABC_IArchive &  arch, const IArrayProperty &  prop, chrono_t  time, GT_Type  type = GT_TYPE_NONE  )

inlinestatic

Definition at line 69 of file GABC_IArray.h.

static GABC_IArray GABC_NAMESPACE::GABC_IArray::getSample ( GABC_IArchive &  arch, const IArrayProperty &  prop, const ISampleSelector &  iss, GT_Type  type  )

static

GT_Type GABC_NAMESPACE::GABC_IArray::gtType ( ) const

inline

Definition at line 161 of file GABC_IArray.h.

bool GABC_NAMESPACE::GABC_IArray::isConstant ( ) const

inline

Definition at line 162 of file GABC_IArray.h.

GABC_IArray& GABC_NAMESPACE::GABC_IArray::operator= ( const GABC_IArray &  src )

inline

Definition at line 115 of file GABC_IArray.h.

void GABC_NAMESPACE::GABC_IArray::purge ( )

overridevirtual

Purge any references to objects in the Alembic archive. Once the object is purged, it should be considered to be an invalid object. The object does not have to re-resolve itself.

Warning

The purge() method should not alter the base class archive.

Implements GABC_NAMESPACE::GABC_IItem.

int GABC_NAMESPACE::GABC_IArray::tupleSize ( ) const

inline

Definition at line 158 of file GABC_IArray.h.

bool GABC_NAMESPACE::GABC_IArray::valid ( ) const

inline

Definition at line 125 of file GABC_IArray.h.

---

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

• GABC/GABC_IArray.h