Foxit PDF SDK
fsdk.Ink类 参考

Public 成员函数

def EnableUseBezier (use_bezier)
 启用使用贝塞尔样条来为墨迹注释的外观生成墨迹路径。 更多...
 
def GetInkList ()
 获取墨迹列表数据。 更多...
 
def SetInkList (ink_list)
 设置墨迹列表数据。 更多...
 

详细描述

墨迹注释表示由一个或多个不相交路径组成的手绘"涂鸦"。
墨迹注释是一种标记注释,所以类Ink 派生自 类Markup ,提供获取/设置墨迹注释属性和 重置墨迹注释外观流的函数。
对于墨迹注释,需要墨迹列表属性。因此,在重置其外观流之前,请确保墨迹注释 具有有效的墨迹列表属性;否则墨迹注释无法重置外观流。

注解
对于新创建的墨迹注释,如果用户在设置必需的墨迹列表属性后直接调用函数 fsdk.Annot.ResetAppearanceStream (从Ink 的父类继承) 而不设置任何其他属性,将使用默认外观:
边框宽度 = 2.0,边框样式 = fsdk.BorderInfoE_Solid , 边框颜色 = 0xFFFF0000(红色),不透明度 = 1.0。
参见
Markup

成员函数说明

◆ EnableUseBezier()

def fsdk.Ink.EnableUseBezier (   use_bezier)

启用使用贝塞尔样条来为墨迹注释的外观生成墨迹路径。

如果未调用此函数,Foxit PDF SDK将默认使用贝塞尔样条生成墨迹路径。

参数
[in]use_bezier决定是否使用贝塞尔样条的布尔值: true表示使用贝塞尔样条生成墨迹路径, 而false表示使用直线连接相邻点来生成墨迹路径。
返回
无。

◆ GetInkList()

def fsdk.Ink.GetInkList ( )

获取墨迹列表数据。

墨迹列表属性对于墨迹注释是必需的,此属性对墨迹注释的外观有影响。 墨迹列表包含一个或多个描边路径。
在Foxit PDF SDK中,类fsdk.Path 用于表示墨迹列表数据, 但路径对象的点类型已经为墨迹列表特别简化。 只有fsdk.PathE_TypeMoveTo fsdk.PathE_TypeLineTo 类型 用于墨迹列表中的点:

诸如移动墨迹注释或为此注释设置新墨迹路径等操作将更新墨迹路径数据, 因此先前返回的路径对象将变为无效。在这种情况下, 用户应再次调用此函数以获得新的路径对象。

返回
墨迹列表数据。如果返回的路径对象的函数fsdk.Path.IsEmpty 的返回值为true,那意味着找不到墨迹列表数据。

◆ SetInkList()

def fsdk.Ink.SetInkList (   ink_list)

设置墨迹列表数据。

墨迹列表属性对于墨迹注释是必需的,此属性对墨迹注释的外观有影响。 墨迹列表包含一个或多个描边路径。
在Foxit PDF SDK中,类fsdk.Path 用于表示墨迹列表数据, 但路径对象的点类型已经为墨迹列表特别简化。 只有fsdk.PathE_TypeMoveTo fsdk.PathE_TypeLineTo 类型 用于墨迹列表中的点:

特别地,如果输入参数ink_list包含贝塞尔点(例如,由函数 fsdk.Path.CubicBezierTo 添加),控制点将被忽略,只有目标点将 用于墨迹列表数据。
强烈建议用户只传递具有点类型fsdk.PathE_TypeMoveTo fsdk.PathE_TypeLineTo 的有效路径对象。
如果用户希望效果显示在注释的外观中,请在此函数后调用函数 fsdk.Annot.ResetAppearanceStream

参数
[in]ink_list指定新列表数据的新路径对象。
返回
无。