Foxit PDF SDK
foxit::addon::pdf3d::PDF3DContext类 参考
类 foxit::addon::pdf3d::PDF3DContext 继承关系图:
foxit::Base

Public 成员函数

 PDF3DContext (const pdf::PDFDoc &doc)
 带PDF文档对象的构造函数。
 
 PDF3DContext (const PDF3DContext &other)
 带另一个3D上下文对象的构造函数。 更多...
 
 ~PDF3DContext ()
 析构函数。
 
PDF3DAnnot Add3DAnnot (const wchar_t *threeD_file_path, int page_index, foxit::RectF rectf, void *screen_canvas_parent, PDF3DLaunchSetting launch_setting, PDF3DAdvancedSetting advanced_setting)
 向PDF页面添加3D注释。 更多...
 
PDF3DAnnot Add3DAnnot (foxit::common::file::ReaderCallback *threeD_file_read, int page_index, foxit::RectF rectf, void *screen_canvas_parent, PDF3DLaunchSetting launch_setting, PDF3DAdvancedSetting advanced_setting)
 向PDF页面添加3D注释。 更多...
 
PDF3DAnnotInstanceArray GetPage3DAnnotArray (int page_index)
 根据页面索引获取3D注释实例对象数组。 更多...
 
void Invalidate ()
 刷新3D对象。 更多...
 
bool IsEmpty () const
 检查当前对象是否为空。 更多...
 
bool operator!= (const PDF3DContext &other) const
 不相等操作符。 更多...
 
PDF3DContextoperator= (const PDF3DContext &other)
 赋值操作符。 更多...
 
bool operator== (const PDF3DContext &other) const
 相等操作符。 更多...
 
- Public 成员函数 继承自 foxit::Base
FS_HANDLE Handle () const
 获取当前对象的句柄。 更多...
 

详细描述

此类表示3D PDF上下文。在使用此模块中的任何类或方法之前,请确保 Foxit PDF SDK已通过common::Library::Initialize函数使用包含"3D"模块的密钥 成功初始化。
目前,3D模块仅支持Windows。

参见
common::Library

构造及析构函数说明

◆ PDF3DContext()

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

带另一个3D上下文对象的构造函数。

参数
[in]other另一个3D上下文对象。

成员函数说明

◆ Add3DAnnot() [1/2]

PDF3DAnnot foxit::addon::pdf3d::PDF3DContext::Add3DAnnot ( const wchar_t *  threeD_file_path,
int  page_index,
foxit::RectF  rectf,
void *  screen_canvas_parent,
PDF3DLaunchSetting  launch_setting,
PDF3DAdvancedSetting  advanced_setting 
)

向PDF页面添加3D注释。

参数
[in]threeD_file_path3D文件的文件路径。目前支持u3d和prc格式。
[in]page_index要添加3D注释的页面索引。有效范围:从0到(page_count-1)。
[in]rectf[PDF坐标系统]中新3D注释的矩形区域。
[in]screen_canvas_parent屏幕画布的父窗口句柄。
[in]launch_setting3D启动设置。
[in]advanced_setting3D高级设置。
返回
添加的3D注释对象。

◆ Add3DAnnot() [2/2]

PDF3DAnnot foxit::addon::pdf3d::PDF3DContext::Add3DAnnot ( foxit::common::file::ReaderCallback threeD_file_read,
int  page_index,
foxit::RectF  rectf,
void *  screen_canvas_parent,
PDF3DLaunchSetting  launch_setting,
PDF3DAdvancedSetting  advanced_setting 
)

向PDF页面添加3D注释。

参数
[in]threeD_file_read3D文件的文件读取器回调。目前支持u3d和prc格式。 详情请参考 common::file::ReaderCallback
[in]page_index要添加3D注释的页面索引。有效范围:从0到(page_count-1)。
[in]rectf[PDF坐标系统]中新3D注释的矩形区域。
[in]screen_canvas_parent屏幕画布的父窗口句柄。
[in]launch_setting3D启动设置。
[in]advanced_setting3D高级设置。
返回
添加的3D注释对象。

◆ GetPage3DAnnotArray()

PDF3DAnnotInstanceArray foxit::addon::pdf3d::PDF3DContext::GetPage3DAnnotArray ( int  page_index)

根据页面索引获取3D注释实例对象数组。

参数
[in]page_index页面索引。有效范围:从0到(page_count-1)。 page_count由函数pdf::PDFDoc::GetPageCount返回。
返回
3D注释实例对象数组。

◆ Invalidate()

void foxit::addon::pdf3d::PDF3DContext::Invalidate ( )

刷新3D对象。

要动态显示3D效果,需要基于循环调用修改接口。

返回
无。

◆ IsEmpty()

bool foxit::addon::pdf3d::PDF3DContext::IsEmpty ( ) const

检查当前对象是否为空。

当当前对象为空时,意味着当前对象无用。

返回
true表示当前对象为空,false表示不为空。

◆ operator!=()

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

不相等操作符。

参数
[in]other另一个3D上下文对象。此函数将检查当前对象是否不等于此对象。
返回
true表示不相等,false表示相等。

◆ operator=()

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

赋值操作符。

参数
[in]other另一个3D上下文对象,其值将被赋给当前对象。
返回
当前对象自身的引用。

◆ operator==()

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

相等操作符。

参数
[in]other另一个3D上下文对象。此函数将检查当前对象是否等于此对象。
返回
true表示相等,false表示不相等。