cAbstractLineFigure Class Reference¶
|
API
|
Public Member Functions | |
Constructors, destructor, assignment. | |
Redefined cObject and cFigure member functions. | |
| virtual cAbstractLineFigure * | dup () const override |
| virtual std::string | str () const override |
| virtual void | parse (cProperty *property) override |
Figure attributes | |
| virtual const Color & | getLineColor () const |
| virtual void | setLineColor (const Color &lineColor) |
| virtual double | getLineWidth () const |
| virtual void | setLineWidth (double lineWidth) |
| virtual double | getLineOpacity () const |
| virtual void | setLineOpacity (double lineOpacity) |
| virtual LineStyle | getLineStyle () const |
| virtual void | setLineStyle (LineStyle lineStyle) |
| virtual CapStyle | getCapStyle () const |
| virtual void | setCapStyle (CapStyle capStyle) |
| virtual Arrowhead | getStartArrowhead () const |
| virtual void | setStartArrowhead (Arrowhead startArrowhead) |
| virtual Arrowhead | getEndArrowhead () const |
| virtual void | setEndArrowhead (Arrowhead endArrowhead) |
| virtual bool | getZoomLineWidth () const |
| virtual void | setZoomLineWidth (bool zoomLineWidth) |
| Public Member Functions inherited from cFigure | |
| cFigure (const char *name=nullptr) | |
| cFigure (const cFigure &other) | |
| virtual | ~cFigure () |
| cFigure & | operator= (const cFigure &other) |
| virtual void | forEachChild (cVisitor *v) override |
| int | getId () const |
| virtual bool | isVisible () const |
| virtual void | setVisible (bool visible) |
| virtual const Transform & | getTransform () const |
| virtual void | setTransform (const Transform &transform) |
| virtual void | resetTransform () |
| virtual double | getZIndex () const |
| virtual void | setZIndex (double zIndex) |
| virtual double | getEffectiveZIndex () const |
| virtual const char * | getTooltip () const |
| virtual void | setTooltip (const char *tooltip) |
| virtual cObject * | getAssociatedObject () const |
| virtual void | setAssociatedObject (cObject *obj) |
| virtual const char * | getTags () const |
| virtual void | setTags (const char *tags) |
| virtual cFigure * | getParentFigure () const |
| virtual cCanvas * | getCanvas () const |
| virtual int | getNumFigures () const |
| virtual cFigure * | getFigure (int pos) const |
| virtual cFigure * | getFigure (const char *name) const |
| virtual int | findFigure (const char *name) const |
| virtual int | findFigure (const cFigure *figure) const |
| virtual bool | containsFigures () const |
| virtual cFigure * | findFigureRecursively (const char *name) const |
| virtual cFigure * | getFigureByPath (const char *path) const |
| virtual void | addFigure (cFigure *figure) |
| virtual void | addFigure (cFigure *figure, int pos) |
| virtual cFigure * | removeFigure (cFigure *figure) |
| virtual cFigure * | removeFigure (int pos) |
| virtual cFigure * | removeFromParent () |
| virtual bool | isAbove (const cFigure *figure) const |
| virtual bool | isBelow (const cFigure *figure) const |
| virtual void | insertAbove (cFigure *referenceFigure) |
| virtual void | insertBelow (cFigure *referenceFigure) |
| virtual void | insertAfter (const cFigure *referenceFigure) |
| virtual void | insertBefore (const cFigure *referenceFigure) |
| virtual void | raiseAbove (cFigure *figure) |
| virtual void | lowerBelow (cFigure *figure) |
| virtual void | raiseToTop () |
| virtual void | lowerToBottom () |
| virtual cFigure * | dupTree () const |
| virtual void | moveLocal (double dx, double dy)=0 |
| virtual void | move (double dx, double dy) |
| virtual void | refreshDisplay () |
| virtual const char * | getRendererClassName () const =0 |
| Public Member Functions inherited from cOwnedObject | |
| cOwnedObject () | |
| cOwnedObject (const char *name, bool namepooling=true) | |
| cOwnedObject (const cOwnedObject &obj) | |
| virtual | ~cOwnedObject () |
| cOwnedObject & | operator= (const cOwnedObject &o) |
| virtual void | parsimPack (cCommBuffer *buffer) const override |
| virtual void | parsimUnpack (cCommBuffer *buffer) override |
| virtual cObject * | getOwner () const override |
| virtual bool | isOwnedObject () const override |
| Public Member Functions inherited from cNamedObject | |
| cNamedObject () | |
| cNamedObject (const char *name, bool namepooling=true) | |
| cNamedObject (const cNamedObject &obj) | |
| virtual | ~cNamedObject () |
| cNamedObject & | operator= (const cNamedObject &o) |
| virtual void | setName (const char *s) |
| virtual const char * | getName () const override |
| virtual void | setNamePooling (bool b) |
| virtual bool | getNamePooling () |
| Public Member Functions inherited from cObject | |
| cObject () | |
| cObject (const cObject &other)=default | |
| virtual | ~cObject () |
| virtual const char * | getClassName () const |
| bool | isName (const char *s) const |
| virtual const char * | getFullName () const |
| virtual std::string | getFullPath () const |
| virtual std::string | getClassAndFullName () const |
| virtual std::string | getClassAndFullPath () const |
| const cObject * | getThisPtr () const |
| virtual std::ostream & | printOn (std::ostream &os) const |
| virtual bool | isSoftOwner () const |
| cObject * | findObject (const char *name, bool deep=true) |
| virtual cClassDescriptor * | getDescriptor () const |
| void | copyNotSupported () const |
Protected Member Functions | |
| virtual const char ** | getAllowedPropertyKeys () const override |
| Protected Member Functions inherited from cObject | |
| virtual void | take (cOwnedObject *obj) |
| virtual void | drop (cOwnedObject *obj) |
| void | dropAndDelete (cOwnedObject *obj) |
Additional Inherited Members | |
| enum | FontStyle |
| Font style constants: FONT_NONE, FONT_BOLD, etc. More... | |
| enum | LineStyle |
| Line style constants: LINE_SOLID, LINE_DOTTED, etc. More... | |
| enum | CapStyle |
| Line cap style constants: CAP_BUTT, CAP_SQUARE, etc. More... | |
| enum | JoinStyle |
| Line join style constants: JOIN_BEVEL, JOIN_MITER, etc. More... | |
| enum | FillRule |
| Fill rule constants: FILL_EVENODD, FILL_NONZERO. More... | |
| enum | Arrowhead |
| Arrowhead style constants: ARROW_NONE, ARROW_SIMPLE, etc. More... | |
| enum | Interpolation |
| Image interpolation mode constants: INTERPOLATION_NONE, INTERPOLATION_FAST, etc. More... | |
| enum | Anchor |
| Anchoring mode constants: ANCHOR_CENTER, ANCHOR_N, etc. More... | |
| enum | Alignment |
| Text alignment mode constants: ALIGN_LEFT, ALIGN_RIGHT, ALIGN_CENTER. More... | |
| Static Public Member Functions inherited from cOwnedObject | |
| static long | getTotalObjectCount () |
| static long | getLiveObjectCount () |
| static void | resetObjectCounters () |
| static cSoftOwner * | getOwningContext () |
Description
Common base class for line figures.
This class provides line color, style, width, opacity, and other properties. Lines may also be augmented with arrowheads at either or both ends.
Transformations such as scaling or skew do affect the width of the line as it is rendered on the canvas. Whether zooming (by the user) should also affect it can be controlled by setting a flag (see setZoomLineWidth()).
The rendering of zero-width lines is currently undefined. It is attempted to be rendered as a one pixel wide line, regardless of transforms and zoom level, but it is not possible on all platform.
Member Function Documentation
◆ getAllowedPropertyKeys()
|
overrideprotectedvirtual |
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 cArcFigure, cLineFigure, and cPolylineFigure.
References cFigure::cFigure().
◆ dup()
|
inlineoverridevirtual |
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 cArcFigure, cLineFigure, and cPolylineFigure.
◆ str()
|
overridevirtual |
Returns a one-line string with the most characteristic data of the figure.
Reimplemented from cFigure.
Reimplemented in cArcFigure, cLineFigure, and cPolylineFigure.
◆ parse()
|
overridevirtual |
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 cArcFigure, cLineFigure, and cPolylineFigure.
◆ getLineColor()
|
inlinevirtual |
Returns the line color of the figure.
◆ setLineColor()
|
virtual |
Sets the line color of the figure. The default color is black.
◆ getLineWidth()
|
inlinevirtual |
Returns the line width of the figure. Note that the actual line width will also be affected by the figure transformations and, if zoomLineWidth is set, by the zoom level as well.
◆ setLineWidth()
|
virtual |
Sets the line width of the figure. The number must be positive (zero is not allowed). The default line width is 1. See also setZoomLineWidth().
◆ getLineOpacity()
|
inlinevirtual |
Returns the line opacity of the figure, a number in the [0,1] interval.
◆ setLineOpacity()
|
virtual |
Sets the line opacity of the figure. The argument must be a number in the [0,1] interval. The default opacity is 1.0.
◆ getLineStyle()
|
inlinevirtual |
Returns the line style of the figure.
◆ setLineStyle()
|
virtual |
Sets the line style of the figure (dotted, dashed, etc.) The default line style is solid.
◆ getCapStyle()
|
inlinevirtual |
Returns the cap style for the figure's line.
◆ setCapStyle()
|
virtual |
Sets the cap style for the figure's line. The default cap style is butt.
◆ getStartArrowhead()
|
inlinevirtual |
Returns the type of the arrowhead at the start of the line.
◆ setStartArrowhead()
|
virtual |
Sets the type of the arrowhead at the start of the line. The default is no arrowhead.
◆ getEndArrowhead()
|
inlinevirtual |
Returns the type of the arrowhead at the end of the line.
◆ setEndArrowhead()
|
virtual |
Sets the type of the arrowhead at the end of the line. The default is no arrowhead.
◆ getZoomLineWidth()
|
inlinevirtual |
Returns true if zoom level affects the line width the figure is drawn with, and false if it does not.
◆ setZoomLineWidth()
|
virtual |
Sets the flag that controls whether zoom level should affect the line width the figure is drawn with. The default setting is false, i.e. zoom does not affect line width.
Generated on for API by
1.14.0