fsdk.PSI类 参考

Public 成员函数
def	AddPoint (point, type, pressure)
	添加一个点。 更多...
def	ConvertToPDFAnnot (page, annot_rect, rotate)
	将PSI对象转换为PSInk注释并将PSInk注释插入到PDF页面中。 更多...
def	GetBitmap ()
	获取画布位图。 更多...
def	GetContentsRect ()
	获取内容矩形。 更多...
def	IsEmpty ()
	检查当前对象是否为空。 更多...
def	SetCallback (callback)
	设置用于刷新的回调对象。 更多...
def	SetColor (color)
	设置墨水颜色。 更多...
def	SetDiameter (diameter)
	设置墨水直径。 更多...
def	SetOpacity (opacity)
	设置墨水不透明度。 更多...

详细描述

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

参见

fsdk.PSInk

成员函数说明

AddPoint()

def fsdk.PSI.AddPoint	(		point,
			type,
			pressure
	)

添加一个点。

参数

[in]	point	画布坐标系中的一个点。
[in]	type	点类型。应为以下值之一： fsdk.PathE_TypeMoveTo 、fsdk.PathE_TypeLineTo 、 fsdk.PathE_TypeLineToCloseFigure 。
[in]	pressure	此点的压力值。有效范围：从0.0到1.0。

返回

无。

ConvertToPDFAnnot()

def fsdk.PSI.ConvertToPDFAnnot	(		page,
			annot_rect,
			rotate
	)

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

实际上，此函数是将当前PSI的路径数据转换为PSInk注释， 忽略画布位图。
调用此函数之前，用户应确保当前PSI对象包含有效路径 （其最后一个点的类型为 fsdk.PathE_TypeLineToCloseFigure ）。 否则，转换将失败，此函数将抛出异常 fsdk.E_ErrInvalidData 。

参数

[in]	page	有效的PDF页面对象，预期将PSI插入其中。
[in]	annot_rect	指定PDF页面中位置的矩形， 新的PSInk注释将插入其中。 在中应有效。
[in]	rotate	旋转值。目前只能是 fsdk.E_Rotation0 。

返回

新的PSInk注释对象。

注解

用户在此转换后不需要调用函数 fsdk.Annot.ResetAppearanceStream （从 PSInk的父类继承）来重置PSInk注释的外观。

GetBitmap()

def fsdk.PSI.GetBitmap

(

)

获取画布位图。

返回

画布位图。

GetContentsRect()

def fsdk.PSI.GetContentsRect

(

)

获取内容矩形。

返回

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

IsEmpty()

def fsdk.PSI.IsEmpty

(

)

检查当前对象是否为空。

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

返回

true 表示当前对象为空，false 表示不为空。

SetCallback()

def fsdk.PSI.SetCallback

(

callback

)

设置用于刷新的回调对象。

参数

[in]

callback

由用户实现的回调对象 PSICallback 。 请确保回调对象在 当前PSI对象的生命周期结束前保持有效。

返回

无。

SetColor()

def fsdk.PSI.SetColor

(

color

)

设置墨水颜色。

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

参数

[in]

color

墨水颜色。格式：0xRRGGBB。

返回

无。

SetDiameter()

def fsdk.PSI.SetDiameter

(

diameter

)

设置墨水直径。

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

参数

[in]

diameter

墨水直径。应大于1。

返回

无。

SetOpacity()

def fsdk.PSI.SetOpacity

(

opacity

)

设置墨水不透明度。

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

参数

[in]

opacity

墨水不透明度。有效范围：从0.0到1.0。 0.0表示完全透明，1.0表示完全不透明。

返回

无。