cPathFigure Class Reference¶

Returns the list of allowed keys in @figure properties with this figure type, in a nullptr-terminated array of const char* elements. This method is invoked e.g. from parse(), in order to be able to issue error messages for invalid keys in the property. Note that property keys starting with "x-" are already allowed by default. Custom figure classes usually need to override this method together with parse(); see the source code of the library classes for example implementations.

Reimplemented from cAbstractShapeFigure.

Clones the figure, ignoring its child figures. (The copy will have no children.) To clone a figure together with its figure subtree, use dupTree().

Reimplemented from cAbstractShapeFigure.

Returns a one-line string with the most characteristic data of the figure.

Reimplemented from cAbstractShapeFigure.

This method is invoked by the simulation library to initialize the figure from a @figure NED property. Custom figure classes usually need to override this method (and call the super class' similar method in it).

Note: When overriding parse(), it is usually also necessary to override getAllowedPropertyKeys(), in order to allow new keys in the @figure property.

Reimplemented from cAbstractShapeFigure.

The move operation modifies the offset field (see getOffset()).

Implements cFigure.

Returns the name of the class responsible for rendering this figure. Renderer classes are specific to, and are usually implemented as part of, the graphical user interface library e.g. Qtenv.

Implements cFigure.

Returns the join style line segments will be connected with.

Sets the join style line segments will be connected with. The default join style is miter.

Returns the cap style for the figure's line.

Sets the cap style for the figure's line. The default cap style is butt.

Returns the fill rule of the path. This attribute is only important with closed, filled, self-intersecting paths (and those that contain such parts). The interpretation of the fill rule is consistent with its SVG definition.

Sets the fill rule of the path. This attribute is only important with closed, filled, self-intersecting paths (and those that contain such parts). The interpretation of the fill rule is consistent with its SVG definition.

The default fill rule is evenodd.

Returns the coordinate offset of the path. A nonzero offset causes the path to appear translated by the given amount in the local coordinate system.

Sets the coordinate offset of the path. Setting a nonzero offset causes the path to appear translated by the given amount in the local coordinate system. The elements of the path remain unchanged. This method primarily exists so that moveLocal() can be a constant-time operation.

Returns the path as a string.

Sets the path from a string. It will be parsed, made available via the getNumPathItems(), getPathItem() methods, and may be further modified with the "add" methods.

Returns the number of path items.

Returns the kth path item. The returned item may be cast to the appropriate subtype (MoveTo, MoveRel, etc.) after examining its code field.

Clears the path by discarding its path items.

Appends a MoveTo item to the path. It will move the "pen" to (x,y), and begin a new subpath. Paths should begin with a MoveTo.

SVG equivalent: "M <x> <y>"

Appends a MoveRel item to the path. It will move the "pen" from the current point (lastx,lasty) to (lastx+dx,lasty+dy), and begin a new subpath.

SVG equivalent: "m <dx> <dy>"

Appends a LineTo item to the path. It will draw a line from the last point to (x,y).

SVG equivalent: "L <x> <y>"

Appends a LineRel item to the path. It will draw a line from the current point (lastx, lasty) to (lastx+dx, lasty+dy).

SVG equivalent: "l <dx> <dy>"

Appends a HorizontalLineTo item to the path. It will draw a line from the current point (lastx, lasty) to (x, lasty).

SVG equivalent: "H <x>"

Appends a HorizontalLineRel item to the path. It will draw a line from the current point (lastx, lasty) to (lastx+dx, lasty).

SVG equivalent: "h <dx>"

Appends a VerticalLineTo item to the path. It will draw a line from the current point (lastx, lasty) to the (lastx, y) point.

SVG equivalent: "V <y>"

Appends a VerticalLineRel item to the path. It will draw a line from the current point (lastx, lasty) to (lastx, lasty+dy).

SVG equivalent: "v <dy>"

Appends an ArcTo item to the path. It will draw an arc from the last point to the (x,y) point. The size and orientation of the ellipse are defined by two radii (rx, ry) and a phi rotation angle. The center of the ellipse is calculated automatically to satisfy the constraints imposed by the other parameters. The largeArc and sweep flags determine which of the four possible arcs are chosen. If largeArc=true, then one of the larger (greater than 180 degrees) arcs are chosen, otherwise one of the the smaller ones. If sweep=true, the arc will be drawn in the "positive-angle" direction, otherwise in the negative-angle direction.

SVG equivalent: "A <rx> <ry> <phi> <largeArc> <sweep> <x> <y>"

Appends an ArcRel item to the path. It will draw an arc from the last point (lastx, lasty) to (lastx+dx, lasty+dy). Just as with addArcTo(), the size and orientation of the ellipse are defined by two radii (rx, ry) and a phi rotation angle. The center of the ellipse is calculated automatically to satisfy the constraints imposed by the other parameters. The largeArc and sweep flags determine which of the four possible arcs are chosen. If largeArc=true, then one of the larger (greater than 180 degrees) arcs are chosen, otherwise one of the the smaller ones. If sweep=true, the arc will be drawn in the "positive-angle" direction, otherwise in the negative-angle direction.

SVG equivalent: "a <rx> <ry> <phi> <largeArc> <sweep> <dx> <dy>"

Appends a CurveTo item to the path. It will draw a quadratic Bezier curve from the current point to (x,y) using (x1,y1) as the control point.

SVG equivalent: "Q <x1> <y1> <x> <y>"

Appends a CurveRel item to the path. It will draw a quadratic Bezier curve from the current point (lastx, lasty) to (lastx+dx, lasty+dy) using (lastx+dx1, lasty+dy1) as the control point.

SVG equivalent: "q <dx1> <dy1> <dx> <dy>"

Appends a SmoothCurveTo item to the path. It will draw a quadratic Bezier curve from the current point to (x,y). The control point is assumed to be the reflection of the control point on the previous command relative to the current point. (If there is no previous command or if the previous command was not a quadratic Bezier curve command such as Q, q, T or t, assume the control point is coincident with the current point.)

SVG equivalent: "T <x> <y>"

Appends a SmoothCurveRel item to the path. It will draw a quadratic Bezier curve from the current point (lastx, lasty) to (last+dx, lasty+dy). The control point is assumed to be the reflection of the control point on the previous command relative to the current point. (If there is no previous command or if the previous command was not a quadratic Bezier curve command such as Q, q, T or t, assume the control point is coincident with the current point.)

SVG equivalent: "t <dx> <dy>"

Appends a CubicBezierCurveTo item to the path. It will draw a cubic Bezier curve from the current point to (x,y) using (x1,y1) as the control point at the beginning of the curve and (x2,y2) as the control point at the end of the curve.

SVG equivalent: "C <x1> <y1> <x2> <y2> <x> <y>"

Appends a CubicBezierCurveRel item to the path. It will draw a cubic Bezier curve from the current point (lastx, lasty) to (lastx+dx, lasty+dy) using (lastx+dx1, lasty+dy1) as the control point at the beginning of the curve and (lastx+dx2, lasty+dy2) as the control point at the end of the curve.

SVG equivalent: "c <dx1> <dy1> <dx2> <dy2> <dx> <dy>"

Appends a SmoothCubicBezierCurveTo item to the path. It will draw a cubic Bezier curve from the current point to (x,y). The first control point is assumed to be the reflection of the second control point on the previous command relative to the last point. (If there is no previous command or if the previous command was not a cubic Bezier command such as C, c, S or s, assume the first control point is coincident with the current point.) (x2,y2) is the second control point (i.e., the control point at the end of the curve).

SVG equivalent: "S <x2> <y2> <x> <y>"

Appends a SmoothCubicBezierCurveRel item to the path. It will draw a cubic Bezier curve from the current point (lastx, lasty) to (lastx+dx, lasty+dy). The first control point is assumed to be the reflection of the second control point on the previous command relative to the last point. (If there is no previous command or if the previous command was not a cubic Bezier command such as C, c, S or s, assume the first control point is coincident with the current point.) (lastx+dx2, lasty+dy2) is the second control point (i.e., the control point at the end of the curve).

SVG equivalent: "s <dx2> <dy2> <dx> <dy>"

Appends a ClosePath item to the path. It will close the current subpath by drawing a straight line from the current point to current subpath's initial point.

SVG equivalent: "Z" or "z"