summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/data/qsurfacedataproxy.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/datavisualization/data/qsurfacedataproxy.cpp')
-rw-r--r--src/datavisualization/data/qsurfacedataproxy.cpp45
1 files changed, 45 insertions, 0 deletions
diff --git a/src/datavisualization/data/qsurfacedataproxy.cpp b/src/datavisualization/data/qsurfacedataproxy.cpp
index 9fcc4bc8..2bf8af8b 100644
--- a/src/datavisualization/data/qsurfacedataproxy.cpp
+++ b/src/datavisualization/data/qsurfacedataproxy.cpp
@@ -22,6 +22,16 @@
QT_DATAVISUALIZATION_BEGIN_NAMESPACE
/*!
+ * \class QSurfaceDataProxy
+ * \inmodule QtDataVisualization
+ * \brief Proxy class for Q3DSurface.
+ * \since 1.0.0
+ *
+ * DOCUMENTATION GOES HERE
+ *
+ */
+
+/*!
* Constructs QSurfaceDataProxy with the given \a parent.
*/
QSurfaceDataProxy::QSurfaceDataProxy(QObject *parent) :
@@ -44,32 +54,67 @@ QSurfaceDataProxy::~QSurfaceDataProxy()
{
}
+/*!
+ * Clears the existing array and takes ownership of the \a newArray. Do not use \a newArray pointer
+ * to further modify data after QSurfaceDataProxy assumes ownership of it, as such modifications will
+ * not trigger proper signals.
+ * Passing null array clears all data.
+ */
void QSurfaceDataProxy::resetArray(QSurfaceDataArray *newArray)
{
if (dptr()->resetArray(newArray))
emit arrayReset();
}
+/*!
+ * \return pointer to the data array.
+ */
const QSurfaceDataArray *QSurfaceDataProxy::array() const
{
return dptrc()->m_dataArray;
}
+/*!
+ * \property QSurfaceDataProxy::itemCount
+ *
+ * \return item count in the array.
+ */
+int QSurfaceDataProxy::itemCount() const
+{
+ return dptrc()->m_dataArray->size();
+}
+
+/*!
+ * \return pointer to the item at \a index. It is guaranteed to be valid only until next call that
+ * modifies data.
+ */
const QSurfaceDataItem *QSurfaceDataProxy::itemAt(int index) const
{
return &dptrc()->m_dataArray->at(index)->at(2);
}
+/*!
+ * \internal
+ */
QSurfaceDataProxyPrivate *QSurfaceDataProxy::dptr()
{
return static_cast<QSurfaceDataProxyPrivate *>(d_ptr.data());
}
+/*!
+ * \internal
+ */
const QSurfaceDataProxyPrivate *QSurfaceDataProxy::dptrc() const
{
return static_cast<const QSurfaceDataProxyPrivate *>(d_ptr.data());
}
+/*!
+ * \fn void QSurfaceDataProxy::arrayReset()
+ *
+ * Emitted when data array is reset.
+ */
+
//
// QSurfaceDataProxyPrivate
//