Foxit PDF SDK
foxit.common.fxcrt.PointFArray Class Reference

An array of PointF objects. More...

Inheritance diagram for foxit.common.fxcrt.PointFArray:
foxit.common.fxcrt.BasicArray

Public Member Functions

 PointFArray ()
 Construct a simple object.
 
 PointFArray (PointFArray other)
 Constructor, with another array object. More...
 
bool Add (PointF newElement)
 Add an element at the tail. Potentially growing the array. More...
 
int Find (PointF data, int iStart)
 Find an element from specified position to last. More...
 
PointF GetAt (int nIndex)
 This method retrieves an element specified by an index number. More...
 
int GetSize ()
 Get the number of elements in the array. More...
 
int GetUpperBound ()
 Get the upper bound in the array, actually the maximum valid index. More...
 
bool InsertAt (int nIndex, PointF newElement, int nCount)
 Inset one or more continuous element at specified position. More...
 
bool InsertAt (int nStartIndex, BasicArray pNewArray)
 Inset an array at specified position. More...
 
void RemoveAll ()
 Clean up the array. More...
 
bool RemoveAt (int nIndex, int nCount)
 Remove a number of elements at specified position. More...
 
bool SetAt (int nIndex, PointF newElement)
 This method overwrites an element specified by an index number. More...
 
bool SetAtGrow (int nIndex, PointF newElement)
 Set an element value at specified position. Potentially growing the array. More...
 
bool SetSize (int nNewSize, int nGrowBy)
 Change the allocated size and the grow amount. More...
 

Detailed Description

An array of PointF objects.

Constructor & Destructor Documentation

◆ PointFArray()

foxit.pdf.graphics.PointFArray.PointFArray ( PointFArray  other)
inline

Constructor, with another array object.

Parameters
[in]otherAnother array object.

Member Function Documentation

◆ Add()

bool foxit.common.fxcrt.PointFArray.Add ( PointF  newElement)
inline

Add an element at the tail. Potentially growing the array.

Parameters
[in]newElementThe input element.
Returns
true means success, while false means failure (such as memory error).

◆ Find()

int foxit.common.fxcrt.PointFArray.Find ( PointF  data,
int  iStart 
)
inline

Find an element from specified position to last.

Parameters
[in]dataThe input element.
[in]iStartSpecifies the zero-based index of start element to find.
Returns
An index of the found element. -1 means found none.

◆ GetAt()

PointF foxit.common.fxcrt.PointFArray.GetAt ( int  nIndex)
inline

This method retrieves an element specified by an index number.

Parameters
[in]nIndexSpecifies the zero-based index of the element.
Returns
An element.

◆ GetSize()

int foxit.common.fxcrt.PointFArray.GetSize ( )
inline

Get the number of elements in the array.

Returns
The number of elements in the array.

◆ GetUpperBound()

int foxit.common.fxcrt.PointFArray.GetUpperBound ( )
inline

Get the upper bound in the array, actually the maximum valid index.

Returns
The upper bound.

◆ InsertAt() [1/2]

bool foxit.common.fxcrt.PointFArray.InsertAt ( int  nIndex,
PointF  newElement,
int  nCount 
)
inline

Inset one or more continuous element at specified position.

Parameters
[in]nIndexSpecifies the zero-based index in the array.
[in]newElementSpecifies the element value to insert.
[in]nCountSpecifies the count of the element to insert.
Returns
true means success, while false means failure (such as parameter or memory error).

◆ InsertAt() [2/2]

bool foxit.common.fxcrt.PointFArray.InsertAt ( int  nStartIndex,
BasicArray  pNewArray 
)
inline

Inset an array at specified position.

Parameters
[in]nStartIndexSpecifies the zero-based index of start element to insert at.
[in]pNewArrayThe input array.
Returns
true means success, while false means failure (such as parameter or memory error).

◆ RemoveAll()

void foxit.common.fxcrt.PointFArray.RemoveAll ( )
inline

Clean up the array.

Returns
None.

◆ RemoveAt()

bool foxit.common.fxcrt.PointFArray.RemoveAt ( int  nIndex,
int  nCount 
)
inline

Remove a number of elements at specified position.

Parameters
[in]nIndexSpecifies the zero-based index in the array.
[in]nCountSpecifies the count of element to remove.
Returns
true means success, while false means failure (such as parameter or memory error).

◆ SetAt()

bool foxit.common.fxcrt.PointFArray.SetAt ( int  nIndex,
PointF  newElement 
)
inline

This method overwrites an element specified by an index number.

Parameters
[in]nIndexSpecifies the zero-based index of the element.
[in]newElementAn element.
Returns
true means success, while false means failure.

◆ SetAtGrow()

bool foxit.common.fxcrt.PointFArray.SetAtGrow ( int  nIndex,
PointF  newElement 
)
inline

Set an element value at specified position. Potentially growing the array.

Parameters
[in]nIndexSpecifies the zero-based index of element in the array.
[in]newElementThe input element.
Returns
true means success, while false means failure.

◆ SetSize()

bool foxit.common.fxcrt.PointFArray.SetSize ( int  nNewSize,
int  nGrowBy 
)
inline

Change the allocated size and the grow amount.

Parameters
[in]nNewSizeThe new size in elements expected.
[in]nGrowByThe grow amount in elements expected. This can be -1 for the grow amount unchanged.
Returns
true means success, while false means failure (such as parameter or memory error).