Foxit PDF SDK
foxit::addon::pdf3d::PDF3DAnnot类 参考

此类代表3D注释。 更多...

类 foxit::addon::pdf3d::PDF3DAnnot 继承关系图:
foxit::Base

Public 类型

enum  PDF3DType { e_3DTypeArtwork = 0, e_3DTypeRichMedia = 1 }
 3D注释类型的枚举。 更多...
 

Public 成员函数

 PDF3DAnnot (const PDF3DAnnot &other)
 带另一个3D注释对象的构造函数。 更多...
 
 ~PDF3DAnnot ()
 析构函数。
 
PDF3DType Get3DAnnotType ()
 获取3D注释的类型。 更多...
 
PDF3DAnnotInstance Get3DArtworkInstance ()
 获取3D Artwork的实例。 更多...
 
pdf::annots::Annot GetAnnot ()
 获取关联的注释对象。 更多...
 
int GetAnnotIndex ()
 获取3D 注释的索引。 更多...
 
PDF3DAnnotInstanceArray GetRichMediaInstances ()
 获取3D 多媒体类型的实例数组。 更多...
 
bool IsEmpty () const
 检查当前对象是否为空。 更多...
 
bool operator!= (const PDF3DAnnot &other) const
 不相等操作符。 更多...
 
PDF3DAnnotoperator= (const PDF3DAnnot &other)
 赋值操作符。 更多...
 
bool operator== (const PDF3DAnnot &other) const
 相等操作符。 更多...
 
- Public 成员函数 继承自 foxit::Base
FS_HANDLE Handle () const
 获取当前对象的句柄。 更多...
 

详细描述

此类代表3D注释。

成员枚举类型说明

◆ PDF3DType

3D注释类型的枚举。

此枚举的值应该单独使用。

枚举值
e_3DTypeArtwork 

3D类型:Artwork。

e_3DTypeRichMedia 

3D类型:多媒体。

构造及析构函数说明

◆ PDF3DAnnot()

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

带另一个3D注释对象的构造函数。

参数
[in]other另一个3D注释对象。

成员函数说明

◆ Get3DAnnotType()

PDF3DType foxit::addon::pdf3d::PDF3DAnnot::Get3DAnnotType ( )

获取3D注释的类型。

返回
3D注释的类型。请参考从 PDF3DAnnot::e_3DTypeArtwork,返回值将是这些值中的一个。

◆ Get3DArtworkInstance()

PDF3DAnnotInstance foxit::addon::pdf3d::PDF3DAnnot::Get3DArtworkInstance ( )

获取3D Artwork的实例。

如果3D注释不是 PDF3DAnnot::e_3DTypeArtwork 类型,将返回空对象。

返回
一个3D实例对象。

◆ GetAnnot()

pdf::annots::Annot foxit::addon::pdf3d::PDF3DAnnot::GetAnnot ( )

获取关联的注释对象。

返回
关联的注释对象。

◆ GetAnnotIndex()

int foxit::addon::pdf3d::PDF3DAnnot::GetAnnotIndex ( )

获取3D 注释的索引。

返回
3D 注释的索引。

◆ GetRichMediaInstances()

PDF3DAnnotInstanceArray foxit::addon::pdf3d::PDF3DAnnot::GetRichMediaInstances ( )

获取3D 多媒体类型的实例数组。

如果3D注释不是 PDF3DAnnot::e_3DTypeRichMedia 类型,将返回空对象。

返回
一个3D实例对象数组。

◆ IsEmpty()

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

检查当前对象是否为空。

当当前对象为空时,表示当前对象无用。

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

◆ operator!=()

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

不相等操作符。

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

◆ operator=()

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

赋值操作符。

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

◆ operator==()

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

相等操作符。

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