cPolylineFigure 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 cAbstractLineFigure.

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 cAbstractLineFigure.

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

Reimplemented from cAbstractLineFigure.

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 cAbstractLineFigure.

Change the figure's position by the given x and y deltas. Child figures will not be affected.

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 points that define the polyline.

Sets the points that define the polyline.

Returns the number of points. Equivalent to getPoints().size().

Returns the ith point. The index must be in the 0..getNumPoints()-1 interval.

Sets the number of points that define the polyline. (Appends new points or drops trailing points as needed.)

Sets the ith point. The index must be in the 0..getNumPoints()-1 interval.

Appends a point.

Removes the ith point. The index must be in the 0..getNumPoints()-1 interval.

Inserts a point at position i, shifting up the point at and above index i. The index must be in the 0..getNumPoints()-1 interval.

Returns true if the figure is rendered as a smoothed curve, and false if as a sequence of connecting of straight line segments. See the class description for details on how the points define the curve in the smoothed case.

Sets the flag that determines whether connecting straight line segments or a single smooth curve should be drawn. See the class description for details on how the points define the curve in the smoothed case. The default value is false (no smoothing).

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.