cFigure Class Reference¶

Constructor.

Referenced by addFigure(), addFigure(), cFigure(), dup(), dupTree(), findFigure(), findFigureRecursively(), cAbstractImageFigure::getAllowedPropertyKeys(), cAbstractLineFigure::getAllowedPropertyKeys(), cAbstractShapeFigure::getAllowedPropertyKeys(), cAbstractTextFigure::getAllowedPropertyKeys(), getFigure(), getFigure(), getFigureByPath(), getParentFigure(), insertAbove(), insertAfter(), insertBefore(), insertBelow(), isAbove(), isBelow(), lowerBelow(), operator=(), cPanelFigure::parse(), raiseAbove(), removeFigure(), removeFigure(), and removeFromParent().

Copy constructor. Child figures and the figure ID are not copied.

References cFigure().

Destructor

Assignment operator. It copies all data members except the object name, figure ID and child figures. (See cNamedObject::operator=() for details.)

References 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 cObject.

Reimplemented in cAbstractImageFigure, cAbstractLineFigure, cAbstractShapeFigure, cAbstractTextFigure, cArcFigure, cGroupFigure, cIconFigure, cImageFigure, cLabelFigure, cLineFigure, cOvalFigure, cPanelFigure, cPathFigure, cPieSliceFigure, cPixmapFigure, cPolygonFigure, cPolylineFigure, cRectangleFigure, cRingFigure, and cTextFigure.

References cFigure().

Calls v->visit(this) on each child figure. See cObject for more details.

Reimplemented from cObject.

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

Reimplemented from cObject.

Reimplemented in cAbstractLineFigure, cAbstractShapeFigure, cAbstractTextFigure, cArcFigure, cGroupFigure, cImageFigure, cLineFigure, cOvalFigure, cPanelFigure, cPathFigure, cPieSliceFigure, cPixmapFigure, cPolygonFigure, cPolylineFigure, cRectangleFigure, and cRingFigure.

Returns the unique ID of this figure object. This ID is mostly intended for internal use.

Returns the visibility flag of the figure.

Sets the visibility flag of the figure. Setting the visibility flag to false will cause the whole figure subtree to be omitted from rendering.

Returns the transform associated with this figure.

Sets the transform associated with this figure. The transform will affect the rendering of this figure and its whole figure subtree. The transform may also be modified with the various translate(), scale(), rotate(), skewx()/skewy() methods.

Referenced by resetTransform().

Convenience method: sets the transformation to identity transform.

References setTransform().

Returns the Z-index of the figure.

See also

getEffectiveZIndex()

Sets the Z-index of the figure. The Z-index affects the stacking order of figures via the effective Z-index. The effective Z-index is computed as the sum of the Z-indices of this figure and its ancestors'. A figure with a greater effective Z-index is always in front of an element with a lower effective Z-index. For figures with the same effective Z-index, their relative order in the preorder traversal of the figure hierarchy defines the stacking order. (A later figure is in front of the earlier ones.)

Returns the effective Z-index of the figure. The effective Z-index is computed as the sum of the Z-indices of this figure and its ancestors'. A figure with a greater effective Z-index is always in front of an element with a lower effective Z-index.

Returns the tooltip of the figure, or nullptr if it does not have one.

Sets the tooltip of the figure. Pass nullptr to clear the tooltip. If nullptr is set, the effective tooltip will be inherited from the associated object if there is one (see getAssociatedObject()), or from the parent figure. Empty tooltips will not be shown.

Returns the simulation object associated with this figure, or nullptr if it does not have one. The GUI may use this function to provide a shortcut access to the specified object, e.g. select the object in an inspector when the user clicks the figure.

Sets the simulation object associated with this figure. The user is responsible for ensuring that the pointer is valid (the corresponding object exists), and remains valid while it is associated with the figure.

Returns the space-separated list of the tags associated with the figure. Tags may be used in the GUI displaying a canvas for implementing layers or other kind of filtering.

Sets the list of tags associated with the figure. This method accepts a space-separated list of tags. (Tags themselves may not contain spaces; underscores are recommended instead where needed.)

Returns the parent figure of this figure, or nullptr if it has none.

References cFigure(), and cOwnedObject::getOwner().

Returns the canvas object to which this figure was added, or nullptr if there is no such canvas. Note that the runtime cost of this method is proportional to the depth of this figure in the figure tree.

Returns the number of child figures.

Returns the kth figure in the child list. The index must be in the range 0..getNumFigures()-1. An out-of-bounds index will cause a runtime error.

References cFigure().

Referenced by cCanvas::getFigure(), and cCanvas::getFigure().

Returns the first child figure with the given name, or nullptr if there is no such figure.

References cFigure().

Finds the first figure with the given name among the children of this figure, and returns its index. If there is no such figure, -1 is returned.

Finds the given figure among the children of this figure, and returns its index. If it is not found, -1 is returned.

References cFigure().

Returns true if this figure has child figures, and false otherwise.

Find the first figure with the given name in this figure's subtree, including the figure itself. Returns nullptr if no such figure is found.

References cFigure().

Referenced by cCanvas::findFigureRecursively().

Finds a figure in the subtree, given by its absolute or relative path. The path is a string of figure names separated by dots; the special module name ^ (caret) stands for the parent figure. If the path starts with a dot or caret, it is understood as relative to this figure, otherwise it is taken to mean an absolute path (i.e. relative to the root figure, see getRootFigure()). Returns nullptr if the figure was not found.

Examples:

• "." means this figure;
• ".icon" means the child figure name "icon";
• ".group.label" means the "label" child of the "group" child figure;
• "^.icon" or ".^.icon" means the "icon" sibling of this figure;
• "icon" means the "icon" child of the root figure

The above syntax is similar to the one used by cModule::getModuleByPath()

References cFigure().

Referenced by cCanvas::getFigureByPath().

Appends the given figure to the child list of this figure.

References cFigure().

Inserts the given figure into the child list of this figure at the given position. Note that relative order in the child list only affects stacking order if the respective figures have the same Z-index.

References cFigure().

Removes the given figure from the child list of this figure. An error is raised if the figure is not a child of this figure.

Prefer removeFromParent() to this method.

References cFigure().

Referenced by cCanvas::removeFigure(), and cCanvas::removeFigure().

Removes the kth figure from the child list of this figure. An error is raised if pos is not in the range 0..getNumFigures()-1.

Prefer removeFromParent() to this method.

References cFigure().

Removes this figure from the child list of its parent figure. It has no effect if the figure has no parent figure.

References cFigure().

Returns true if this figure is above the given reference figure in stacking order, based on their Z-index values and their relative order in the parent's child list, and false if not. The method throws an error if the two figures are not under the same parent.

References cFigure().

Returns true if this figure is below the given reference figure in stacking order, based on their Z-index values and their relative order in the parent's child list, and false if not. The method throws an error if the two figures are not under the same parent.

References cFigure().

Inserts this figure under the same parent as the reference figure, guaranteeing that it will appear above the reference figure in stacking order. In order to achieve the latter, the Z-index of the figure is set to the Z-index of the reference figure if it was smaller. In case of equal Z-indices, the figure is inserted right after the reference figure. If the Z-index of the figure is already greater than that of the reference figure, nothing should be assumed about the insertion position.

See also

insertAfter()

References cFigure().

Inserts this figure under the same parent as the reference figure, guaranteeing that it will appear below the reference figure in stacking order. In order to achieve the latter, the Z-index of the figure is set to the Z-index of the reference figure if it was greater. In case of equal Z-indices, the figure is inserted right before the reference figure. If the Z-index of the figure is already smaller than that of the reference figure, nothing should be assumed about the insertion position.

See also

insertBefore()

References cFigure().

Inserts this figure after the given reference figure in its parent's child list. BEWARE: Relative order in the child list only affects stacking order if the respective figures have the same Z-index.

References cFigure().

Inserts this figure in front of the given reference figure in its parent's child list. BEWARE: Relative order in the child list only affects stacking order if the respective figures have the same Z-index.

References cFigure().

If this figure is below the given reference figure in stacking order, move it directly above. This is achieved by updating its Z-index if needed, and moving it in the parent's child list. An error is raised if the two figures do not share the same parent.

References cFigure().

If this figure is above the given reference figure in stacking order, move it directly below. This is achieved by updating its Z-index if needed, and moving it in the parent's child list. An error is raised if the two figures do not share the same parent.

References cFigure().

Raise this figure above all other figures under the same parent. This is achieved by updating its Z-index if needed (setting it to be at least the maximum of the Z-indices of the other figures), and moving it in the parent's child list. It is an error if this figure has no parent.

Lower this figure below all other figures under the same parent. This is achieved by updating its Z-index if needed (setting it to be at most the minimum of the Z-indices of the other figures), and moving it in the parent's child list. It is an error if this figure has no parent.

Duplicate the figure subtree.

References 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 in cAbstractImageFigure, cAbstractLineFigure, cAbstractShapeFigure, cAbstractTextFigure, cArcFigure, cImageFigure, cLabelFigure, cLineFigure, cOvalFigure, cPanelFigure, cPathFigure, cPieSliceFigure, cPixmapFigure, cPolygonFigure, cPolylineFigure, cRectangleFigure, and cRingFigure.

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 in cAbstractImageFigure, cAbstractLineFigure, cAbstractShapeFigure, cAbstractTextFigure, cArcFigure, cImageFigure, cLabelFigure, cLineFigure, cOvalFigure, cPanelFigure, cPathFigure, cPieSliceFigure, cPixmapFigure, cPolygonFigure, cPolylineFigure, cRectangleFigure, and cRingFigure.

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

Implemented in cAbstractImageFigure, cAbstractTextFigure, cArcFigure, cGroupFigure, cLineFigure, cOvalFigure, cPanelFigure, cPathFigure, cPieSliceFigure, cPolygonFigure, cPolylineFigure, cRectangleFigure, and cRingFigure.

Change the position of this figure and the figures in its subtree by the given x and y deltas. The implementation of this method calls moveLocal() on this figure, then move() recursively on child figures.

Reimplemented in cPanelFigure.

This method is invoked by runtime GUIs on every display refresh, and can be overridden if the figure needs to be able to update its contents dynamically (self-refreshing figures.) The changes done inside this method should be restricted to this figure and its subfigure tree.

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.

Implemented in cArcFigure, cGroupFigure, cIconFigure, cImageFigure, cLabelFigure, cLineFigure, cOvalFigure, cPanelFigure, cPathFigure, cPieSliceFigure, cPixmapFigure, cPolygonFigure, cPolylineFigure, cRectangleFigure, cRingFigure, and cTextFigure.