summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/doc
diff options
context:
space:
mode:
Diffstat (limited to 'src/datavisualization/doc')
-rw-r--r--src/datavisualization/doc/images/q3dbars-minimal.pngbin0 -> 8611 bytes
-rw-r--r--src/datavisualization/doc/images/q3dscatter-minimal.pngbin0 -> 7998 bytes
-rw-r--r--src/datavisualization/doc/qtdatavisualization.qdocconf33
-rw-r--r--src/datavisualization/doc/snippets/doc_src_q3dbars_construction.cpp41
-rw-r--r--src/datavisualization/doc/snippets/doc_src_q3dscatter_construction.cpp40
-rw-r--r--src/datavisualization/doc/snippets/doc_src_qtdatavisualization.cpp69
-rw-r--r--src/datavisualization/doc/snippets/doc_src_qtdatavisualization.pro21
-rw-r--r--src/datavisualization/doc/src/qtdatavisualization-index.qdoc60
-rw-r--r--src/datavisualization/doc/src/qtdatavisualization.qdoc26
-rw-r--r--src/datavisualization/doc/src/qtdatavisualizationlicense.qdoc37
10 files changed, 327 insertions, 0 deletions
diff --git a/src/datavisualization/doc/images/q3dbars-minimal.png b/src/datavisualization/doc/images/q3dbars-minimal.png
new file mode 100644
index 00000000..fff8d415
--- /dev/null
+++ b/src/datavisualization/doc/images/q3dbars-minimal.png
Binary files differ
diff --git a/src/datavisualization/doc/images/q3dscatter-minimal.png b/src/datavisualization/doc/images/q3dscatter-minimal.png
new file mode 100644
index 00000000..1c3290b3
--- /dev/null
+++ b/src/datavisualization/doc/images/q3dscatter-minimal.png
Binary files differ
diff --git a/src/datavisualization/doc/qtdatavisualization.qdocconf b/src/datavisualization/doc/qtdatavisualization.qdocconf
new file mode 100644
index 00000000..016fbe0c
--- /dev/null
+++ b/src/datavisualization/doc/qtdatavisualization.qdocconf
@@ -0,0 +1,33 @@
+include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
+
+project = QtDataVisualization
+description = Qt Data Visualization Reference Documentation
+version = 1.0.0
+
+exampledirs += ../../../examples \
+ snippets
+
+headerdirs += ..
+imagedirs += ../images \
+ images
+sourcedirs += ..
+
+depends += qtcore \
+ qtgui
+
+qhp.projects = qtdatavisualization
+
+qhp.qtdatavisualization.file = qtdatavisualization.qhp
+qhp.qtdatavisualization.namespace = org.qt-project.qtdatavisualization.1.0.0
+qhp.qtdatavisualization.virtualFolder = qtdatavisualization
+qhp.qtdatavisualization.indexTitle = Qt Data Visualization
+qhp.qtdatavisualization.indexRoot =
+
+qhp.qtdatavisualization.filterAttributes = qtdatavisualization 1.0.0 qtrefdoc
+qhp.qtdatavisualization.customFilters.Qt.name = QtDataVisualization 1.0.0
+qhp.qtdatavisualization.customFilters.Qt.filterAttributes = qtdatavisualization 1.0.0
+qhp.qtdatavisualization.subprojects = classes
+qhp.qtdatavisualization.subprojects.classes.title = C++ Classes
+qhp.qtdatavisualization.subprojects.classes.indexTitle = Qt Data Visualization C++ Classes
+qhp.qtdatavisualization.subprojects.classes.selectors = class fake:headerfile
+qhp.qtdatavisualization.subprojects.classes.sortPages = true
diff --git a/src/datavisualization/doc/snippets/doc_src_q3dbars_construction.cpp b/src/datavisualization/doc/snippets/doc_src_q3dbars_construction.cpp
new file mode 100644
index 00000000..85f2d7b4
--- /dev/null
+++ b/src/datavisualization/doc/snippets/doc_src_q3dbars_construction.cpp
@@ -0,0 +1,41 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc
+** All rights reserved.
+** For any questions to Digia, please use contact form at http://qt.digia.com
+**
+** This file is part of the QtDataVisualization module.
+**
+** Licensees holding valid Qt Enterprise licenses may use this file in
+** accordance with the Qt Enterprise License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.
+**
+** If you have questions regarding the use of this file, please use
+** contact form at http://qt.digia.com
+**
+****************************************************************************/
+
+//! [3]
+#include <QtDataVisualization>
+
+int main(int argc, char **argv)
+{
+ QGuiApplication app(argc, argv);
+
+ //! [0]
+ Q3DBars *bars = new Q3DBars();
+ bars->setDataWindow(5, 5);
+ //! [0]
+ //! [1]
+ QBarDataRow data;
+ data << 1.0 << 3.0 << 7.5 << 5.0 << 2.2;
+ bars->dataProxy()->addRow(&data);
+ //! [1]
+ //! [2]
+ bars->show();
+ //! [2]
+
+ return app.exec();
+}
+//! [3]
diff --git a/src/datavisualization/doc/snippets/doc_src_q3dscatter_construction.cpp b/src/datavisualization/doc/snippets/doc_src_q3dscatter_construction.cpp
new file mode 100644
index 00000000..deac1715
--- /dev/null
+++ b/src/datavisualization/doc/snippets/doc_src_q3dscatter_construction.cpp
@@ -0,0 +1,40 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc
+** All rights reserved.
+** For any questions to Digia, please use contact form at http://qt.digia.com
+**
+** This file is part of the QtDataVisualization module.
+**
+** Licensees holding valid Qt Enterprise licenses may use this file in
+** accordance with the Qt Enterprise License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.
+**
+** If you have questions regarding the use of this file, please use
+** contact form at http://qt.digia.com
+**
+****************************************************************************/
+
+//! [3]
+#include <QtDataVisualization>
+
+int main(int argc, char **argv)
+{
+ QGuiApplication app(argc, argv);
+
+ //! [0]
+ Q3DScatter *scatter = new Q3DScatter();
+ //! [0]
+ //! [1]
+ QScatterDataArray data;
+ data << QVector3D(1.0f, 0.5f, 1.0f) << QVector3D(-1.0f, -0.5f, -1.0f) << QVector3D(0.5f, 0.0f, 0.0f);
+ scatter->dataProxy()->addItems(data);
+ //! [1]
+ //! [2]
+ scatter->show();
+ //! [2]
+
+ return app.exec();
+}
+//! [3]
diff --git a/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.cpp b/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.cpp
new file mode 100644
index 00000000..f4df32d5
--- /dev/null
+++ b/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.cpp
@@ -0,0 +1,69 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc
+** All rights reserved.
+** For any questions to Digia, please use contact form at http://qt.digia.com
+**
+** This file is part of the QtDataVisualization module.
+**
+** Licensees holding valid Qt Enterprise licenses may use this file in
+** accordance with the Qt Enterprise License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.
+**
+** If you have questions regarding the use of this file, please use
+** contact form at http://qt.digia.com
+**
+****************************************************************************/
+
+//! [0]
+#include <QtDataVisualization>
+//! [0]
+
+//! [1]
+proxy->setItemLabelFormat(QStringLiteral("@valueTitle for (@rowLabel, @colLabel): %.1f"));
+//! [1]
+
+//! [2]
+proxy->setItemLabelFormat(QStringLiteral("@xTitle: @xValue, @yTitle: @yValue, @zTitle: @zValue"));
+//! [2]
+
+//! [3]
+// By defining row and column categories, you tell the mapping which row and column each item
+// belongs to. The categories must match the data stored in the model in the roles you define
+// for row and column mapping. In this example we expect "year" role to return four digit year
+// and "month" to return three letter designation for the month.
+//
+// An example of an item in model would be:
+// Requested role -> Returned data
+// "year" -> "2006" // Matches the first row category, so this item is added to the first row.
+// "month" -> "jan" // Matches the first column category, so this item is added as first item in the row.
+// "income" -> "12.1"
+// "expenses" -> "9.2"
+QStringList years;
+QStringList months;
+years << "2006" << "2007" << "2008" << "2009" << "2010" << "2011" << "2012";
+months << "jan" << "feb" << "mar" << "apr" << "may" << "jun" << "jul" << "aug" << "sep" << "oct" << "nov" << "dec";
+
+QItemModelBarDataMapping *mapping = new QItemModelBarDataMapping(QStringLiteral("year"), // Row role
+ QStringLiteral("month"), // Column role
+ QStringLiteral("income"), // Value role
+ years, // Row categories
+ months); // Column categories
+
+QItemModelBarDataProxy *proxy = new QItemModelBarDataProxy(customModel, mapping);
+
+//...
+
+// To display different data later, you can simply change the mapping of the current
+// mapping object, or set another mapping object.
+proxy->activeMapping()->setValueRole(QStringLiteral("expenses"));
+//! [3]
+
+//! [4]
+// Map "density" value to X-axis, "hardness" to Y-axis and "conductivity" to Z-axis.
+QItemModelScatterDataMapping *mapping = new QItemModelScatterDataMapping(QStringLiteral("density"),
+ QStringLiteral("hardness"),
+ QStringLiteral("conductivity"))
+QItemModelScatterDataProxy *proxy = new QItemModelScatterDataProxy(customModel, mapping);
+//! [4]
diff --git a/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.pro b/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.pro
new file mode 100644
index 00000000..81555f88
--- /dev/null
+++ b/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.pro
@@ -0,0 +1,21 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc
+** All rights reserved.
+** For any questions to Digia, please use contact form at http://qt.digia.com
+**
+** This file is part of the QtDataVisualization module.
+**
+** Licensees holding valid Qt Enterprise licenses may use this file in
+** accordance with the Qt Enterprise License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.
+**
+** If you have questions regarding the use of this file, please use
+** contact form at http://qt.digia.com
+**
+****************************************************************************/
+
+#! [0]
+QT += datavisualization
+#! [0]
diff --git a/src/datavisualization/doc/src/qtdatavisualization-index.qdoc b/src/datavisualization/doc/src/qtdatavisualization-index.qdoc
new file mode 100644
index 00000000..d3afaf3b
--- /dev/null
+++ b/src/datavisualization/doc/src/qtdatavisualization-index.qdoc
@@ -0,0 +1,60 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc
+** All rights reserved.
+** For any questions to Digia, please use contact form at http://qt.digia.com
+**
+** This file is part of the QtDataVisualization module.
+**
+** Licensees holding valid Qt Enterprise licenses may use this file in
+** accordance with the Qt Enterprise License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.
+**
+** If you have questions regarding the use of this file, please use
+** contact form at http://qt.digia.com
+**
+****************************************************************************/
+
+/*!
+ \title Qt Data Visualization
+ \page qtdatavisualization-index.html
+ \brief QtDataVisualization module provides functionality for 3D visualization.
+
+ Qt Data Visualization module provides a way to visualize data in 3D.
+ It uses OpneGL for the data rendering.
+
+ \section1 Getting Started
+
+ Qt Data Visualization provides classes for rendering 3D data. To include
+ the definitions of the module's classes, use the following directive:
+
+ \snippet doc_src_qtdatavisualization.cpp 0
+
+ To link against the module, add this line to your qmake \c
+ .pro file:
+
+ \snippet doc_src_qtdatavisualization.pro 0
+
+ \section1 Articles
+ \list
+ \li \l{Qt Data Visualization License Information}{License Information}
+ \endlist
+
+ \section1 References
+ \list
+ \li \l{Qt Data Visualization C++ Classes}
+ \endlist
+
+ Qt Data Visualization comes with the following examples:
+
+ \list
+ \li \l{Barchart Example}
+ \li \l{Qt Quick 2 Barchart Example}
+ \li \l{Qt Quick 2 Scatter Example}
+ \li \l{Rainfall Example}
+ \li \l{Scatter Chart Example}
+ \li \l{Audiolevels Example}
+ \li \l{Widget Example}
+ \endlist
+*/
diff --git a/src/datavisualization/doc/src/qtdatavisualization.qdoc b/src/datavisualization/doc/src/qtdatavisualization.qdoc
new file mode 100644
index 00000000..5ddd0720
--- /dev/null
+++ b/src/datavisualization/doc/src/qtdatavisualization.qdoc
@@ -0,0 +1,26 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc
+** All rights reserved.
+** For any questions to Digia, please use contact form at http://qt.digia.com
+**
+** This file is part of the QtDataVisualization module.
+**
+** Licensees holding valid Qt Enterprise licenses may use this file in
+** accordance with the Qt Enterprise License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.
+**
+** If you have questions regarding the use of this file, please use
+** contact form at http://qt.digia.com
+**
+****************************************************************************/
+
+/*!
+ \module QtDataVisualization
+ \title Qt Data Visualization C++ Classes
+ \ingroup modules
+
+ \brief The QtDataVisualization module provides functionality for 3D visualization.
+*/
+
diff --git a/src/datavisualization/doc/src/qtdatavisualizationlicense.qdoc b/src/datavisualization/doc/src/qtdatavisualizationlicense.qdoc
new file mode 100644
index 00000000..16c1ed70
--- /dev/null
+++ b/src/datavisualization/doc/src/qtdatavisualizationlicense.qdoc
@@ -0,0 +1,37 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc
+** All rights reserved.
+** For any questions to Digia, please use contact form at http://qt.digia.com
+**
+** This file is part of the QtDataVisualization module.
+**
+** Licensees holding valid Qt Enterprise licenses may use this file in
+** accordance with the Qt Enterprise License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.
+**
+** If you have questions regarding the use of this file, please use
+** contact form at http://qt.digia.com
+**
+****************************************************************************/
+
+/*!
+ \page qtdatavisualizationlicense.html
+ \title Qt Data Visualization License Information
+ \ingroup licensing
+ \brief License information for Qt Data Visualization
+
+ \legalese
+ Copyright 2013 Digia.
+
+ Qt and Qt logos are trademarks of of Digia Corporation in Finland and/or other countries
+ worldwide.
+
+ All other trademarks are property of their respective owners.
+
+ Licensees holding valid Qt Enterprise licenses may use this document in accordance with the
+ Qt Enterprise License Agreement provided with the Software or, alternatively, in accordance
+ with the terms contained in a written agreement between you and Digia.
+ \endlegalese
+*/