QCPItemTracer

Inheritance diagram for QCPItemTracer:

[legend]

Public Types
enum	TracerStyle { tsNone , tsPlus , tsCrosshair , tsCircle , tsSquare }

Public Types inherited from QObject
typedef	QObjectList

Public Member Functions
	QCPItemTracer (QCustomPlot *parentPlot)

QBrush	brush () const

QCPGraph *	graph () const

double	graphKey () const

bool	interpolating () const

QPen	pen () const

QBrush	selectedBrush () const

QPen	selectedPen () const

virtual double	selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=nullptr) const override

void	setBrush (const QBrush &brush)

void	setGraph (QCPGraph *graph)

void	setGraphKey (double key)

void	setInterpolating (bool enabled)

void	setPen (const QPen &pen)

void	setSelectedBrush (const QBrush &brush)

void	setSelectedPen (const QPen &pen)

void	setSize (double size)

void	setStyle (TracerStyle style)

double	size () const

TracerStyle	style () const

void	updatePosition ()

Public Member Functions inherited from QCPAbstractItem
	QCPAbstractItem (QCustomPlot *parentPlot)

QCPItemAnchor *	anchor (const QString &name) const

QList< QCPItemAnchor * >	anchors () const

QCPAxisRect *	clipAxisRect () const

bool	clipToAxisRect () const

bool	hasAnchor (const QString &name) const

QCPItemPosition *	position (const QString &name) const

QList< QCPItemPosition * >	positions () const

bool	selectable () const

bool	selected () const

void	setClipAxisRect (QCPAxisRect *rect)

void	setClipToAxisRect (bool clip)

Q_SLOT void	setSelectable (bool selectable)

Q_SLOT void	setSelected (bool selected)

Public Member Functions inherited from QCPLayerable
	QCPLayerable (QCustomPlot plot, QString targetLayer=QString(), QCPLayerable parentLayerable=nullptr)

bool	antialiased () const

QCPLayer *	layer () const

QCPLayerable *	parentLayerable () const

QCustomPlot *	parentPlot () const

bool	realVisibility () const

void	setAntialiased (bool enabled)

bool	setLayer (const QString &layerName)

Q_SLOT bool	setLayer (QCPLayer *layer)

void	setVisible (bool on)

bool	visible () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Public Attributes
QCPItemPosition *const	position

Protected Member Functions
virtual void	draw (QCPPainter *painter) override

QBrush	mainBrush () const

QPen	mainPen () const

Protected Member Functions inherited from QCPAbstractItem
virtual QPointF	anchorPixelPosition (int anchorId) const

virtual void	applyDefaultAntialiasingHint (QCPPainter *painter) const override

virtual QRect	clipRect () const override

QCPItemAnchor *	createAnchor (const QString &name, int anchorId)

QCPItemPosition *	createPosition (const QString &name)

virtual void	deselectEvent (bool *selectionStateChanged) override

double	rectDistance (const QRectF &rect, const QPointF &pos, bool filledRect) const

virtual void	selectEvent (QMouseEvent event, bool additive, const QVariant &details, bool selectionStateChanged) override

virtual QCP::Interaction	selectionCategory () const override

Protected Member Functions inherited from QCPLayerable
void	applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const

void	initializeParentPlot (QCustomPlot *parentPlot)

virtual void	mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details)

virtual void	mouseMoveEvent (QMouseEvent *event, const QPointF &startPos)

virtual void	mousePressEvent (QMouseEvent *event, const QVariant &details)

virtual void	mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos)

bool	moveToLayer (QCPLayer *layer, bool prepend)

virtual void	parentPlotInitialized (QCustomPlot *parentPlot)

void	setParentLayerable (QCPLayerable *parentLayerable)

virtual void	wheelEvent (QWheelEvent *event)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Protected Attributes
QBrush	mBrush

QCPGraph *	mGraph

double	mGraphKey

bool	mInterpolating

QPen	mPen

QBrush	mSelectedBrush

QPen	mSelectedPen

double	mSize

TracerStyle	mStyle

Protected Attributes inherited from QCPAbstractItem
QList< QCPItemAnchor * >	mAnchors

QPointer< QCPAxisRect >	mClipAxisRect

bool	mClipToAxisRect

QList< QCPItemPosition * >	mPositions

bool	mSelectable

bool	mSelected

Protected Attributes inherited from QCPLayerable
bool	mAntialiased

QCPLayer *	mLayer

QPointer< QCPLayerable >	mParentLayerable

QCustomPlot *	mParentPlot

bool	mVisible

Additional Inherited Members
Properties inherited from QObject
	objectName

Signals inherited from QCPAbstractItem
void	selectableChanged (bool selectable)

void	selectionChanged (bool selected)

Signals inherited from QCPLayerable
void	layerChanged (QCPLayer *newLayer)

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Detailed Description

Item that sticks to QCPGraph data points.

Tracer example. Blue dotted circles are anchors, solid blue discs are positions.

The tracer can be connected with a QCPGraph via setGraph. Then it will automatically adopt the coordinate axes of the graph and update its position to be on the graph's data. This means the key stays controllable via setGraphKey, but the value will follow the graph data. If a QCPGraph is connected, note that setting the coordinates of the tracer item directly via position will have no effect because they will be overriden in the next redraw (this is when the coordinate update happens).

If the specified key in setGraphKey is outside the key bounds of the graph, the tracer will stay at the corresponding end of the graph.

With setInterpolating you may specify whether the tracer may only stay exactly on data points or whether it interpolates data points linearly, if given a key that lies between two data points of the graph.

The tracer has different visual styles, see setStyle. It is also possible to make the tracer have no own visual appearance (set the style to tsNone), and just connect other item positions to the tracer position (used as an anchor) via QCPItemPosition::setParentAnchor.

Note: The tracer position is only automatically updated upon redraws. So when the data of the graph changes and immediately afterwards (without a redraw) the position coordinates of the tracer are retrieved, they will not reflect the updated data of the graph. In this case updatePosition must be called manually, prior to reading the tracer coordinates.

Definition at line 6853 of file qcustomplot.h.

Member Enumeration Documentation

◆ TracerStyle

enum QCPItemTracer::TracerStyle

The different visual appearances a tracer item can have. Some styles size may be controlled with setSize.

See also: setStyle

Enumerator
tsNone	The tracer is not visible.
tsPlus	A plus shaped crosshair with limited size.
tsCrosshair	A plus shaped crosshair which spans the complete axis rect.
tsCircle	A circle.
tsSquare	A square.

Definition at line 6873 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPItemTracer()

QCPItemTracer::QCPItemTracer ( QCustomPlot * parentPlot )

explicit

Creates a tracer item and sets default values.

The created item is automatically registered with parentPlot. This QCustomPlot instance takes ownership of the item, so do not delete it manually but use QCustomPlot::removeItem() instead.

Definition at line 30442 of file qcustomplot.cpp.

◆ ~QCPItemTracer()

QCPItemTracer::~QCPItemTracer ( )

overridevirtual

Definition at line 30459 of file qcustomplot.cpp.

Member Function Documentation

◆ brush()

QBrush QCPItemTracer::brush ( ) const

inline

Definition at line 6887 of file qcustomplot.h.

◆ draw()

void QCPItemTracer::draw ( QCPPainter * painter )

overrideprotectedvirtual

Draws this item with the provided painter.

The cliprect of the provided painter is set to the rect returned by clipRect before this function is called. The clipRect depends on the clipping settings defined by setClipToAxisRect and setClipAxisRect.

Implements QCPAbstractItem.

Definition at line 30639 of file qcustomplot.cpp.

◆ graph()

QCPGraph * QCPItemTracer::graph ( ) const

inline

Definition at line 6891 of file qcustomplot.h.

◆ graphKey()

double QCPItemTracer::graphKey ( ) const

inline

Definition at line 6892 of file qcustomplot.h.

◆ interpolating()

bool QCPItemTracer::interpolating ( ) const

inline

Definition at line 6893 of file qcustomplot.h.

◆ mainBrush()

QBrush QCPItemTracer::mainBrush ( ) const

protected

Returns the brush that should be used for drawing fills of the item. Returns mBrush when the item is not selected and mSelectedBrush when it is.

Definition at line 30762 of file qcustomplot.cpp.

◆ mainPen()

QPen QCPItemTracer::mainPen ( ) const

protected

Returns the pen that should be used for drawing lines. Returns mPen when the item is not selected and mSelectedPen when it is.

Definition at line 30752 of file qcustomplot.cpp.

◆ pen()

QPen QCPItemTracer::pen ( ) const

inline

Definition at line 6885 of file qcustomplot.h.

◆ selectedBrush()

QBrush QCPItemTracer::selectedBrush ( ) const

inline

Definition at line 6888 of file qcustomplot.h.

◆ selectedPen()

QPen QCPItemTracer::selectedPen ( ) const

inline

Definition at line 6886 of file qcustomplot.h.

◆ selectTest()

double QCPItemTracer::selectTest	(	const QPointF &	pos,
		bool	onlySelectable,
		QVariant *	details = nullptr ) const

overridevirtual

This function is used to decide whether a click hits a layerable object or not.

pos is a point in pixel coordinates on the QCustomPlot surface. This function returns the shortest pixel distance of this point to the object. If the object is either invisible or the distance couldn't be determined, -1.0 is returned. Further, if onlySelectable is true and the object is not selectable, -1.0 is returned, too.

If the object is represented not by single lines but by an area like a QCPItemText or the bars of a QCPBars plottable, a click inside the area should also be considered a hit. In these cases this function thus returns a constant value greater zero but still below the parent plot's selection tolerance. (typically the selectionTolerance multiplied by 0.99).

Providing a constant value for area objects allows selecting line objects even when they are obscured by such area objects, by clicking close to the lines (i.e. closer than 0.99*selectionTolerance).

The actual setting of the selection state is not done by this function. This is handled by the parent QCustomPlot when the mouseReleaseEvent occurs, and the finally selected object is notified via the selectEvent/ deselectEvent methods.

details is an optional output parameter. Every layerable subclass may place any information in details. This information will be passed to selectEvent when the parent QCustomPlot decides on the basis of this selectTest call, that the object was successfully selected. The subsequent call to selectEvent will carry the details. This is useful for multi-part objects (like QCPAxis). This way, a possibly complex calculation to decide which part was clicked is only done once in selectTest. The result (i.e. the actually clicked part) can then be placed in details. So in the subsequent selectEvent, the decision which part was selected doesn't have to be done a second time for a single selection operation.

In the case of 1D Plottables (QCPAbstractPlottable1D, like QCPGraph or QCPBars) details will be set to a QCPDataSelection, describing the closest data point to pos.

You may pass nullptr as details to indicate that you are not interested in those selection details.

See also: selectEvent, deselectEvent, mousePressEvent, wheelEvent, QCustomPlot::setInteractions, QCPAbstractPlottable1D::selectTestRect

Implements QCPAbstractItem.

Definition at line 30582 of file qcustomplot.cpp.

◆ setBrush()

void QCPItemTracer::setBrush ( const QBrush & brush )

Sets the brush that will be used to draw any fills of the tracer

See also: setSelectedBrush, setPen

Definition at line 30488 of file qcustomplot.cpp.

◆ setGraph()

void QCPItemTracer::setGraph ( QCPGraph * graph )

Sets the QCPGraph this tracer sticks to. The tracer position will be set to type QCPItemPosition::ptPlotCoords and the axes will be set to the axes of graph.

To free the tracer from any graph, set graph to nullptr. The tracer position can then be placed freely like any other item position. This is the state the tracer will assume when its graph gets deleted while still attached to it.

See also: setGraphKey

Definition at line 30533 of file qcustomplot.cpp.

◆ setGraphKey()

void QCPItemTracer::setGraphKey ( double key )

Sets the key of the graph's data point the tracer will be positioned at. This is the only free coordinate of a tracer when attached to a graph.

Depending on setInterpolating, the tracer will be either positioned on the data point closest to key, or will stay exactly at key and interpolate the value linearly.

See also: setGraph, setInterpolating

Definition at line 30560 of file qcustomplot.cpp.

◆ setInterpolating()

void QCPItemTracer::setInterpolating ( bool enabled )

Sets whether the value of the graph's data points shall be interpolated, when positioning the tracer.

If enabled is set to false and a key is given with setGraphKey, the tracer is placed on the data point of the graph which is closest to the key, but which is not necessarily exactly there. If enabled is true, the tracer will be positioned exactly at the specified key, and the appropriate value will be interpolated from the graph's data points linearly.

See also: setGraph, setGraphKey

Definition at line 30576 of file qcustomplot.cpp.

◆ setPen()

void QCPItemTracer::setPen ( const QPen & pen )

Sets the pen that will be used to draw the line of the tracer

See also: setSelectedPen, setBrush

Definition at line 30468 of file qcustomplot.cpp.

◆ setSelectedBrush()

void QCPItemTracer::setSelectedBrush ( const QBrush & brush )

Sets the brush that will be used to draw any fills of the tracer, when selected.

See also: setBrush, setSelected

Definition at line 30498 of file qcustomplot.cpp.

◆ setSelectedPen()

void QCPItemTracer::setSelectedPen ( const QPen & pen )

Sets the pen that will be used to draw the line of the tracer when selected

See also: setPen, setSelected

Definition at line 30478 of file qcustomplot.cpp.

◆ setSize()

void QCPItemTracer::setSize ( double size )

Sets the size of the tracer in pixels, if the style supports setting a size (e.g. tsSquare does, tsCrosshair does not).

Definition at line 30507 of file qcustomplot.cpp.

◆ setStyle()

void QCPItemTracer::setStyle ( QCPItemTracer::TracerStyle style )

Sets the style/visual appearance of the tracer.

If you only want to use the tracer position as an anchor for other items, set style to tsNone.

Definition at line 30518 of file qcustomplot.cpp.

◆ size()

double QCPItemTracer::size ( ) const

inline

Definition at line 6889 of file qcustomplot.h.

◆ style()

TracerStyle QCPItemTracer::style ( ) const

inline

Definition at line 6890 of file qcustomplot.h.

◆ updatePosition()

void QCPItemTracer::updatePosition ( )

If the tracer is connected with a graph (setGraph), this function updates the tracer's position to reside on the graph data, depending on the configured key (setGraphKey).

It is called automatically on every redraw and normally doesn't need to be called manually. One exception is when you want to read the tracer coordinates via position and are not sure that the graph's data (or the tracer key with setGraphKey) hasn't changed since the last redraw. In that situation, call this function before accessing position, to make sure you don't get out-of-date coordinates.

If there is no graph set on this tracer, this function does nothing.

Definition at line 30697 of file qcustomplot.cpp.

Member Data Documentation

◆ mBrush

QBrush QCPItemTracer::mBrush

protected

Definition at line 6917 of file qcustomplot.h.

◆ mGraph

QCPGraph* QCPItemTracer::mGraph

protected

Definition at line 6920 of file qcustomplot.h.

◆ mGraphKey

double QCPItemTracer::mGraphKey

protected

Definition at line 6921 of file qcustomplot.h.

◆ mInterpolating

bool QCPItemTracer::mInterpolating

protected

Definition at line 6922 of file qcustomplot.h.

◆ mPen

QPen QCPItemTracer::mPen

protected

Definition at line 6916 of file qcustomplot.h.

◆ mSelectedBrush

QBrush QCPItemTracer::mSelectedBrush

protected

Definition at line 6917 of file qcustomplot.h.

◆ mSelectedPen

QPen QCPItemTracer::mSelectedPen

protected

Definition at line 6916 of file qcustomplot.h.

◆ mSize

double QCPItemTracer::mSize

protected

Definition at line 6918 of file qcustomplot.h.

◆ mStyle

TracerStyle QCPItemTracer::mStyle

protected

Definition at line 6919 of file qcustomplot.h.

◆ position

QCPItemPosition* const QCPItemTracer::position

Definition at line 6912 of file qcustomplot.h.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Kstars

QCPItemTracer

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TracerStyle

Constructor & Destructor Documentation

◆ QCPItemTracer()

◆ ~QCPItemTracer()

Member Function Documentation

◆ brush()

◆ draw()

◆ graph()

◆ graphKey()

◆ interpolating()

◆ mainBrush()

◆ mainPen()

◆ pen()

◆ selectedBrush()

◆ selectedPen()

◆ selectTest()

◆ setBrush()

◆ setGraph()

◆ setGraphKey()

◆ setInterpolating()

◆ setPen()

◆ setSelectedBrush()

◆ setSelectedPen()

◆ setSize()

◆ setStyle()

◆ size()

◆ style()

◆ updatePosition()

Member Data Documentation

◆ mBrush

◆ mGraph

◆ mGraphKey

◆ mInterpolating

◆ mPen

◆ mSelectedBrush

◆ mSelectedPen

◆ mSize

◆ mStyle

◆ position