cAbstractTextFigure 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 cFigure.

Reimplemented in cLabelFigure.

References cFigure::cFigure().

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

Reimplemented in cLabelFigure, and cTextFigure.

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

Reimplemented from cFigure.

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

Reimplemented in cLabelFigure.

Updates the position of the text, see getPosition().

Implements cFigure.

Returns the position of the text. The position and the anchoring mode jointly determine the placement of the text item; see the class description for details.

Sets the position of the text. The position and the anchoring mode jointly determine the placement of the text item; see the class description for details.

Returns the anchoring mode of the text. The position and the anchoring mode jointly determine the placement of the text item; see the class description for details.

Sets the anchoring mode of the text. The position and the anchoring mode jointly determine the placement of the text item; see the class description for details.

Returns the alignment mode of the text. This only has an effect on figures with multi-line text. Each line will be aligned within the figure bounding box according to this option. This does not affect the anchor points on the baseline; see the class description for details.

Sets the alignment mode of the text. This only has an effect on figures with multi-line text. Each line will be aligned within the figure bounding box according to this option. This does not affect the anchor points on the baseline; see the class description for details.

Returns the bounding box of the text figure.

Caveat: Note that the figure itself only has a position and an anchor available for computing the bounding box, size (and for some cases ascent height) need to be supplied by the user interface of the simulation (cEnvir). The result depends on the details of font rendering and other factors, so the returned numbers and their accuracy may vary across user interfaces, operating systems or even installations. Cmdenv and other non-GUI environments may return completely made-up (but not entirely unrealistic) numbers.

See also

cEnvir::getTextExtent()

getTextExtent()

getFontAscent()

Reimplemented in cLabelFigure.

Returns the size of the text figure, not taking into account the anchor point, the position, or (in case of cLabelFigure) the angle.

Caveat: The result depends on the details of font rendering and other factors, so the returned numbers and their accuracy may vary across user interfaces, operating systems or even installations. Cmdenv and other non-GUI environments may return completely made-up (but not entirely unrealistic) numbers.

See also

cEnvir::getTextExtent()

getBounds()

getFontAscent()

Returns the ascent of the font set on the text figure.

Caveat: The result depends on the details of font rendering and other factors, so the returned number and its accuracy may vary across user interfaces, operating systems or even installations. Cmdenv and other non-GUI environments may return a completely made-up (but not entirely unrealistic) number.

See also

cEnvir::getTextExtent()

getBounds()

getTextExtent()

Returns the text color.

Sets the text color. The default color is black.

Returns the opacity of the figure, a number in the [0,1] interval.

Sets the line opacity of the figure. The argument must be a number in the [0,1] interval. The default opacity is 1.0.

Returns true if a "halo" is displayed around the text.

Sets the flag that controls whether a partially transparent "halo" should be displayed around the text. The halo improves the readability of the text when it is displayed over a background that has similar color as the text, or when it overlaps with other text items. The default setting is false (no halo).

Note: In Qtenv, halo may be slow to render for text figures (cTextFigure) under some circumstances. There is no such penalty for label figures (cLabelFigure).

Returns the font used for the figure.

Sets the font to be used for the figure. The default font has no specific typeface or size set, allowing the UI to use its preferred font.

Returns the text to be displayed.

Sets the text to be displayed. The text may contain newline and tab characters ("\n", "\t") for formatting.