diff options
author | Tomi Korpipää <tomi.korpipaa@digia.com> | 2013-09-10 13:21:07 +0300 |
---|---|---|
committer | Tomi Korpipää <tomi.korpipaa@digia.com> | 2013-09-10 13:34:43 +0300 |
commit | 83ac130c30d7452a35f253c7014563fef2683257 (patch) | |
tree | 1c5dee24556541622d0875a7014e7fd5cc201178 /src/datavisualization/data/qsurfacedataproxy.cpp | |
parent | 5dd76812391e4dc8851b1414ca6edc9c29301944 (diff) |
Doc update
Task-number: QTRD-2133
+ bug fixes to existing, skeletons to surface
Change-Id: Ic92294f141435972b2c10a147bab13897ed37f53
Change-Id: Ic92294f141435972b2c10a147bab13897ed37f53
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@digia.com>
Diffstat (limited to 'src/datavisualization/data/qsurfacedataproxy.cpp')
-rw-r--r-- | src/datavisualization/data/qsurfacedataproxy.cpp | 45 |
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 // |