Foxit PDF SDK
|
Instance Methods | |
(BOOL) | - appendEllipse: |
Add an ellipse figure to the end of current path. More... | |
(BOOL) | - appendRect: |
Add a rectangle figure to the end of current path. More... | |
(void) | - clear |
Clear all points. More... | |
(BOOL) | - closeFigure |
Close current figure (which is also the last figure in current path). More... | |
(BOOL) | - cubicBezierTo:point2:point3: |
Add a cubic bezier spline to the end of current figure, by three points: two control points and one target point. More... | |
(FSPointF *) | - getPoint: |
Get a point specified by index. More... | |
(int) | - getPointCount |
Get the count of points. More... | |
(FSPathPointType) | - getPointType: |
Get the type of a point specified by index. More... | |
(id) | - init |
Constructor. | |
(id) | - initWithOther: |
Constructor, with another path object. More... | |
(BOOL) | - isEmpty |
Check whether current object is empty or not. More... | |
(BOOL) | - lineTo: |
Add a point to the end of current figure, and a line is to be drawn from current point to the new point. More... | |
(BOOL) | - moveTo: |
Add a point to the end of current path, to start a new figure. More... | |
(BOOL) | - removePoint: |
Remove a point specified by index. More... | |
(BOOL) | - setPoint:point:type: |
Change the value and type of a point specified by index. More... | |
(void) | - transform: |
Transform all points in current path with a given matrix. More... | |
This class represents a path which contains one or more figures.
- (BOOL) appendEllipse: | (FSRectF*) | rect |
Add an ellipse figure to the end of current path.
[in] | rect | The enclosing rectangle of an ellipse figure. |
- (BOOL) appendRect: | (FSRectF*) | rect |
Add a rectangle figure to the end of current path.
[in] | rect | A rectangle which specifies a rectangle figure. |
- (void) clear |
Clear all points.
- (BOOL) 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:
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 . |
[in] | point2 | New point as the second control point for cubic bezier, in . |
[in] | point3 | New point as target point for cubic bezier, in . |
- (FSPointF *) getPoint: | (int) | 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 FSPath::getPointCount. |
- (int) getPointCount |
Get the count of points.
- (FSPathPointType) getPointType: | (int) | 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 FSPath::getPointCount. |
- (id) initWithOther: | (FSPath*) | other |
Constructor, with another path object.
[in] | other | Another path object. |
- (BOOL) isEmpty |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
- (BOOL) lineTo: | (FSPointF*) | 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 . |
- (BOOL) moveTo: | (FSPointF*) | 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 . |
- (BOOL) removePoint: | (int) | 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 FSPath::getPointCount. |
- (BOOL) setPoint: | (int) | index | |
point: | (FSPointF*) | point | |
type: | (FSPathPointType) | 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 FSPath::getPointCount. |
[in] | point | The new point to set, in . |
[in] | type | The type used to set to the new point. Please refer to values starting from FSPathTypeMoveTo and this should be one of these values. |
- (void) transform: | (FSMatrix2D*) | matrix |
Transform all points in current path with a given matrix.
[in] | matrix | A matrix used for transforming. |