Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::Path类 参考

## Public 成员函数
| AppendEllipse (rect)
| 将椭圆图形添加到当前路径的末尾。 更多...
| AppendRect (rect)
| 将矩形图形添加到当前路径的末尾。 更多...
| Clear ()
| 清除所有点。 更多...
| CloseFigure ()
| 闭合当前图形（也是当前路径中的最后一个图形）。 更多...
| constructor ()
| 构造函数。
| CubicBezierTo (point1, point2, point3)
| 通过三个点将三次贝塞尔样条添加到当前图形的末尾： 两个控制点和一个目标点。 更多...
| GetPoint (index)
| 获取由索引指定的点。 更多...
| GetPointCount ()
| 获取点的数量。 更多...
| GetPointType (index)
| 获取由索引指定的点的类型。 更多...
| IncreasePointCount (count)
| 增加点的数量并为这些新点准备足够的内存。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| LineTo (point)
| 将一个点添加到当前图形的末尾，并从当前点到新点绘制一条线。 更多...
| MoveTo (point)
| 将一个点添加到当前路径的末尾，以开始一个新图形。 更多...
| RemovePoint (index)
| 移除由索引指定的点。 更多...
| SetPoint (index, point, type)
| 更改由索引指定的点的值和类型。 更多...
| Transform (matrix)
| 使用给定的矩阵转换当前路径中的所有点。 更多...

## 静态 Public 属性
static | e_TypeBezierTo
| 表示此点是贝塞尔曲线的控制点或结束点。
static | e_TypeBezierToCloseFigure
| 表示此点是贝塞尔曲线的结束点， 并且此点还将连接到此点之前最近的 FSDK.Path.e_TypeMoveTo 点， 以便闭合当前图形。
static | e_TypeLineTo
| 表示从前一个点到此点绘制一条线。
static | e_TypeLineToCloseFigure
| 表示从前一个点到此点绘制一条线， 并且此点还将连接到此点之前最近的 FSDK.Path.e_TypeMoveTo 点， 以便闭合当前图形。
static | e_TypeMoveTo
| 路径中点类型的枚举。 更多...

## 详细描述

此类表示包含一个或多个图形的路径。

## 成员函数说明

## ◆ AppendEllipse()

FSDK::Path::AppendEllipse | ( | rect |  | ) |

将椭圆图形添加到当前路径的末尾。

参数

  [in] | rect | 椭圆图形的外接矩形。

返回
  true 表示成功，而 false 表示失败。

## ◆ AppendRect()

FSDK::Path::AppendRect | ( | rect |  | ) |

将矩形图形添加到当前路径的末尾。

参数

  [in] | rect | 指定矩形图形的矩形。

返回
  true 表示成功，而 false 表示失败。

## ◆ Clear()

FSDK::Path::Clear | ( |  | ) |

清除所有点。

返回
  无。

## ◆ CloseFigure()

FSDK::Path::CloseFigure | ( |  | ) |

闭合当前图形（也是当前路径中的最后一个图形）。

闭合当前图形时，最后一个点的类型可能会改变：

- 如果最后一个点的类型是 FSDK.Path.e_TypeMoveTo，这意味着最后一个图形只有 一个点，无法闭合，当前函数将返回 false。
- 如果最后一个点的类型是 FSDK.Path.e_TypeLineTo， 类型将更改为 FSDK.Path.e_TypeLineToCloseFigure。
- 如果最后一个点的类型是 FSDK.Path.e_TypeLineTo，类型将更改为 FSDK.Path.e_TypeBezierToCloseFigure。
- 如果最后一个点的类型已经是 FSDK.Path.e_TypeLineToCloseFigure 或 FSDK.Path.e_TypeBezierToCloseFigure，这意味着最后一个图形已经闭合。 类型不会更改，函数仍将返回 true。

返回
  true 表示成功，而 false 表示失败。

## ◆ CubicBezierTo()

FSDK::Path::CubicBezierTo | ( | point1 | ,
|  | point2 | ,
|  | point3 |
| ) |  |

通过三个点将三次贝塞尔样条添加到当前图形的末尾： 两个控制点和一个目标点。

如果此函数成功，参数 point3 将成为新的"当前点"。

参数

  [in] | point1 | 作为三次贝塞尔的第一个控制点的新点，位于 PDF 坐标系统 中。
  [in] | point2 | 作为三次贝塞尔的第二个控制点的新点，位于 PDF 坐标系统 中。
  [in] | point3 | 作为三次贝塞尔目标点的新点，位于 PDF 坐标系统 中。

返回
  true 表示成功，而 false 表示失败。

## ◆ GetPoint()

FSDK::Path::GetPoint | ( | index |  | ) |

获取由索引指定的点。

参数

  [in] | index | 点的索引。有效范围：0 到 (count-1)。 count 由函数 FSDK.Path.GetPointCount 返回。

返回
  指定的点。

## ◆ GetPointCount()

FSDK::Path::GetPointCount | ( |  | ) |

获取点的数量。

返回
  点的数量。

## ◆ GetPointType()

FSDK::Path::GetPointType | ( | index |  | ) |

获取由索引指定的点的类型。

参数

  [in] | index | 点的索引。有效范围：0 到 (count-1)。 count 由函数 FSDK.Path.GetPointCount 返回。

返回
  指定点的类型。请参考从 FSDK.Path.e_TypeMoveTo 开始的值， 这将是这些值之一。

## ◆ IncreasePointCount()

FSDK::Path::IncreasePointCount | ( | count |  | ) |

增加点的数量并为这些新点准备足够的内存。

此函数将为给定的点数分配更多内存，并默认使用 点 (0, 0) 和类型 FSDK.Path.e_TypeMoveTo 初始化这些新点。 成功调用此函数后，用户可以使用函数 FSDK.Path.SetPoint 来 设置这些新点。

参数

  [in] | count | 新的点数。它不应该为负数。

返回
  无。

## ◆ IsEmpty()

FSDK::Path::IsEmpty | ( |  | ) |

检查当前对象是否为空。

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

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

## ◆ LineTo()

FSDK::Path::LineTo | ( | point |  | ) |

将一个点添加到当前图形的末尾，并从当前点到新点绘制一条线。

如果此函数成功，新点将成为新的"当前点"。

参数

  [in] | point | 新点，位于 PDF 坐标系统 中。

返回
  true 表示成功，而 false 表示失败。

## ◆ MoveTo()

FSDK::Path::MoveTo | ( | point |  | ) |

将一个点添加到当前路径的末尾，以开始一个新图形。

如果此函数成功，新点将成为新的"当前点"，新图形将 成为新的"当前图形"。

参数

  [in] | point | 新点，位于 PDF 坐标系统 中。

返回
  true 表示成功，而 false 表示失败。

## ◆ RemovePoint()

FSDK::Path::RemovePoint | ( | index |  | ) |

移除由索引指定的点。

参数

  [in] | index | 要移除的点的索引。有效范围：0 到 (count-1)。 count 由函数 FSDK.Path.GetPointCount 返回。

返回
  true 表示成功，而 false 表示失败。

## ◆ SetPoint()

FSDK::Path::SetPoint | ( | index | ,
|  | point | ,
|  | type |
| ) |  |

更改由索引指定的点的值和类型。

参数

  [in] | index | 点的索引。有效范围：0 到 (count-1)。 count 由函数 FSDK.Path.GetPointCount 返回。
  [in] | point | 要设置的新点，位于 PDF 坐标系统 中。
  [in] | type | 用于设置到新点的类型。请参考从 FSDK.Path.e_TypeMoveTo 开始的值，这应该是这些值之一。

返回
  true 表示成功，而 false 表示失败。

## ◆ Transform()

FSDK::Path::Transform | ( | matrix |  | ) |

使用给定的矩阵转换当前路径中的所有点。

参数

  [in] | matrix | 用于转换的矩阵。

返回
  无。

## 类成员变量说明

## ◆ e_TypeMoveTo

FSDK::Path::e_TypeMoveTo
| static

路径中点类型的枚举。

此枚举的值应单独使用。

表示该点是图形的第一个点。