Public Member Functions | |
Path () | |
Constructor. | |
Path (Path other) | |
Constructor, with another Path object. More... | |
boolean | appendEllipse (RectF rect) throws com.foxit.sdk.PDFException |
Add an ellipse figure to the end of current path. More... | |
boolean | appendRect (RectF rect) throws com.foxit.sdk.PDFException |
Add a rectangle figure to the end of current path. More... | |
void | clear () throws com.foxit.sdk.PDFException |
Clear all points. More... | |
boolean | closeFigure () throws com.foxit.sdk.PDFException |
Close current figure (which is also the last figure in current path). More... | |
boolean | cubicBezierTo (PointF point1, PointF point2, PointF point3) throws com.foxit.sdk.PDFException |
Add a cubic bezier spline to the end of current figure, by three points: two control points and one target point. More... | |
PointF | getPoint (int index) throws com.foxit.sdk.PDFException |
Get a point specified by index. More... | |
int | getPointCount () throws com.foxit.sdk.PDFException |
Get the count of points. More... | |
int | getPointType (int index) throws com.foxit.sdk.PDFException |
Get the type of a point specified by index. More... | |
boolean | isEmpty () |
Check whether current object is empty or not. More... | |
boolean | lineTo (PointF point) throws com.foxit.sdk.PDFException |
Add a point to the end of current figure, and a line is to be drawn from current point to the new point. More... | |
boolean | moveTo (PointF point) throws com.foxit.sdk.PDFException |
Add a point to the end of current path, to start a new figure. More... | |
boolean | removePoint (int index) throws com.foxit.sdk.PDFException |
Remove a point specified by index. More... | |
boolean | setPoint (int index, PointF point, int type) throws com.foxit.sdk.PDFException |
Change the value and type of a point specified by index. More... | |
void | transform (Matrix2D matrix) throws com.foxit.sdk.PDFException |
Transform all points in current path with a given matrix. More... | |
Static Public Attributes | |
static final int | e_TypeBezierTo = 4 |
Indicates that this point is a control point or ending point for a Bezier spline. | |
static final int | e_TypeBezierToCloseFigure = 5 |
Indicates that this point is the ending point for a Bezier spline, and this point will also be connected to the nearest e_TypeMoveTo point before this point, in order to close current figure. | |
static final int | e_TypeLineTo = 2 |
Indicates that a line is drawn from the previous point to this point. | |
static final int | e_TypeLineToCloseFigure = 3 |
Indicates that a line is drawn from the previous point to this point, and this point will also be connected to the nearest e_TypeMoveTo point before this point, in order to close current figure. | |
static final int | e_TypeMoveTo = 1 |
Indicates that the point is the first point of a figure. | |
This class represents a path which contains one or more figures.
com.foxit.sdk.common.Path.Path | ( | Path | other | ) |
boolean com.foxit.sdk.common.Path.appendEllipse | ( | RectF | rect | ) | throws com.foxit.sdk.PDFException |
Add an ellipse figure to the end of current path.
rect | The enclosing rectangle of an ellipse figure. |
boolean com.foxit.sdk.common.Path.appendRect | ( | RectF | rect | ) | throws com.foxit.sdk.PDFException |
Add a rectangle figure to the end of current path.
rect | A rectangle which specifies a rectangle figure. |
void com.foxit.sdk.common.Path.clear | ( | ) | throws com.foxit.sdk.PDFException |
Clear all points.
boolean com.foxit.sdk.common.Path.closeFigure | ( | ) | throws com.foxit.sdk.PDFException |
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 e_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 e_TypeLineTo, the type will be changed to {}. If the last point's type is e_TypeLineTo, the type will be changed to {}. If the last point's type is already e_TypeLineToCloseFigure or e_TypeBezierToCloseFigure, that means the last figure has been closed. The type will not be changed and function will still return true.
boolean com.foxit.sdk.common.Path.cubicBezierTo | ( | PointF | point1, |
PointF | point2, | ||
PointF | point3 | ||
) | throws com.foxit.sdk.PDFException |
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".
point1 | New point as the first control point for cubic bezier, in PDF coordinate system . |
point2 | New point as the second control point for cubic bezier, in PDF coordinate system . |
point3 | New point as target point for cubic bezier, in PDF coordinate system . |
PointF com.foxit.sdk.common.Path.getPoint | ( | int | index | ) | throws com.foxit.sdk.PDFException |
Get a point specified by index.
index | The index of the point. Valid range: 0 to (count-1). count is returned by function Path::getPointCount. |
int com.foxit.sdk.common.Path.getPointCount | ( | ) | throws com.foxit.sdk.PDFException |
Get the count of points.
int com.foxit.sdk.common.Path.getPointType | ( | int | index | ) | throws com.foxit.sdk.PDFException |
Get the type of a point specified by index.
index | The index of the point. Valid range: 0 to (count-1). count is returned by function Path::getPointCount. |
boolean com.foxit.sdk.common.Path.isEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
boolean com.foxit.sdk.common.Path.lineTo | ( | PointF | point | ) | throws com.foxit.sdk.PDFException |
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".
point | New point, in PDF coordinate system . |
boolean com.foxit.sdk.common.Path.moveTo | ( | PointF | point | ) | throws com.foxit.sdk.PDFException |
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".
point | New point, in PDF coordinate system . |
boolean com.foxit.sdk.common.Path.removePoint | ( | int | index | ) | throws com.foxit.sdk.PDFException |
Remove a point specified by index.
index | The index of the point to be removed. Valid range: 0 to (count-1). count is returned by function Path::getPointCount. |
boolean com.foxit.sdk.common.Path.setPoint | ( | int | index, |
PointF | point, | ||
int | type | ||
) | throws com.foxit.sdk.PDFException |
Change the value and type of a point specified by index.
index | The index of the point. Valid range: 0 to (count-1). count is returned by function Path::getPointCount. |
point | The new point to set, in PDF coordinate system . |
type | The type used to set to the new point. Please refer to values starting from e_TypeMoveTo and this should be one of these values. |
void com.foxit.sdk.common.Path.transform | ( | Matrix2D | matrix | ) | throws com.foxit.sdk.PDFException |
Transform all points in current path with a given matrix.
matrix | A matrix used for transforming. |