diff options
| author | Miikka Heikkinen <miikka.heikkinen@qt.io> | 2016-09-01 12:50:40 +0300 |
|---|---|---|
| committer | Paul Lemire <paul.lemire@kdab.com> | 2016-09-02 06:15:46 +0000 |
| commit | 78e8f5ac9ace0701682723551cd2a70f47967168 (patch) | |
| tree | d7d73c9d2c0a812f6f41c3b11b0dcffd6440cac5 /src/extras/geometries/qplanegeometry.cpp | |
| parent | ce1db34bf273c397bb7b4be182f274547c35ea3e (diff) | |
Update mesh and geometry documentation
Meshes and geometries that were moved to Qt3DExtras were still
part of Qt3DRender according to the documentation.
Also added some missing documentation and a few clarifications.
Change-Id: I62216d718758b9f6b82df2ccc060b3c1e91b9ad4
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
Reviewed-by: Antti Määttä <antti.maatta@qt.io>
Diffstat (limited to 'src/extras/geometries/qplanegeometry.cpp')
| -rw-r--r-- | src/extras/geometries/qplanegeometry.cpp | 27 |
1 files changed, 18 insertions, 9 deletions
diff --git a/src/extras/geometries/qplanegeometry.cpp b/src/extras/geometries/qplanegeometry.cpp index 59ed9ee21..b7395b67e 100644 --- a/src/extras/geometries/qplanegeometry.cpp +++ b/src/extras/geometries/qplanegeometry.cpp @@ -208,18 +208,22 @@ public: /*! * \qmltype PlaneGeometry - * \instantiates Qt3DRender::QPlaneGeometry - * \inqmlmodule Qt3D.Render + * \instantiates Qt3DExtras::QPlaneGeometry + * \inqmlmodule Qt3D.Extras + * \brief PlaneGeometry allows creation of a plane in 3D space. + * + * The PlaneGeometry type is most commonly used internally by the PlaneMesh type + * but can also be used in custom GeometryRenderer types. */ /*! - * \qmlproperty float PlaneGeometry::width + * \qmlproperty real PlaneGeometry::width * * Holds the plane width. */ /*! - * \qmlproperty float PlaneGeometry::height + * \qmlproperty real PlaneGeometry::height * * Holds the plane height. */ @@ -261,10 +265,15 @@ public: */ /*! - * \class Qt3DRender::QPlaneGeometry - * \inmodule Qt3DRender - * + * \class Qt3DExtras::QPlaneGeometry + * \inmodule Qt3DExtras + * \brief The QPlaneGeometry class allows creation of a plane in 3D space. + * \since 5.7 + * \ingroup geometries * \inherits Qt3DRender::QGeometry + * + * The QPlaneGeometry class is most commonly used internally by the QPlaneMesh + * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses. */ /*! @@ -295,7 +304,7 @@ QPlaneGeometry::~QPlaneGeometry() } /*! - * Updates vertices based on resolution. + * Updates vertices based on mesh resolution, width, and height properties. */ void QPlaneGeometry::updateVertices() { @@ -310,7 +319,7 @@ void QPlaneGeometry::updateVertices() } /*! - * Updates indices based on resolution. + * Updates indices based on mesh resolution. */ void QPlaneGeometry::updateIndices() { |