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

Public Member Functions

 PDF3DContext (const pdf::PDFDoc &doc)
 Constructor, with a PDF document object.
 
 PDF3DContext (const PDF3DContext &other)
 Constructor, with another 3d context object. More...
 
 ~PDF3DContext ()
 Destructor.
 
PDF3DAnnotInstanceArray GetPage3DAnnotArray (int page_index)
 Get 3d annot instance objects array by page index. More...
 
void Invalidate ()
 Refresh 3D Objects. More...
 
bool IsEmpty () const
 Check whether current object is empty or not. More...
 
bool operator!= (const PDF3DContext &other) const
 Not equal operator. More...
 
PDF3DContextoperator= (const PDF3DContext &other)
 Assign operator. More...
 
bool operator== (const PDF3DContext &other) const
 Equal operator. More...
 
- Public Member Functions inherited from foxit::Base
FS_HANDLE Handle () const
 Get the handle of current object. 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
common::Library

Constructor & Destructor Documentation

◆ PDF3DContext()

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

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)

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 ( )

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 ( ) const

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.

◆ operator!=()

bool foxit::addon::pdf3d::PDF3DContext::operator!= ( const PDF3DContext other) const

Not equal operator.

Parameters
[in]otherAnother 3d context object. This function will check if current object is not equal to this one.
Returns
true means not equal, while false means equal.

◆ operator=()

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

Assign operator.

Parameters
[in]otherAnother 3d context object, whose value would be assigned to current object.
Returns
Reference to current object itself.

◆ operator==()

bool foxit::addon::pdf3d::PDF3DContext::operator== ( const PDF3DContext other) const

Equal operator.

Parameters
[in]otherAnother 3d context object. This function will check if current object is equal to this one.
Returns
true means equal, while false means not equal.