|
Foxit PDF SDK
|
Public Member Functions | |
| def | AppendEllipse (rect) |
| Add an ellipse figure to the end of current path. More... | |
| def | AppendRect (rect) |
| Add a rectangle figure to the end of current path. More... | |
| def | Clear () |
| Clear all points. More... | |
| def | CloseFigure () |
| Close current figure (which is also the last figure in current path). More... | |
| def | CubicBezierTo (point1, point2, point3) |
| Add a cubic bezier spline to the end of current figure, by three points: two control points and one target point. More... | |
| def | GetPoint (index) |
| Get a point specified by index. More... | |
| def | GetPointCount () |
| Get the count of points. More... | |
| def | GetPointType (index) |
| Get the type of a point specified by index. More... | |
| def | IncreasePointCount (count) |
| Increase the point count and prepare adequate memory for these new points. More... | |
| def | IsEmpty () |
| Check whether current object is empty or not. More... | |
| def | LineTo (point) |
| Add a point to the end of current figure, and a line is to be drawn from current point to the new point. More... | |
| def | MoveTo (point) |
| Add a point to the end of current path, to start a new figure. More... | |
| def | RemovePoint (index) |
| Remove a point specified by index. More... | |
| def | SetPoint (index, point, type) |
| Change the value and type of a point specified by index. More... | |
| def | Transform (matrix) |
| Transform all points in current path with a given matrix. More... | |
This class represents a path which contains one or more figures.
| def fsdk.Path.AppendEllipse | ( | rect | ) |
Add an ellipse figure to the end of current path.
| [in] | rect | The enclosing rectangle of an ellipse figure. |
| def fsdk.Path.AppendRect | ( | rect | ) |
Add a rectangle figure to the end of current path.
| [in] | rect | A rectangle which specifies a rectangle figure. |
| def fsdk.Path.Clear | ( | ) |
Clear all points.
| def fsdk.Path.CloseFigure | ( | ) |
Close current figure (which is also the last figure in current path).
When closing current figure, the last point's type may be changed:
If the last point's type is fsdk.PathE_TypeMoveTo , that means the last figure just has one point and cannot be closed and current function will return false.
If the last point's type is fsdk.PathE_TypeLineTo , the type will be changed to fsdk.PathE_TypeLineToCloseFigure .
If the last point's type is fsdk.PathE_TypeLineTo , the type will be changed to fsdk.PathE_TypeBezierToCloseFigure .
If the last point's type is already fsdk.PathE_TypeLineToCloseFigure or fsdk.PathE_TypeBezierToCloseFigure , that means the last figure has been closed. The type will not be changed and function will still return true.
| def fsdk.Path.CubicBezierTo | ( | point1, | |
| point2, | |||
| point3 | |||
| ) |
Add a cubic bezier spline to the end of current figure, by three points: two control points and one target point.
If this function succeeds, parameter point3 will become the new "current point".
| [in] | point1 | New point as the first control point for cubic bezier, in [PDF coordinate system] (). |
| [in] | point2 | New point as the second control point for cubic bezier, in [PDF coordinate system] (). |
| [in] | point3 | New point as target point for cubic bezier, in [PDF coordinate system] (). |
| def fsdk.Path.GetPoint | ( | index | ) |
Get a point specified by index.
| [in] | index | The index of the point. Valid range: 0 to (count-1). count is returned by function fsdk.Path.GetPointCount . |
| def fsdk.Path.GetPointCount | ( | ) |
Get the count of points.
| def fsdk.Path.GetPointType | ( | index | ) |
Get the type of a point specified by index.
| [in] | index | The index of the point. Valid range: 0 to (count-1). count is returned by function fsdk.Path.GetPointCount . |
| def fsdk.Path.IncreasePointCount | ( | count | ) |
Increase the point count and prepare adequate memory for these new points.
This function will allocate more memory for given point count and initialize these new points with point (0, 0) and type fsdk.PathE_TypeMoveTo by default. After calling this function successfully, user can use function fsdk.Path.SetPoint to set these new points.
| [in] | count | The new point count. It should not be negative. |
| def fsdk.Path.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
| def fsdk.Path.LineTo | ( | point | ) |
Add a point to the end of current figure, and a line is to be drawn from current point to the new point.
If this function succeeds, the new point will become the new "current point".
| [in] | point | New point, in [PDF coordinate system] (). |
| def fsdk.Path.MoveTo | ( | point | ) |
Add a point to the end of current path, to start a new figure.
If this function succeeds, the new point will become the new "current point", and the new figure will become the new "current figure".
| [in] | point | New point, in [PDF coordinate system] (). |
| def fsdk.Path.RemovePoint | ( | index | ) |
Remove a point specified by index.
| [in] | index | The index of the point to be removed. Valid range: 0 to (count-1). count is returned by function fsdk.Path.GetPointCount . |
| def fsdk.Path.SetPoint | ( | index, | |
| point, | |||
| type | |||
| ) |
Change the value and type of a point specified by index.
| [in] | index | The index of the point. Valid range: 0 to (count-1). count is returned by function fsdk.Path.GetPointCount . |
| [in] | point | The new point to set, in [PDF coordinate system] (). |
| [in] | type | The type used to set to the new point. Please refer to values starting from fsdk.PathE_TypeMoveTo and this should be one of these values. |
| def fsdk.Path.Transform | ( | matrix | ) |
Transform all points in current path with a given matrix.
| [in] | matrix | A matrix used for transforming. |