Foxit PDF SDK
foxit.addon.pdf3d.PDF3DContext Class Reference
Inheritance diagram for foxit.addon.pdf3d.PDF3DContext:
foxit.common.Base

Public Member Functions

 PDF3DContext (PDFDoc doc)
 Constructor, with a PDF document object.
 
 PDF3DContext (PDF3DContext other)
 Constructor, with another 3d context object. More...
 
PDF3DAnnotInstanceArray GetPage3DAnnotArray (int page_index)
 Get 3d annot instance objects array by page index. More...
 
void Invalidate ()
 Refresh 3D Objects. More...
 
bool IsEmpty ()
 Check whether current object is empty or not. More...
 

Detailed Description

This class represents a 3D PDF context. Before using any class or methods in this module, please ensure Foxit PDF SDK has been initialized successfully by function common.Library.Initialize with a key including "3D" module.
Currently, 3D module only supports Windows.

See also
foxit.common.Library

Constructor & Destructor Documentation

◆ PDF3DContext()

foxit.addon.pdf3d.PDF3DContext.PDF3DContext ( PDF3DContext  other)
inline

Constructor, with another 3d context object.

Parameters
[in]otherAnother 3d context object.

Member Function Documentation

◆ GetPage3DAnnotArray()

PDF3DAnnotInstanceArray foxit.addon.pdf3d.PDF3DContext.GetPage3DAnnotArray ( int  page_index)
inline

Get 3d annot instance objects array by page index.

Parameters
[in]page_indexPage index. Valid range: from 0 to (page_count-1). page_count is returned by function pdf.PDFDoc.GetPageCount .
Returns
3d annot instance objects array.

◆ Invalidate()

void foxit.addon.pdf3d.PDF3DContext.Invalidate ( )
inline

Refresh 3D Objects.

To dynamically display 3D effects, it is necessary to modify the interface based on loop calls.

Returns
None.

◆ IsEmpty()

bool foxit.addon.pdf3d.PDF3DContext.IsEmpty ( )
inline

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.