##// END OF EJS Templates
Added some missing restrictions to OpenGL series usage docs...
Added some missing restrictions to OpenGL series usage docs Change-Id: Id5bce8c0eda6aa66377516168e7fbae8c5dc7eed Reviewed-by: Titta Heikkala <titta.heikkala@theqtcompany.com>

File last commit:

r2831:9aa888c2f56c
r2831:9aa888c2f56c
Show More
qabstractseries.cpp
462 lines | 13.2 KiB | text/x-c | CppLexer
/ src / charts / qabstractseries.cpp
Jani Honkonen
Add license headers
r794 /****************************************************************************
**
Titta Heikkala
Copyright header changes...
r2776 ** Copyright (C) 2015 The Qt Company Ltd
Jani Honkonen
Add license headers
r794 ** All rights reserved.
Titta Heikkala
Copyright header changes...
r2776 ** For any questions to The Qt Company, please use contact form at http://qt.io
Jani Honkonen
Add license headers
r794 **
Titta Heikkala
Updated license headers...
r2740 ** This file is part of the Qt Charts module.
Jani Honkonen
Add license headers
r794 **
Titta Heikkala
Updated license headers...
r2740 ** Licensees holding valid commercial license for Qt may use this file in
** accordance with the Qt License Agreement provided with the Software
** or, alternatively, in accordance with the terms contained in a written
Titta Heikkala
Copyright header changes...
r2776 ** agreement between you and The Qt Company.
Jani Honkonen
Add license headers
r794 **
** If you have questions regarding the use of this file, please use
Titta Heikkala
Updated license headers...
r2740 ** contact form at http://qt.io
Jani Honkonen
Add license headers
r794 **
****************************************************************************/
Titta Heikkala
Fix include syntax...
r2714 #include <QtCharts/QAbstractSeries>
#include <private/qabstractseries_p.h>
#include <private/chartdataset_p.h>
#include <QtCharts/QChart>
#include <private/qchart_p.h>
#include <private/chartitem_p.h>
#include <private/xydomain_p.h>
#include <private/xlogydomain_p.h>
#include <private/logxydomain_p.h>
#include <private/logxlogydomain_p.h>
Michal Klocek
Adds big fat pimpl to series classes...
r938
Titta Heikkala
Qt Charts project file structure change...
r2712 QT_CHARTS_BEGIN_NAMESPACE
sauimone
Refactored series creation.
r62
Tero Ahola
qdoc for QChartSeries
r309 /*!
Tero Ahola
Renamed QSeries to QAbstractSeries
r988 \class QAbstractSeries
Titta Heikkala
Fix Charts documentation...
r2639 \inmodule Qt Charts
Miikka Heikkinen
Fix some docs issues...
r2591 \brief Base class for all Qt Chart series.
Tero Ahola
Documenting QChartSeries continues
r310
Usually you use the series type specific inherited classes instead of the base class.
sauimone
renamed barseries files to abstractbarseries
r1586 \sa QXYSeries, QLineSeries, QSplineSeries, QScatterSeries, QAreaSeries, QAbstractBarSeries, QStackedBarSeries,
Tero Ahola
Updated documentation, warnings from legend and area left
r973 QPercentBarSeries, QPieSeries
Tero Ahola
qdoc for QChartSeries
r309 */
Tero Ahola
QML methods of series: several fixes and documentation
r1521 /*!
Titta Heikkala
Fix Charts documentation...
r2639 \qmltype AbstractSeries
\instantiates QAbstractSeries
Titta Heikkala
Qt Charts project file structure change...
r2712 \inqmlmodule QtCharts
Titta Heikkala
Fix Charts documentation...
r2639
Titta Heikkala
Qt Charts project file structure change...
r2712 \brief Base class for all Qt Chart series.
Titta Heikkala
Fix Charts documentation...
r2639
Titta Heikkala
Qt Charts project file structure change...
r2712 AbstractSeries is the base class for all series.
The class cannot be instantiated by the user.
Tero Ahola
QML methods of series: several fixes and documentation
r1521 */
Tero Ahola
qdoc for QChartSeries
r309
/*!
Michal Klocek
Fixes to API , QSeriesType -> SeriesType , add missing getters
r1107 \enum QAbstractSeries::SeriesType
Tero Ahola
qdoc for QChartSeries
r309
The type of the series object.
\value SeriesTypeLine
\value SeriesTypeArea
\value SeriesTypeBar
\value SeriesTypeStackedBar
\value SeriesTypePercentBar
\value SeriesTypePie
\value SeriesTypeScatter
\value SeriesTypeSpline
sauimone
horizontal barchart doc update
r1709 \value SeriesTypeHorizontalBar
\value SeriesTypeHorizontalStackedBar
\value SeriesTypeHorizontalPercentBar
Mika Salmela
A new box-and-whiskers series type added to charts....
r2548 \value SeriesTypeBoxPlot
Tero Ahola
qdoc for QChartSeries
r309 */
/*!
Tero Ahola
Minor modifications to properties of abstract, area and bar series
r1462 \property QAbstractSeries::type
The type of the series.
Tero Ahola
qdoc for QChartSeries
r309 */
Tero Ahola
QML methods of series: several fixes and documentation
r1521 /*!
\qmlproperty ChartView.SeriesType AbstractSeries::type
The type of the series.
*/
Tero Ahola
qdoc for QChartSeries
r309
Marek Rosa
Docs updated
r908 /*!
Tero Ahola
Renamed QSeries to QAbstractSeries
r988 \property QAbstractSeries::name
Miikka Heikkinen
Added HTML support for various text items...
r2539 \brief name of the series property. The name is shown in legend for series and supports html formatting.
Tero Ahola
QML methods of series: several fixes and documentation
r1521 */
/*!
\qmlproperty string AbstractSeries::name
Miikka Heikkinen
Added HTML support for various text items...
r2539 Name of the series. The name is shown in legend for series and supports html formatting.
Marek Rosa
Docs updated
r908 */
Jani Honkonen
QAbstractSeries doc update
r1337 /*!
\fn void QAbstractSeries::nameChanged()
This signal is emitted when the series name changes.
Tero Ahola
QML methods of series: several fixes and documentation
r1521 */
/*!
sauimone
qml abstract series doc fix
r1658 \qmlsignal AbstractSeries::onNameChanged()
Tero Ahola
QML methods of series: several fixes and documentation
r1521 This signal is emitted when the series name changes.
Jani Honkonen
QAbstractSeries doc update
r1337 */
Jani Honkonen
Add doc for QSeries title stuff
r414 /*!
Tero Ahola
Documentation for QAbstractSeries
r1343 \property QAbstractSeries::visible
\brief whether the series is visible or not; true by default.
*/
sauimone
qml abstract series doc fix
r1658 /*!
Tero Ahola
QML ChartView signals seriesAdded and seriesRemoved
r2068 \qmlproperty bool AbstractSeries::visible
sauimone
qml abstract series doc fix
r1658 Visibility of the series. True by default.
*/
Jani Honkonen
Add doc for QSeries title stuff
r414
Tero Ahola
Documentation for QAbstractSeries
r1343 /*!
\fn void QAbstractSeries::visibleChanged()
Emitted when the series visibility changes.
Jani Honkonen
Add doc for QSeries title stuff
r414 */
sauimone
qml abstract series doc fix
r1658 /*!
\qmlsignal AbstractSeries::onVisibleChanged()
Emitted when the series visibility changes.
*/
Tero Ahola
QML ChartView signals seriesAdded and seriesRemoved
r2068
/*!
\property QAbstractSeries::opacity
\brief The opacity of the series.
Miikka Heikkinen
Fix some documentation issues...
r2520
Tero Ahola
QML ChartView signals seriesAdded and seriesRemoved
r2068 By default the opacity is 1.0. The valid values range from 0.0 (transparent) to 1.0 (opaque).
*/
/*!
\qmlproperty real AbstractSeries::opacity
The opacity of the series. By default the opacity is 1.0.
The valid values range from 0.0 (transparent) to 1.0 (opaque).
*/
/*!
\fn void QAbstractSeries::opacityChanged()
Emitted when the opacity of the series changes.
*/
/*!
\qmlsignal AbstractSeries::onOpacityChanged()
Emitted when the opacity of the series changes.
*/
Miikka Heikkinen
Accelerating lineseries with OpenGL...
r2820 /*!
\property QAbstractSeries::useOpenGL
\brief Specifies whether or not the series drawing is accelerated with OpenGL.
Drawing series with OpenGL is supported only for QLineSeries and QScatterSeries.
Line series used as edge series for a QAreaSeries cannot use OpenGL acceleration.
When a chart contains any series that are drawn with OpenGL, a transparent QOpenGLWidget
is created on top of the chart plot area. Specified series are not drawn on the underlying
QGraphicsView, but are instead drawn on the created QOpenGLWidget.
Performance gained from using OpenGL to accelerate series drawing depends on the underlying
hardware, but in most cases it is significant. For example, on a standard desktop computer,
enabling OpenGL acceleration for a series typically allows rendering at least hundred times
more points without reduction on the frame rate.
Chart size also has less effect on the frame rate.
The OpenGL acceleration of series drawing is meant for use cases that need fast drawing of
large numbers of points. It is optimized for efficiency, and therefore the series using
it lack support for some features available to non-accelerated series.
There are the following restrictions imposed on charts and series when using OpenGL
acceleration:
\list
\li Series animations are not supported for accelerated series.
\li Antialiasing is not supported for accelerated series.
Miikka Heikkinen
Added some missing restrictions to OpenGL series usage docs...
r2831 \li Point labels are not supported for accelerated series.
Miikka Heikkinen
Accelerating lineseries with OpenGL...
r2820 \li Pen styles and marker shapes are ignored for accelerated series.
Only solid lines and plain scatter dots are supported.
The scatter dots may be circular or rectangular, depending on the underlying graphics
hardware and drivers.
\li Polar charts are not supported for accelerated series.
Miikka Heikkinen
Added some missing restrictions to OpenGL series usage docs...
r2831 \li Mouse events are not supported for accelerated series.
Miikka Heikkinen
Accelerating lineseries with OpenGL...
r2820 \li Since the accelerated series are drawn on top of the entire graphics view, they get drawn
on top of any other graphics items that you may have on top chart in the same scene.
\li To enable QOpenGLWidget to be partially transparent, it needs to be stacked on top of
all other widgets. This means you cannot have other widgets partially covering the
chart.
Miikka Heikkinen
Added some missing restrictions to OpenGL series usage docs...
r2831 \li Enabling chart drop shadow is not recommended when using accelerated series,
as that can slow the frame rate down significantly.
Miikka Heikkinen
Accelerating lineseries with OpenGL...
r2820 \endlist
The default value is \c{false}.
*/
/*!
\qmlproperty bool AbstractSeries::useOpenGL
Specifies whether or not the series is drawn with OpenGL.
Drawing series with OpenGL is supported only for LineSeries and ScatterSeries.
For more details, see QAbstractSeries::useOpenGL documentation. QML applications have similar
restrictions as those listed in QAbstractSeries::useOpenGL documentation,
except there is no restriction about covering the ChartView partially with other
items due to different rendering mechanism.
The default value is \c{false}.
*/
/*!
\fn void QAbstractSeries::useOpenGLChanged()
Emitted when the useOpenGL property value changes.
*/
/*!
\qmlsignal AbstractSeries::onUseOpenGLChanged()
Emitted when the useOpenGL property value changes.
*/
Jani Honkonen
Add doc for QSeries title stuff
r414 /*!
Tero Ahola
Updated documentation, warnings from legend and area left
r973 \internal
Miikka Heikkinen
Documentation updates...
r2494 \brief Constructs QAbstractSeries object with \a parent.
Jani Honkonen
Add doc for QSeries title stuff
r414 */
Tero Ahola
Renamed QSeries to QAbstractSeries
r988 QAbstractSeries::QAbstractSeries(QAbstractSeriesPrivate &d, QObject *parent) :
Tero Ahola
Updated documentation, warnings from legend and area left
r973 QObject(parent),
d_ptr(&d)
Michal Klocek
Adds big fat pimpl to series classes...
r938 {
}
Tero Ahola
Updated documentation, warnings from legend and area left
r973 /*!
\brief Virtual destructor for the chart series.
*/
Tero Ahola
Renamed QSeries to QAbstractSeries
r988 QAbstractSeries::~QAbstractSeries()
Michal Klocek
Adds big fat pimpl to series classes...
r938 {
Michal Klocek
Refactors internals...
r2273 if (d_ptr->m_chart)
Miikka Heikkinen
Documentation updates...
r2494 qFatal("Series still bound to a chart when destroyed!");
Michal Klocek
Adds big fat pimpl to series classes...
r938 }
Jani Honkonen
more coding style fixes for src-folder...
r2104 void QAbstractSeries::setName(const QString &name)
Michal Klocek
Adds big fat pimpl to series classes...
r938 {
Tero Ahola
Fixed a bug with legend not updating series labels
r1328 if (name != d_ptr->m_name) {
d_ptr->m_name = name;
Tero Ahola
Visible property to abstract series
r1342 emit nameChanged();
Tero Ahola
Fixed a bug with legend not updating series labels
r1328 }
Michal Klocek
Adds big fat pimpl to series classes...
r938 }
Tero Ahola
Renamed QSeries to QAbstractSeries
r988 QString QAbstractSeries::name() const
Michal Klocek
Adds big fat pimpl to series classes...
r938 {
return d_ptr->m_name;
}
Tero Ahola
Visible property to abstract series
r1342 void QAbstractSeries::setVisible(bool visible)
{
if (visible != d_ptr->m_visible) {
d_ptr->m_visible = visible;
emit visibleChanged();
}
}
bool QAbstractSeries::isVisible() const
{
return d_ptr->m_visible;
}
Tero Ahola
Added opacity property to QAbstractSeries
r2067 qreal QAbstractSeries::opacity() const
{
return d_ptr->m_opacity;
}
void QAbstractSeries::setOpacity(qreal opacity)
{
if (opacity != d_ptr->m_opacity) {
d_ptr->m_opacity = opacity;
emit opacityChanged();
}
}
Miikka Heikkinen
Accelerating lineseries with OpenGL...
r2820 void QAbstractSeries::setUseOpenGL(bool enable)
{
#ifdef QT_NO_OPENGL
Q_UNUSED(enable)
#else
bool polarChart = d_ptr->m_chart && d_ptr->m_chart->chartType() == QChart::ChartTypePolar;
bool supportedSeries = (type() == SeriesTypeLine || type() == SeriesTypeScatter);
if ((!enable || !d_ptr->m_blockOpenGL)
&& supportedSeries
&& enable != d_ptr->m_useOpenGL
&& (!enable || !polarChart)) {
d_ptr->m_useOpenGL = enable;
emit useOpenGLChanged();
}
#endif
}
bool QAbstractSeries::useOpenGL() const
{
return d_ptr->m_useOpenGL;
}
Jani Honkonen
Implemented QAbstractSeries::chart()...
r1314 /*!
\brief Returns the chart where series belongs to.
Set automatically when the series is added to the chart
and unset when the series is removed from the chart.
*/
Jani Honkonen
more coding style fixes for src-folder...
r2104 QChart *QAbstractSeries::chart() const
Jani Honkonen
Implemented QAbstractSeries::chart()...
r1314 {
return d_ptr->m_chart;
}
Marek Rosa
Various docs fixes
r1638 /*!
Miikka Heikkinen
Fix some documentation issues...
r2520 \brief Sets the visibility of the series to true.
Marek Rosa
Various docs fixes
r1638
\sa setVisible(), isVisible()
*/
Michal Klocek
Changes to qchart qabstractseries API
r1553 void QAbstractSeries::show()
{
setVisible(true);
}
Marek Rosa
Various docs fixes
r1638 /*!
Miikka Heikkinen
Fix some documentation issues...
r2520 \brief Sets the visibility of the series to false.
Marek Rosa
Various docs fixes
r1638
\sa setVisible(), isVisible()
*/
Michal Klocek
Changes to qchart qabstractseries API
r1553 void QAbstractSeries::hide()
{
setVisible(false);
}
Tero Ahola
Documented QAbstractSeries axis handling
r2363 /*!
Attach \a axis to the series.
\return true if the axis was attached successfully, false otherwise.
Miikka Heikkinen
Readme up to date for 1.3.0, and some minor doc fixes...
r2571 \note If multiple axes of same orientation are attached to same series,
they will have same min/max ranges.
Tero Ahola
Documented QAbstractSeries axis handling
r2363 \sa QChart::addAxis(), QChart::createDefaultAxes()
*/
Michal Klocek
Refactors internals...
r2273 bool QAbstractSeries::attachAxis(QAbstractAxis* axis)
{
if(d_ptr->m_chart) {
Tero Ahola
Documented QAbstractSeries axis handling
r2363 return d_ptr->m_chart->d_ptr->m_dataset->attachAxis(this, axis);
Michal Klocek
Refactors internals...
r2273 } else {
qWarning()<<"Series not in the chart. Please addSeries to chart first.";
return false;
}
}
Tero Ahola
Documented QAbstractSeries axis handling
r2363 /*!
Detach \a axis from the series.
\return true if the axis was detached successfully, false otherwise.
\sa QChart::removeAxis()
*/
Michal Klocek
Refactors internals...
r2273 bool QAbstractSeries::detachAxis(QAbstractAxis* axis)
{
if(d_ptr->m_chart) {
Tero Ahola
Documented QAbstractSeries axis handling
r2363 return d_ptr->m_chart->d_ptr->m_dataset->detachAxis(this, axis);
Michal Klocek
Refactors internals...
r2273 }
else {
qWarning()<<"Series not in the chart. Please addSeries to chart first.";
return false;
}
}
Tero Ahola
Documented QAbstractSeries axis handling
r2363 /*!
Returns the list of axes attached to the series. Usually there is an x-axis and a y-axis attached to a series, except
in case of a QPieSeries, which does not have any axes attached.
\sa attachAxis(), detachAxis()
*/
Michal Klocek
Refactors internals...
r2273 QList<QAbstractAxis*> QAbstractSeries::attachedAxes()
{
return d_ptr->m_axes;
}
Michal Klocek
Adds big fat pimpl to series classes...
r938 ///////////////////////////////////////////////////////////////////////////////////////////////////
Jani Honkonen
more coding style fixes for src-folder...
r2104 QAbstractSeriesPrivate::QAbstractSeriesPrivate(QAbstractSeries *q)
Jani Honkonen
astyle and manual coding style fixes for src-folder
r2097 : q_ptr(q),
m_chart(0),
Michal Klocek
Refactors internals...
r2273 m_item(0),
Marek Rosa
Domains added
r2275 m_domain(new XYDomain()),
Jani Honkonen
astyle and manual coding style fixes for src-folder
r2097 m_visible(true),
Miikka Heikkinen
Accelerating lineseries with OpenGL...
r2820 m_opacity(1.0),
m_useOpenGL(false),
m_blockOpenGL(false)
Michal Klocek
Adds big fat pimpl to series classes...
r938 {
}
Tero Ahola
Renamed QSeries to QAbstractSeries
r988 QAbstractSeriesPrivate::~QAbstractSeriesPrivate()
Michal Klocek
Adds big fat pimpl to series classes...
r938 {
}
Michal Klocek
Domain not sharable again
r2285 void QAbstractSeriesPrivate::setDomain(AbstractDomain* domain)
Michal Klocek
Refactors internals...
r2273 {
Michal Klocek
Domain not sharable again
r2285 Q_ASSERT(domain);
if(m_domain.data()!=domain) {
Michal Klocek
Refactors internals...
r2273 if(!m_item.isNull()) QObject::disconnect(m_domain.data(), SIGNAL(updated()), m_item.data(), SLOT(handleDomainUpdated()));
Michal Klocek
Domain not sharable again
r2285 m_domain.reset(domain);
Michal Klocek
Refactors internals...
r2273 if(!m_item.isNull()) {
QObject::connect(m_domain.data(), SIGNAL(updated()),m_item.data(), SLOT(handleDomainUpdated()));
m_item->handleDomainUpdated();
}
}
}
Miikka Heikkinen
Added QChart::localizeNumbers...
r2707 void QAbstractSeriesPrivate::setPresenter(ChartPresenter *presenter)
{
m_presenter = presenter;
}
ChartPresenter *QAbstractSeriesPrivate::presenter() const
{
return m_presenter;
}
Michal Klocek
Refactors internals...
r2273 void QAbstractSeriesPrivate::initializeGraphics(QGraphicsItem* parent)
{
Q_ASSERT(!m_item.isNull());
Q_UNUSED(parent);
QObject::connect(m_domain.data(), SIGNAL(updated()),m_item.data(), SLOT(handleDomainUpdated()));
}
Titta Heikkala
Added possibility to set duration and easing curve for chart animation...
r2804 void QAbstractSeriesPrivate::initializeAnimations(QChart::AnimationOptions options, int duration,
QEasingCurve &curve)
Michal Klocek
Refactors internals...
r2273 {
Q_UNUSED(options);
Titta Heikkala
Added possibility to set duration and easing curve for chart animation...
r2804 Q_UNUSED(duration);
Q_UNUSED(curve);
Michal Klocek
Refactors internals...
r2273 }
Titta Heikkala
Add possibility to set reverse values to axes...
r2781 bool QAbstractSeriesPrivate::reverseXAxis()
{
bool reverseXAxis = false;
if (m_axes.size() != 0 && !(m_chart->chartType() == QChart::ChartTypePolar)) {
int i = 0;
while (i < m_axes.size()) {
if (m_axes.at(i)->orientation() == Qt::Horizontal && m_axes.at(i)->isReverse()) {
reverseXAxis = true;
break;
}
i++;
}
}
return reverseXAxis;
}
bool QAbstractSeriesPrivate::reverseYAxis()
{
bool reverseYAxis = false;
if (m_axes.size() != 0 && !(m_chart->chartType() == QChart::ChartTypePolar)) {
int i = 0;
while (i < m_axes.size()) {
if (m_axes.at(i)->orientation() == Qt::Vertical && m_axes.at(i)->isReverse()) {
reverseYAxis = true;
break;
}
i++;
}
}
return reverseYAxis;
}
Miikka Heikkinen
Accelerating lineseries with OpenGL...
r2820 // This function can be used to explicitly block OpenGL use from some otherwise supported series,
// such as the line series used as edge series of an area series.
void QAbstractSeriesPrivate::setBlockOpenGL(bool enable)
{
m_blockOpenGL = enable;
if (enable)
q_ptr->setUseOpenGL(false);
}
Tero Ahola
Renamed QSeries to QAbstractSeries
r988 #include "moc_qabstractseries.cpp"
#include "moc_qabstractseries_p.cpp"
Michal Klocek
Adds big fat pimpl to series classes...
r938
Titta Heikkala
Qt Charts project file structure change...
r2712 QT_CHARTS_END_NAMESPACE
Michal Klocek
Adds big fat pimpl to series classes...
r938