summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/doc/src
diff options
context:
space:
mode:
authorTomi Korpipää <tomi.korpipaa@digia.com>2014-05-12 10:06:27 +0300
committerTomi Korpipää <tomi.korpipaa@digia.com>2014-05-12 10:07:15 +0300
commit6880277f23b47117f7788f08f855ed99b5120f9f (patch)
treede8b9e64ffce03a3ce77c8ffac396f7174e91956 /src/datavisualization/doc/src
parent590d11726e0708e9f8fad0ec386cc5859dbe5cc8 (diff)
CustomDataItem made into a public class
Task-number: QTRD-3055 Change-Id: I1e449df7c1bcb48fc639dbae579e2e1499c9ef2b Reviewed-by: Tomi Korpipää <tomi.korpipaa@digia.com>
Diffstat (limited to 'src/datavisualization/doc/src')
-rw-r--r--src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc33
1 files changed, 15 insertions, 18 deletions
diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc
index 36c812f1..4d0b8212 100644
--- a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc
+++ b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc
@@ -150,30 +150,30 @@
*/
/*!
- * \qmlmethod int AbstractGraph3D::addCustomItem(string meshFile, vector3d position, vector3d scaling, quaternion rotation, string textureFile)
+ * \qmlmethod int AbstractGraph3D::addCustomItem(Custom3DItem item)
*
- * Adds a custom mesh item located in \a meshFile to a graph at \a position with \a {scaling},
- * \a rotation and optional image for a texture located at \a textureFile. Item must be in
- * Wavefront obj format and include vertices, normals and UVs. It also needs to be in triangles.
- * Item position is given in data coordinates.
+ * Adds a Custom3DItem \a item to the graph. Graph takes ownership of the added item.
*
- * \return index to the added item.
+ * \return index to the added item if add was successful, -1 if trying to add a null item, and
+ * index of the item if trying to add an already added item.
*
- * \note No validity checks are made for the position of the item, so it is up to the user to
- * provide a valid position. Items positioned outside axis ranges are still rendered.
- *
- * \sa removeCustomItemAt()
+ * \sa removeCustomItems(), removeCustomItem(), removeCustomItemAt()
*
* \since Qt Data Visualization 1.1
*/
/*!
- * \qmlmethod void AbstractGraph3D::removeCustomItemAt(int index)
+ * \qmlmethod void AbstractGraph3D::removeCustomItems()
*
- * Removes the custom item at \a {index}. Deletes the resources allocated to it.
+ * Removes all custom items. Deletes the resources allocated to them.
*
- * \note The index of the remaining items will change if the item removed is other than
- * the last.
+ * \since Qt Data Visualization 1.1
+ */
+
+/*!
+ * \qmlmethod void AbstractGraph3D::removeCustomItem(Custom3DItem item)
+ *
+ * Removes the custom \a {item}. Deletes the resources allocated to it.
*
* \since Qt Data Visualization 1.1
*/
@@ -181,10 +181,7 @@
/*!
* \qmlmethod void AbstractGraph3D::removeCustomItemAt(vector3d position)
*
- * Removes the custom item at \a {position}. Deletes the resources allocated to it.
- *
- * \note The index of the remaining items will change if an item is removed from a position that
- * is not at the last index.
+ * Removes all custom items at \a {position}. Deletes the resources allocated to them.
*
* \since Qt Data Visualization 1.1
*/