Foxit PDF SDK
foxit::addon::pdf3d::PDF3DAnnotInstanceArray Class Reference

This class represents an array of PDF3DAnnotInstance. More...

Inherits Object.

Public Member Functions

 PDF3DAnnotInstanceArray ()
 Constructor.
 
 PDF3DAnnotInstanceArray (const PDF3DAnnotInstanceArray &other)
 Constructor, with another array object. More...
 
 ~ PDF3DAnnotInstanceArray ()
 Destructor.
 
void Add (const PDF3DAnnotInstance &element)
 Add an element to the end of current array. More...
 
PDF3DAnnotInstance GetAt (size_t index) const
 Retrieve a copy of the element at position specified by index in current array. More...
 
size_t GetSize () const
 Get the size of elements in current array. More...
 
void InsertAt (size_t index, const PDF3DAnnotInstance &element)
 Insert an element before the position specified by index. More...
 
PDF3DAnnotInstanceArrayoperator= (const PDF3DAnnotInstanceArray &other)
 Assign operator. More...
 
PDF3DAnnotInstanceoperator[] (size_t index) const
 Retrieve a reference to the element at position specified by index in current array. More...
 
void RemoveAll ()
 Remove all the element from current array. More...
 
void RemoveAt (size_t index)
 Remove the element in position specified by index. More...
 

Detailed Description

This class represents an array of PDF3DAnnotInstance.

Constructor & Destructor Documentation

◆ PDF3DAnnotInstanceArray()

foxit::addon::pdf3d::PDF3DAnnotInstanceArray::PDF3DAnnotInstanceArray ( const PDF3DAnnotInstanceArray other)

Constructor, with another array object.

Parameters
[in]otherAnother array object.

Member Function Documentation

◆ Add()

void foxit::addon::pdf3d::PDF3DAnnotInstanceArray::Add ( const PDF3DAnnotInstance element)

Add an element to the end of current array.

Parameters
[in]elementNew element to be added to current array.
Returns
None.

◆ GetAt()

PDF3DAnnotInstance foxit::addon::pdf3d::PDF3DAnnotInstanceArray::GetAt ( size_t  index) const

Retrieve a copy of the element at position specified by index in current array.

Parameters
[in]indexAn index to specify which element is to be retrieved.
Returns
A copy of an element.

◆ GetSize()

size_t foxit::addon::pdf3d::PDF3DAnnotInstanceArray::GetSize ( ) const

Get the size of elements in current array.

Returns
The size.

◆ InsertAt()

void foxit::addon::pdf3d::PDF3DAnnotInstanceArray::InsertAt ( size_t  index,
const PDF3DAnnotInstance element 
)

Insert an element before the position specified by index.

Parameters
[in]indexAn index to specify where to insert the new element. Valid range: from 0 to (size-1). size is the size of elements in current array.
[in]elementNew element to be inserted to current array.
Returns
None.

◆ operator=()

PDF3DAnnotInstanceArray& foxit::addon::pdf3d::PDF3DAnnotInstanceArray::operator= ( const PDF3DAnnotInstanceArray other)

Assign operator.

Parameters
[in]otherAnother array object, whose value will be assigned to current object.
Returns
Reference to current object itself.

◆ operator[]()

PDF3DAnnotInstance& foxit::addon::pdf3d::PDF3DAnnotInstanceArray::operator[] ( size_t  index) const

Retrieve a reference to the element at position specified by index in current array.

Parameters
[in]indexAn index to specify which element is to be retrieved.
Returns
Reference to an element.

◆ RemoveAll()

void foxit::addon::pdf3d::PDF3DAnnotInstanceArray::RemoveAll ( )

Remove all the element from current array.

Returns
None.

◆ RemoveAt()

void foxit::addon::pdf3d::PDF3DAnnotInstanceArray::RemoveAt ( size_t  index)

Remove the element in position specified by index.

Parameters
[in]indexAn index to specify which element is to be removed. Valid range: from 0 to (size-1). size is the size of elements in current array.
Returns
None.