Foxit PDF SDK
FSDK::PSI类 参考

Public 成员函数

 AddPoint (point, type, pressure)
 添加一个点。 更多...
 
 constructor (bitmap, simulate)
 带有位图作为画布的构造函数。 更多...
 
 constructor (width, height, simulate)
 带有画布指定宽度和高度的构造函数。 更多...
 
 ConvertToPDFAnnot (page, annot_rect, rotate)
 将 PSI 对象转换为 PSInk 注释并将 PSInk 注释插入到 PDF 页面。 更多...
 
 GetBitmap ()
 获取画布位图。 更多...
 
 GetContentsRect ()
 获取内容矩形。 更多...
 
 IsEmpty ()
 检查当前对象是否为空。 更多...
 
 SetCallback (callback)
 为刷新设置回调对象。 更多...
 
 SetColor (color)
 设置墨迹颜色。 更多...
 
 SetDiameter (diameter)
 设置墨迹直径。 更多...
 
 SetOpacity (opacity)
 设置墨迹不透明度。 更多...
 

详细描述

PSI,"压感墨迹",专为手动签名而定义,通常与手写板一起使用或用于触摸屏。PSI 包含私有坐标,在其坐标中创建画布。 画布限制操作区域并生成 PSI 的外观。
PSI 独立于 PDF,甚至可以直接在设备屏幕上使用。如果用户想要将 PSI 对象保存到 PDF 文件, 请调用函数 。此函数将 PSI 数据转换为 PSInk 注释(作为福昕自定义注释类型)并将 PSInk 注释插入到 PDF 页面中的指定位置。 FSDK.PSInk

成员函数说明

◆ AddPoint()

FSDK::PSI::AddPoint ( point  ,
type  ,
pressure   
)

添加一个点。

参数
[in]point画布坐标系中的点。
[in]type点类型。应为以下值之一: FSDK.Path.e_TypeMoveTo, FSDK.Path.e_TypeLineTo, FSDK.Path.e_TypeLineToCloseFigure,
[in]pressure此点的压力值。有效范围: 从 0.0 到 1.0。
返回
无。

◆ constructor() [1/2]

FSDK::PSI::constructor ( bitmap  ,
simulate   
)

带有位图作为画布的构造函数。

参数
[in]bitmap用作画布的位图。应使用 FSDK.Bitmap.e_DIBArgb 格式创建。 用户应确保此位图保持有效,直到释放当前 PSI 对象。
[in]simulate用于决定是否打开 PSI 模拟:
true 表示打开模拟,false 表示关闭模拟。
启用模拟时,可以通过书写速度模拟手写笔画粗细。

◆ constructor() [2/2]

FSDK::PSI::constructor ( width  ,
height  ,
simulate   
)

带有画布指定宽度和高度的构造函数。

参数
[in]width设备坐标系中 PSI 画布的宽度。应大于 0。
[in]height设备坐标系中 PSI 画布的高度。应大于 0。
[in]simulate用于决定是否打开 PSI 模拟:
true 表示打开模拟,false 表示关闭模拟。
启用模拟时,可以通过书写速度模拟手写笔画粗细。

◆ ConvertToPDFAnnot()

FSDK::PSI::ConvertToPDFAnnot ( page  ,
annot_rect  ,
rotate   
)

将 PSI 对象转换为 PSInk 注释并将 PSInk 注释插入到 PDF 页面。

实际上,此函数将当前 PSI 的路径数据转换为 PSInk 注释, 忽略画布位图。
在调用此函数之前,用户应确保当前 PSI 对象包含有效路径 (其最后一个点的类型为 FSDK.Path.e_TypeLineToCloseFigure)。 否则,转换将失败,此函数将抛出异常 FSDK.e_ErrInvalidData

参数
[in]page有效的 PDF 页面对象,PSI 预期插入到该页面。
[in]annot_rect用于指定 PDF 页面中位置的矩形, 新 PSInk 注释将插入到该位置。 应在 PDF 坐标系 中有效。
[in]rotate旋转值。当前只能为 FSDK.e_Rotation0
返回
新的 PSInk 注释对象。
注解
用户无需在转换后调用函数 FSDK.Annot.ResetAppearanceStream(从 PSInk 的父类继承) 来重置 PSInk 注释的外观。

◆ GetBitmap()

FSDK::PSI::GetBitmap ( )

获取画布位图。

返回
画布位图。

◆ GetContentsRect()

FSDK::PSI::GetContentsRect ( )

获取内容矩形。

返回
设备坐标系中的内容矩形。 如果当前 PSI 对象不包含有效路径, 将返回所有值为 0 的 RectF 对象。

◆ IsEmpty()

FSDK::PSI::IsEmpty ( )

检查当前对象是否为空。

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

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

◆ SetCallback()

FSDK::PSI::SetCallback ( callback  )

为刷新设置回调对象。

参数
[in]callback由用户实现的回调对象 FSDK.PSICallback。 请确保回调对象保持有效,直到当前 PSI 对象的生命周期结束。
返回
无。

◆ SetColor()

FSDK::PSI::SetColor ( color  )

设置墨迹颜色。

应在向 PSI 对象添加第一个点之前设置。 如果未设置,将使用默认值 0x000000。

参数
[in]color墨迹颜色。格式: 0xRRGGBB。
返回
无。

◆ SetDiameter()

FSDK::PSI::SetDiameter ( diameter  )

设置墨迹直径。

应在向 PSI 对象添加第一个点之前设置。 如果未设置,将使用默认值 10。

参数
[in]diameter墨迹直径。应大于 1。
返回
无。

◆ SetOpacity()

FSDK::PSI::SetOpacity ( opacity  )

设置墨迹不透明度。

应在向 PSI 对象添加第一个点之前设置。 如果未设置,将使用默认值 1.0。

参数
[in]opacity墨迹不透明度。有效范围: 从 0.0 到 1.0。 0.0 表示完全透明,1.0 表示完全不透明。
返回
无。