JKQTPGeoSymbol Class Reference

This virtual JKQTPPlotAnnotationElement descendent may be used to display a single symbol (marker). More...

#include <jkqtpgeoannotations.h>

Inheritance diagram for JKQTPGeoSymbol:

Collaboration diagram for JKQTPGeoSymbol:

Public Slots
virtual void	setColor (QColor c)
void	setP (const QPointF &p)
	set x and y at the same time
void	setX (double __value)
	x-position (in plot coordinates) of the symbol (symbol center)
void	setY (double __value)
	y-position (in plot coordinates) of the symbol (symbol center)
Public Slots inherited from JKQTPPlotElement
void	setHighlighted (bool __value)
	sets whether the graph is drawn in a highlighted style in the plot
virtual void	setTitle (const QString &__value)
	sets the title of the plot (for display in key!).
void	setVisible (bool __value)
	sets whether the graph is visible in the plot

Public Member Functions
	JKQTPGeoSymbol (JKQTBasePlotter *parent, double x, double y)
	class contructor
	JKQTPGeoSymbol (JKQTBasePlotter *parent, double x, double y, JKQTPGraphSymbols symbol)
	class contructor
	JKQTPGeoSymbol (JKQTBasePlotter *parent, double x, double y, JKQTPGraphSymbols symbol, double symbolSize)
	class contructor
	JKQTPGeoSymbol (JKQTBasePlotter *parent, double x, double y, JKQTPGraphSymbols symbol, double symbolSize, QColor color)
	class contructor
	JKQTPGeoSymbol (JKQTBasePlotter *parent, double x, double y, JKQTPGraphSymbols symbol, double symbolSize, QColor color, QColor fillColor)
	class contructor
	JKQTPGeoSymbol (JKQTPlotter *parent, double x, double y)
	class contructor
	JKQTPGeoSymbol (JKQTPlotter *parent, double x, double y, JKQTPGraphSymbols symbol)
	class contructor
	JKQTPGeoSymbol (JKQTPlotter *parent, double x, double y, JKQTPGraphSymbols symbol, double symbolSize)
	class contructor
	JKQTPGeoSymbol (JKQTPlotter *parent, double x, double y, JKQTPGraphSymbols symbol, double symbolSize, QColor color)
	class contructor
	JKQTPGeoSymbol (JKQTPlotter *parent, double x, double y, JKQTPGraphSymbols symbol, double symbolSize, QColor color, QColor fillColor)
	class contructor
virtual void	draw (JKQTPEnhancedPainter &painter) override
	plots the graph to the plotter object specified as parent
virtual void	drawKeyMarker (JKQTPEnhancedPainter &painter, const QRectF &rect) override
	plots a key marker inside the specified rectangle rect
virtual QColor	getKeyLabelColor () const override
	returns the color to be used for the key label
QPointF	getP () const
	returns x and y at the same time
double	getX () const
	x-position (in plot coordinates) of the symbol (symbol center)
virtual bool	getXMinMax (double &minx, double &maxx, double &smallestGreaterZero) override
	get the maximum and minimum x-value of the graph
double	getY () const
	y-position (in plot coordinates) of the symbol (symbol center)
virtual bool	getYMinMax (double &miny, double &maxy, double &smallestGreaterZero) override
	get the maximum and minimum y-value of the graph
Public Member Functions inherited from JKQTPPlotAnnotationElement
	JKQTPPlotAnnotationElement (JKQTBasePlotter *parent=nullptr)
	class constructor
virtual	~JKQTPPlotAnnotationElement ()
	default wirtual destructor
Public Member Functions inherited from JKQTPPlotElement
	JKQTPPlotElement (JKQTBasePlotter *parent=nullptr)
	class constructor
virtual	~JKQTPPlotElement ()=default
	default wirtual destructor
QPointF	backTransform (const QPointF &x) const
	tool routine that back-transforms a QPointF according to the parent's transformation rules (pixels --> plot coordinate)
QPointF	backTransform (double x, double y) const
	tool routine that back-transforms a QPointF according to the parent's transformation rules (pixels --> plot coordinate)
double	backtransformX (double x) const
	tool routine that backtransforms an x-coordinate (pixels --> plot coordinate) for this plot element, uses the axis referenced in xAxisRef
double	backtransformY (double y) const
	tool routine that backtransforms a y-coordinate (pixels --> plot coordinate) for this plot element, uses the axis referenced in yAxisRef
virtual void	drawOutside (JKQTPEnhancedPainter &painter, QRect leftSpace, QRect rightSpace, QRect topSpace, QRect bottomSpace)
	plots outside the actual plot field of view (e.g. color bars, scale bars, ...)
QImage	generateKeyMarker (QSize size=QSize(16, 16))
	returns an image with a key marker inside
virtual void	getOutsideSize (JKQTPEnhancedPainter &painter, int &leftSpace, int &rightSpace, int &topSpace, int &bottomSpace)
	if the graph plots outside the actual plot field of view (e.g. color bars, scale bars, ...)
JKQTBasePlotter *	getParent ()
	returns the parent painter class
const JKQTBasePlotter *	getParent () const
	returns the parent painter class
QString	getTitle () const
	returns the the title of the plot
const JKQTPCoordinateAxis *	getXAxis () const
	returns the actual x-Axis-object from the parent plotter, referenced in xAxisRef
JKQTPCoordinateAxisRef	getXAxisRef () const
	indicates which coordinate axis to use for coordinate transforms in x-direction
const JKQTPCoordinateAxis *	getYAxis () const
	returns the actual y-Axis-object from the parent plotter, referenced in yAxisRef
JKQTPCoordinateAxisRef	getYAxisRef () const
	indicates which coordinate axis to use for coordinate transforms in y-direction
virtual double	hitTest (const QPointF &posSystem, QPointF *closestSpotSystem=nullptr, QString *label=nullptr, HitTestMode mode=HitTestXY) const
	returns the closest distance of the plot element to the (screen pixel) position pos, or NAN
bool	isHighlighted () const
	returns whether the graph is shown in a highlighted style in the plot
bool	isVisible () const
	returns whether the graph is visible in the plot
void	setAxes (JKQTPCoordinateAxisRef ref)
	set the coordinate axes to use for this plot element
virtual void	setParent (JKQTBasePlotter *parent)
	sets the parent painter class
virtual void	setParent (JKQTPlotter *parent)
	sets the parent painter class
void	setXAxis (JKQTPCoordinateAxisRef ref)
	indicates which coordinate axis to use for coordinate transforms in x-direction
void	setYAxis (JKQTPCoordinateAxisRef ref)
	indicates which coordinate axis to use for coordinate transforms in y-direction
QPointF	transform (const QPointF &x) const
	tool routine that transforms a QPointF according to the parent's transformation rules (plot coordinate --> pixels)
QPolygonF	transform (const QPolygonF &x) const
	tool routine that transforms a QPolygonF according to the parent's transformation rules (plot coordinate --> pixels)
QPointF	transform (double x, double y) const
	tool routine that transforms a QPointF according to the parent's transformation rules (plot coordinate --> pixels)
QPainterPath	transformToLinePath (const QPolygonF &x) const
	tool routine that transforms a QPolygonF according to the parent's transformation rules and returns a (non-closed) path consisting of lines (plot coordinate --> pixels)
QVector< double >	transformX (const QVector< double > &x) const
	transform all x-coordinates in a vector x
double	transformX (double x) const
	tool routine that transforms an x-coordinate (plot coordinate --> pixels) for this plot element, uses the axis referenced in xAxisRef
QVector< double >	transformY (const QVector< double > &x) const
	transform all y-coordinates in a vector x
double	transformY (double y) const
	tool routine that transforms a y-coordinate (plot coordinate --> pixels) for this plot element, uses the axis referenced in yAxisRef
Public Member Functions inherited from JKQTPGraphSymbolStyleMixin
	JKQTPGraphSymbolStyleMixin ()
	class constructor
virtual	~JKQTPGraphSymbolStyleMixin ()
QColor	getSymbolColor () const
	set the color of the graph symbols
QColor	getSymbolFillColor () const
	set the color of filling of the graph symbols
QString	getSymbolFontName () const
	get the font to be used for character symbols JKQTPCharacterSymbol+QChar('').unicode()
double	getSymbolLineWidth () const
	get the line width of the graph symbol outline (in pt)
double	getSymbolSize () const
	get the size (=diameter in pt) of the graph symbol (in pt)
JKQTPGraphSymbols	getSymbolType () const
	get the type of the graph symbol
void	initSymbolStyle (JKQTBasePlotter *parent, int &parentPlotStyle, JKQTPPlotStyleType styletype=JKQTPPlotStyleType::Default)
	initiaize the symbol style (from the parent plotter)
void	setSymbolAlpha (double alpha)
	set alpha-value of symbol outline and filling
void	setSymbolColor (const QColor &__value)
	set the color of the graph symbols
void	setSymbolColor (const QColor &__value, double alpha)
	set the color of the graph symbols
void	setSymbolFillColor (const QColor &__value)
	set the color of filling of the graph symbols
void	setSymbolFillColor (const QColor &__value, double alpha)
	set the color of filling of the graph symbols
void	setSymbolFontName (const QString &__value)
	set the font to be used for character symbols JKQTPCharacterSymbol+QChar('').unicode()
void	setSymbolLineWidth (double __value)
	set the line width of the graph symbol outline (in pt)
void	setSymbolSize (double __value)
	set the size (=diameter in pt) of the graph symbol (in pt)
void	setSymbolType (JKQTPGraphSymbols __value)
	set the type of the graph symbol

Protected Attributes
double	x
	x-position (in plot coordinates) of the symbol (symbol center)
double	y
	y-position (in plot coordinates) of the symbol (symbol center)
Protected Attributes inherited from JKQTPPlotElement
QVector< HitTestLocation >	m_hitTestData
	dataset with graph-points and associated data from the function hitTest()
JKQTBasePlotter *	parent
	the plotter object this object belongs to
int	parentPlotStyle
	internal storage for the used parent plot style

Additional Inherited Members
Public Types inherited from JKQTPPlotElement
enum	HitTestMode {   HitTestXY ,   HitTestXOnly ,   HitTestYOnly }
	modes of operation for the function hitTest() More...
Protected Member Functions inherited from JKQTPPlotElement
void	addHitTestData (const HitTestLocation &loc)
	clear the internal datastore for hitTest()
void	addHitTestData (const QPointF &pos_, const QString &label_)
	clear the internal datastore for hitTest()
void	addHitTestData (const QPointF &pos_, int index_, const QString &label_)
	clear the internal datastore for hitTest()
void	addHitTestData (const QPointF &pos_, int index_=-1, const JKQTPDatastore *datastore=nullptr)
	clear the internal datastore for hitTest(), this variant uses formatHitTestDefaultLabel() to auto-generate the label
void	addHitTestData (double x_, double y_, const QString &label_)
	add a new point on the graph to the internal datastore for hitTest()
void	addHitTestData (double x_, double y_, int index_, const QString &label_)
	clear the internal datastore for hitTest()
void	addHitTestData (double x_, double y_, int index_=-1, const JKQTPDatastore *datastore=nullptr)
	add a new point on the graph to the internal datastore for hitTest(), this variant uses formatHitTestDefaultLabel() to auto-generate the label
void	clearHitTestData ()
	clear the internal datastore for hitTest()
virtual QString	formatHitTestDefaultLabel (double x, double y, int index=-1, const JKQTPDatastore *datastore=nullptr) const
	tool-function for hitTest(), which formats a default label, taking into account the x- and y-position (both provided) and optionally the errors of these positions.
void	reserveHitTestData (int points)
	reserve list entries for up to points graph points in the internal datastore for hitTest()
QString	xFloatToString (double v, int past_comma=-1) const
	converts a x-value v into a string, taking into account the type of x-axis
QString	yFloatToString (double v, int past_comma=-1) const
	converts a x-value v into a string, taking into account the type of x-axis
Protected Member Functions inherited from JKQTPGraphSymbolStyleMixin
double	getKeySymbolLineWidthPx (JKQTPEnhancedPainter &painter, const QRectF &keyRect, const JKQTBasePlotter *parent, double maxSymbolSizeFracton=0.9) const
	returns the symbol linewidth for drawing symbols in a key entry with keyRect for the symbol, using painter and parent . maxSymbolSizeFracton specifies the maximum fraction of keyRect to be used for the symbol.
double	getKeySymbolSizePx (JKQTPEnhancedPainter &painter, const QRectF &keyRect, const JKQTBasePlotter *parent, double maxSymbolSizeFracton=0.9) const
	returns the symbol size for drawing symbols in a key entry with keyRect for the symbol, using painter and parent . maxSymbolSizeFracton specifies the maximum fraction of keyRect to be used for the symbol.
QBrush	getSymbolBrush (JKQTPEnhancedPainter &painter, JKQTBasePlotter *parent) const
	constructs a QPen from the line styling properties
QFont	getSymbolFont () const
	generate a QFont for darwing symbols
QPen	getSymbolPen (JKQTPEnhancedPainter &painter, JKQTBasePlotter *parent) const
	constructs a QPen from the line styling properties
void	plotStyledSymbol (JKQTBasePlotter *parent, JKQTPEnhancedPainter &painter, double x, double y) const
	plot a symbol at location x,y (in painter coordinates), using the current style
void	plotStyledSymbol (JKQTBasePlotter *parent, JKQTPEnhancedPainter &painter, double x, double y, double symbolSize) const
	plot a symbol at location x,y (in painter coordinates), using the current style
void	plotStyledSymbol (JKQTBasePlotter *parent, JKQTPEnhancedPainter &painter, double x, double y, JKQTPGraphSymbols type) const
	plot a symbol at location x,y (in painter coordinates), using the current style
void	plotStyledSymbol (JKQTBasePlotter *parent, JKQTPEnhancedPainter &painter, double x, double y, QColor color, QColor fillColor) const
	plot a symbol at location x,y (in painter coordinates), using the current style
Properties inherited from JKQTPPlotElement
bool	highlighted
	indicates whether the graph is shown in a "highlghted" in the plot
QString	title
	title of the plot (for display in key!). If no title is supplied, no key entry is drawn.
bool	visible
	indicates whether the graph is visible in the plot
JKQTPCoordinateAxisRef	xAxisRef
	indicates which coordinate axis to use for coordinate transforms in x-direction
JKQTPCoordinateAxisRef	yAxisRef
	indicates which coordinate axis to use for coordinate transforms in y-direction
Properties inherited from JKQTPGraphSymbolStyleMixin
QColor	symbolColor
QColor	symbolFillColor
QString	symbolFontName
double	symbolLineWidth
double	symbolSize
JKQTPGraphSymbols	symbolType

Detailed Description

This virtual JKQTPPlotAnnotationElement descendent may be used to display a single symbol (marker).

See also

Example (JKQTPlotter): Plotting Geometric Objects

Constructor & Destructor Documentation

JKQTPGeoSymbol() [1/10]

JKQTPGeoSymbol::JKQTPGeoSymbol	(	JKQTBasePlotter *	parent,
		double	x,
		double	y,
		JKQTPGraphSymbols	symbol,
		double	symbolSize
	)

class contructor

Parameters

parent	parent plotter widget
x	x-coordinate of symbol center
y	y-coordinate of symbol center
symbol	symbol type
symbolSize	size of the symbol in pt

JKQTPGeoSymbol() [2/10]

JKQTPGeoSymbol::JKQTPGeoSymbol	(	JKQTPlotter *	parent,
		double	x,
		double	y,
		JKQTPGraphSymbols	symbol,
		double	symbolSize
	)

class contructor

Parameters

parent	parent plotter widget
x	x-coordinate of symbol center
y	y-coordinate of symbol center
symbol	symbol type
symbolSize	size of the symbol in pt

JKQTPGeoSymbol() [3/10]

JKQTPGeoSymbol::JKQTPGeoSymbol	(	JKQTBasePlotter *	parent,
		double	x,
		double	y,
		JKQTPGraphSymbols	symbol,
		double	symbolSize,
		QColor	color,
		QColor	fillColor
	)

class contructor

Parameters

parent	parent plotter widget
x	x-coordinate of symbol center
y	y-coordinate of symbol center
symbol	symbol type
symbolSize	size of the symbol in pt
color	color of drawing
fillColor	fill color of the symbol (if filled)

JKQTPGeoSymbol() [4/10]

JKQTPGeoSymbol::JKQTPGeoSymbol	(	JKQTPlotter *	parent,
		double	x,
		double	y,
		JKQTPGraphSymbols	symbol,
		double	symbolSize,
		QColor	color,
		QColor	fillColor
	)

class contructor

Parameters

parent	parent plotter widget
x	x-coordinate of symbol center
y	y-coordinate of symbol center
symbol	symbol type
symbolSize	size of the symbol in pt
color	color of drawing
fillColor	fill color of the symbol (if filled)

JKQTPGeoSymbol() [5/10]

JKQTPGeoSymbol::JKQTPGeoSymbol	(	JKQTBasePlotter *	parent,
		double	x,
		double	y,
		JKQTPGraphSymbols	symbol,
		double	symbolSize,
		QColor	color
	)

class contructor

Parameters

parent	parent plotter widget
x	x-coordinate of symbol center
y	y-coordinate of symbol center
symbol	symbol type
symbolSize	size of the symbol in pt
color	color of drawing

JKQTPGeoSymbol() [6/10]

JKQTPGeoSymbol::JKQTPGeoSymbol	(	JKQTPlotter *	parent,
		double	x,
		double	y,
		JKQTPGraphSymbols	symbol,
		double	symbolSize,
		QColor	color
	)

class contructor

Parameters

parent	parent plotter widget
x	x-coordinate of symbol center
y	y-coordinate of symbol center
symbol	symbol type
symbolSize	size of the symbol in pt
color	color of drawing

JKQTPGeoSymbol() [7/10]

JKQTPGeoSymbol::JKQTPGeoSymbol	(	JKQTBasePlotter *	parent,
		double	x,
		double	y,
		JKQTPGraphSymbols	symbol
	)

class contructor

Parameters

parent	parent plotter widget
x	x-coordinate of symbol center
y	y-coordinate of symbol center
symbol	symbol type

JKQTPGeoSymbol() [8/10]

JKQTPGeoSymbol::JKQTPGeoSymbol	(	JKQTPlotter *	parent,
		double	x,
		double	y,
		JKQTPGraphSymbols	symbol
	)

class contructor

Parameters

parent	parent plotter widget
x	x-coordinate of symbol center
y	y-coordinate of symbol center
symbol	symbol type

JKQTPGeoSymbol() [9/10]

JKQTPGeoSymbol::JKQTPGeoSymbol	(	JKQTBasePlotter *	parent,
		double	x,
		double	y
	)

class contructor

Parameters

parent	parent plotter widget
x	x-coordinate of symbol center
y	y-coordinate of symbol center

JKQTPGeoSymbol() [10/10]

JKQTPGeoSymbol::JKQTPGeoSymbol	(	JKQTPlotter *	parent,
		double	x,
		double	y
	)

class contructor

Parameters

parent	parent plotter widget
x	x-coordinate of symbol center
y	y-coordinate of symbol center

Member Function Documentation

draw()

virtual void JKQTPGeoSymbol::draw ( JKQTPEnhancedPainter &  painter )

overridevirtual

plots the graph to the plotter object specified as parent

Implements JKQTPPlotElement.

drawKeyMarker()

virtual void JKQTPGeoSymbol::drawKeyMarker ( JKQTPEnhancedPainter &  painter, const QRectF &  rect  )

overridevirtual

plots a key marker inside the specified rectangle rect

Implements JKQTPPlotElement.

getKeyLabelColor()

virtual QColor JKQTPGeoSymbol::getKeyLabelColor ( ) const

overridevirtual

returns the color to be used for the key label

Implements JKQTPPlotElement.

getP()

QPointF JKQTPGeoSymbol::getP

(

)

const

returns x and y at the same time

See also

x, y

getX()

double JKQTPGeoSymbol::getX

(

)

const

x-position (in plot coordinates) of the symbol (symbol center)

getXMinMax()

virtual bool JKQTPGeoSymbol::getXMinMax ( double &  minx, double &  maxx, double &  smallestGreaterZero  )

overridevirtual

get the maximum and minimum x-value of the graph

The result is given in the two parameters which are call-by-reference parameters!

Parameters

[out]	minx	minimal x-value used in the graph
[out]	maxx	maximal x-value used in the graph
[out]	smallestGreaterZero	the smalles x-value in the graph, which is larger than 0 (this is used in auto-sizing for logarithmic axes)

Returns

true on success, i.e. if there were datapoints in the plot, or false on failure (e.g. when the graph is empty)

Implements JKQTPPlotElement.

getY()

double JKQTPGeoSymbol::getY

(

)

const

y-position (in plot coordinates) of the symbol (symbol center)

getYMinMax()

virtual bool JKQTPGeoSymbol::getYMinMax ( double &  miny, double &  maxy, double &  smallestGreaterZero  )

overridevirtual

get the maximum and minimum y-value of the graph

The result is given in the two parameters which are call-by-reference parameters!

Parameters

[out]	miny	minimal y-value used in the graph
[out]	maxy	maximal y-value used in the graph
[out]	smallestGreaterZero	the smalles y-value in the graph, which is larger than 0 (this is used in auto-sizing for logarithmic axes)

Returns

true on success, i.e. if there were datapoints in the plot, or false on failure (e.g. when the graph is empty)

Implements JKQTPPlotElement.

setColor

virtual void JKQTPGeoSymbol::setColor ( QColor  c )

virtualslot

set the symbol color and symbol fill color

setP

void JKQTPGeoSymbol::setP ( const QPointF &  p )

slot

set x and y at the same time

See also

x, y

setX

void JKQTPGeoSymbol::setX ( double  __value )

slot

x-position (in plot coordinates) of the symbol (symbol center)

setY

void JKQTPGeoSymbol::setY ( double  __value )

slot

y-position (in plot coordinates) of the symbol (symbol center)

Member Data Documentation

x

double JKQTPGeoSymbol::x

protected

x-position (in plot coordinates) of the symbol (symbol center)

y

double JKQTPGeoSymbol::y

protected

y-position (in plot coordinates) of the symbol (symbol center)

---

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

• jkqtpgeoannotations.h