cRingFigure Class Reference¶
|
API
|
Public Member Functions | |
Constructors, destructor, assignment. | |
Redefined cObject and cFigure member functions. | |
| virtual cRingFigure * | dup () const override |
| virtual std::string | str () const override |
| virtual void | parse (cProperty *property) override |
| virtual void | moveLocal (double dx, double dy) override |
| virtual const char * | getRendererClassName () const override |
Geometry | |
| virtual const Rectangle & | getBounds () const |
| virtual void | setBounds (const Rectangle &bounds) |
| virtual void | setPosition (const Point &position, Anchor anchor) |
| virtual void | setInnerRadius (double r) |
| virtual double | getInnerRx () const |
| virtual void | setInnerRx (double rx) |
| virtual double | getInnerRy () const |
| virtual void | setInnerRy (double ry) |
| Public Member Functions inherited from cAbstractShapeFigure | |
| virtual bool | isFilled () const |
| virtual void | setFilled (bool filled) |
| virtual bool | isOutlined () const |
| virtual void | setOutlined (bool outlined) |
| virtual const Color & | getLineColor () const |
| virtual void | setLineColor (const Color &lineColor) |
| virtual const Color & | getFillColor () const |
| virtual void | setFillColor (const Color &fillColor) |
| virtual LineStyle | getLineStyle () const |
| virtual void | setLineStyle (LineStyle lineStyle) |
| virtual double | getLineWidth () const |
| virtual void | setLineWidth (double lineWidth) |
| virtual double | getLineOpacity () const |
| virtual void | setLineOpacity (double lineOpacity) |
| virtual double | getFillOpacity () const |
| virtual void | setFillOpacity (double fillOpacity) |
| 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 | move (double dx, double dy) |
| virtual void | refreshDisplay () |
| 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
A figure that displays a ring, with explicitly controllable inner/outer radii.
The inner/outer circles (or ellipses) form the outline, and the area between them is filled. As with all shape figures, drawing of both the outline and the fill are optional. Line and fill color, and several other properties are inherited from cAbstractShapeFigure.
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 cAbstractShapeFigure.
◆ 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 cAbstractShapeFigure.
◆ str()
|
overridevirtual |
Returns a one-line string with the most characteristic data of the figure.
Reimplemented from cAbstractShapeFigure.
◆ 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 cAbstractShapeFigure.
◆ moveLocal()
|
overridevirtual |
Change the figure's position by the given x and y deltas. Child figures will not be affected.
Implements cFigure.
◆ getRendererClassName()
|
inlineoverridevirtual |
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.
◆ getBounds()
|
inlinevirtual |
Returns the rectangle that defines the ring's outer circle or ellipse.
◆ setBounds()
|
virtual |
Sets the rectangle that defines the ring's outer circle or ellipse.
◆ setPosition()
Utility function. Moves the bounding box so that its point denoted by anchor will be at the given position.
◆ setInnerRadius()
|
inlinevirtual |
Sets the ring's inner curve to a circle with the given radius. This method sets the horizontal and vertical inner radii to the same value.
References setInnerRx(), and setInnerRy().
◆ getInnerRx()
|
inlinevirtual |
Returns the horizontal radius of the ring's inner circle or ellipse.
◆ setInnerRx()
|
virtual |
Sets the horizontal radius of the ring's inner circle or ellipse.
Referenced by setInnerRadius().
◆ getInnerRy()
|
inlinevirtual |
Returns the vertical radius of the ring's inner circle or ellipse.
◆ setInnerRy()
|
virtual |
Sets the vertical radius of the ring's inner circle or ellipse.
Referenced by setInnerRadius().
Generated on for API by
1.14.0