cFigure Class Reference

EXPERIMENTAL CLASS, NOT PART OF THE OFFICIAL OMNeT++ API! ALL DETAILS ARE SUBJECT TO CHANGE. More...

#include <ccanvas.h>

Inheritance diagram for cFigure:

List of all members.

Public Member Functions
virtual void	forEachChild (cVisitor *v)
virtual std::string	info () const

---

Detailed Description

EXPERIMENTAL CLASS, NOT PART OF THE OFFICIAL OMNeT++ API! ALL DETAILS ARE SUBJECT TO CHANGE.

A figure in the canvas (see cCanvas).

Notes:

• figures can be hierarchical (resulting in a figure tree)
• coordinates are in canvas units (usually meters), not in pixels! conversion uses the "bgs" (background scale) display string tag
• child figures are relative to the point returned by getChildOrigin()
• a figure subtree can be hidden by calling setVisible(false)
• dup() makes shallow copy (doesn't copy child figures); see dupTree() as well
• figures are only data storage classes, rendering is done in the back-end (e.g. Tkenv) by separate renderer classes.

See also:

cCanvas

---

Member Function Documentation

virtual void cFigure::forEachChild

(

cVisitor *

v

)

[virtual]

Enables traversing the object tree, performing some operation on each object.

The operation is encapsulated in the particular subclass of cVisitor.

This method should be redefined in every subclass to call v->visit(obj) for every obj object contained.

Reimplemented from cObject.

virtual std::string cFigure::info

(

)

const [virtual]

Can be redefined to produce a one-line description of object.

The string appears in the graphical user interface (Tkenv) e.g. when the object is displayed in a listbox. The returned string should possibly be at most 80-100 characters long, and must not contain newline.

See also:

detailedInfo()

Reimplemented from cObject.

Reimplemented in cGroupFigure, cAbstractLineFigure, cLineFigure, cArcFigure, cPolylineFigure, cAbstractShapeFigure, cRectangleFigure, cOvalFigure, cPieSliceFigure, cPolygonFigure, cTextFigure, and cImageFigure.

---

The documentation for this class was generated from the following file:

• ccanvas.h