Description

A figure that displays a line that consists of multiple connecting straight line segments or of a single smooth curve.

The class stores geometry information as a sequence of points. The line may be smoothed. A smoothed line is drawn as a series of Bezier curves, which touch the start point of the first line segment, the end point of the last line segment, and the midpoints of intermediate line segments, while intermediate points serve as control points. To add corners to a smoothed curve, duplicate points.

Additional properties such as color and line style are inherited from cAbstractLineFigure.

See also: cPathFigure

Inheritance diagram for cPolylineFigure:

[legend]

Public Member Functions
Constructors, destructor, assignment.
	cPolylineFigure (const char *name=nullptr)

	cPolylineFigure (const cPolylineFigure &other)

cPolylineFigure &	operator= (const cPolylineFigure &other)

Redefined cObject and cFigure member functions.
virtual cPolylineFigure *	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 std::vector< Point > &	getPoints () const

virtual void	setPoints (const std::vector< Point > &points)

virtual int	getNumPoints () const

virtual const Point &	getPoint (int i) const

virtual void	setNumPoints (int size)

virtual void	setPoint (int i, const Point &point)

virtual void	addPoint (const Point &point)

virtual void	removePoint (int i)

virtual void	insertPoint (int i, const Point &point)

virtual bool	getSmooth () const

virtual void	setSmooth (bool smooth)

Styling
virtual JoinStyle	getJoinStyle () const

virtual void	setJoinStyle (JoinStyle joinStyle)

Public Member Functions inherited from cAbstractLineFigure
	cAbstractLineFigure (const char *name=nullptr)

	cAbstractLineFigure (const cAbstractLineFigure &other)

cAbstractLineFigure &	operator= (const cAbstractLineFigure &other)

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	translate (double dx, double dy)

virtual void	scale (double s)

virtual void	scale (double sx, double sy)

virtual void	scale (double sx, double sy, double cx, double cy)

virtual void	scale (double sx, double sy, const Point &c)

virtual void	rotate (double phi)

virtual void	rotate (double phi, double cx, double cy)

virtual void	rotate (double phi, const Point &c)

virtual void	skewx (double coeff)

virtual void	skewy (double coeff)

virtual void	skewx (double coeff, double cy)

virtual void	skewy (double coeff, double cx)

virtual void	move (double dx, double dy)

virtual void	refreshDisplay ()

virtual void	updateParentTransform (Transform &transform)

virtual void	callRefreshDisplay ()

uint8_t	getLocalChangeFlags () const

uint8_t	getSubtreeChangeFlags () const

void	clearChangeFlags ()

void	refreshTagBitsRec (cCanvas *ownerCanvas)

int64_t	getTagBits () const

void	setTagBits (uint64_t tagBits)

uint32_t	getHash () const

void	clearCachedHash ()

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 cFigure
virtual void	validatePropertyKeys (cProperty *property) const

virtual bool	isAllowedPropertyKey (const char *key) const

virtual cFigure *	getRootFigure () const

void	fireStructuralChange ()

void	fireTransformChange ()

void	fireGeometryChange ()

void	fireVisualChange ()

void	fireInputDataChange ()

virtual void	fire (uint8_t flags)

Protected Member Functions inherited from cObject
virtual void	take (cOwnedObject *obj)

virtual void	drop (cOwnedObject *obj)

void	dropAndDelete (cOwnedObject *obj)

Additional Inherited Members
Public Types inherited from cFigure
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...

enum

Static Public Member Functions inherited from cFigure
static Point	parsePoint (const char *s)

static Rectangle	parseRectangle (const char *s)

static Transform	parseTransform (const char *s)

static Font	parseFont (const char *s)

static Color	parseColor (const char *s)

static bool	parseBool (const char *s)

static LineStyle	parseLineStyle (const char *s)

static CapStyle	parseCapStyle (const char *s)

static JoinStyle	parseJoinStyle (const char *s)

static FillRule	parseFillRule (const char *s)

static Arrowhead	parseArrowhead (const char *s)

static Interpolation	parseInterpolation (const char *s)

static Anchor	parseAnchor (const char *s)

static Alignment	parseAlignment (const char *s)

Static Public Member Functions inherited from cOwnedObject
static long	getTotalObjectCount ()

static long	getLiveObjectCount ()

static void	resetObjectCounters ()

static cSoftOwner *	getOwningContext ()

Static Public Attributes inherited from cFigure
static const Color	BLACK

static const Color	WHITE

static const Color	GREY

static const Color	RED

static const Color	GREEN

static const Color	BLUE

static const Color	YELLOW

static const Color	CYAN

static const Color	MAGENTA

static const int	NUM_GOOD_DARK_COLORS

static const int	NUM_GOOD_LIGHT_COLORS

static const Color	GOOD_DARK_COLORS [14]

static const Color	GOOD_LIGHT_COLORS [10]

Static Protected Member Functions inherited from cFigure
static Point	parsePoint (cProperty property, const char key, int index)

static std::vector< Point >	parsePoints (cProperty property, const char key)

static Rectangle	parseBounds (cProperty *property, const Rectangle &defaults)

static Transform	parseTransform (cProperty property, const char key)

static Font	parseFont (cProperty property, const char key)

static Rectangle	computeBoundingBox (const Point &position, const Point &size, double ascent, Anchor anchor)

static void	concatArrays (const char dest, const char first, const char **second)

Member Function Documentation

◆ getAllowedPropertyKeys()

virtual const char** getAllowedPropertyKeys ( ) const

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

◆ dup()

virtual cPolylineFigure* dup ( ) const

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

◆ str()

virtual std::string str ( ) const

overridevirtual

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

Reimplemented from cAbstractLineFigure.

◆ parse()

virtual void parse ( cProperty * property )

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

◆ moveLocal()

virtual void moveLocal	(	double	dx,
		double	dy
	)

overridevirtual

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

Implements cFigure.

◆ getRendererClassName()

virtual const char* getRendererClassName ( ) const

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.

◆ getPoints()

virtual const std::vector<Point>& getPoints ( ) const

inlinevirtual

Returns the points that define the polyline.

◆ setPoints()

virtual void setPoints ( const std::vector< Point > & points )

virtual

Sets the points that define the polyline.

◆ getNumPoints()

virtual int getNumPoints ( ) const

inlinevirtual

Returns the number of points. Equivalent to getPoints().size().

◆ getPoint()

virtual const Point& getPoint ( int i ) const

inlinevirtual

Returns the ith point. The index must be in the 0..getNumPoints()-1 interval.

◆ setNumPoints()

virtual void setNumPoints ( int size )

virtual

Sets the number of points that define the polyline. (Appends new points or drops trailing points as needed.)

◆ setPoint()

virtual void setPoint	(	int	i,
		const Point &	point
	)

virtual

Sets the ith point. The index must be in the 0..getNumPoints()-1 interval.

◆ addPoint()

virtual void addPoint ( const Point & point )

virtual

Appends a point.

◆ removePoint()

virtual void removePoint ( int i )

virtual

Removes the ith point. The index must be in the 0..getNumPoints()-1 interval.

◆ insertPoint()

virtual void insertPoint	(	int	i,
		const Point &	point
	)

virtual

Inserts a point at position i, shifting up the point at and above index i. The index must be in the 0..getNumPoints()-1 interval.

◆ getSmooth()

virtual bool getSmooth ( ) const

inlinevirtual

Returns true if the figure is rendered as a smoothed curve, and false if as a sequence of connecting of straight line segments. See the class description for details on how the points define the curve in the smoothed case.

◆ setSmooth()

virtual void setSmooth ( bool smooth )

virtual

Sets the flag that determines whether connecting straight line segments or a single smooth curve should be drawn. See the class description for details on how the points define the curve in the smoothed case. The default value is false (no smoothing).

◆ getJoinStyle()

virtual JoinStyle getJoinStyle ( ) const

inlinevirtual

Returns the join style line segments will be connected with.

◆ setJoinStyle()

virtual void setJoinStyle ( JoinStyle joinStyle )

virtual

Sets the join style line segments will be connected with. The default join style is miter.

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

ccanvas.h

	OMNeT++ API 6.1 Discrete Event Simulation Library

Description

Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ getAllowedPropertyKeys()

◆ dup()

◆ str()

◆ parse()

◆ moveLocal()

◆ getRendererClassName()

◆ getPoints()

◆ setPoints()

◆ getNumPoints()

◆ getPoint()

◆ setNumPoints()

◆ setPoint()

◆ addPoint()

◆ removePoint()

◆ insertPoint()

◆ getSmooth()

◆ setSmooth()

◆ getJoinStyle()

◆ setJoinStyle()