diff options
| author | Mike Krus <mike.krus@kdab.com> | 2017-02-05 17:41:50 +0000 |
|---|---|---|
| committer | Sean Harmer <sean.harmer@kdab.com> | 2017-02-06 20:33:16 +0000 |
| commit | 1150383da5f55b44d6101f086cca310fa94db6a5 (patch) | |
| tree | e0a472ae74ba64d4d94b06fd25ad5f3b757812af /src/render/geometry/qmesh.cpp | |
| parent | 3f649fd039369ec14a348bc424eac75a315e6dd6 (diff) | |
Improve documentation for QMesh
Also use QRegularExpression instead of the older QRegEx
in the obj loader
Change-Id: I031f98a718d81e9baeba7aeb6e3482bb22d5643f
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
Diffstat (limited to 'src/render/geometry/qmesh.cpp')
| -rw-r--r-- | src/render/geometry/qmesh.cpp | 31 |
1 files changed, 28 insertions, 3 deletions
diff --git a/src/render/geometry/qmesh.cpp b/src/render/geometry/qmesh.cpp index 2d9bb54b4..3305fc915 100644 --- a/src/render/geometry/qmesh.cpp +++ b/src/render/geometry/qmesh.cpp @@ -68,7 +68,12 @@ QMeshPrivate::QMeshPrivate() * \qmltype Mesh * \instantiates Qt3DRender::QMesh * \inqmlmodule Qt3D.Render - * \brief A custom mesh. + * \brief A custom mesh loader. + * + * Loads mesh data from external files in a variety of formats. + * + * In Qt3D 5.9, Mesh supports the following formats: Wavefront OBJ, Stanford Triangle Format PLY, STL (STereoLithography). + * QMesh will also support Autodesk FBX files if the SDK is installed and the fbx geometry loader plugin is built and found. */ /*! @@ -80,7 +85,17 @@ QMeshPrivate::QMeshPrivate() /*! * \qmlproperty string Mesh::meshName * - * Holds the name of the mesh. + * Filter indicating which part of the mesh should be loaded. + * + * If meshName is empty (the default), then the entire mesh is loaded. + * + * If meshName is a plain string, then only the sub-mesh matching that name, if present, will be loaded. + * + * If meshName is a regular expression, than all sub-meshes matching the expression will be loaded. + * + * \note Only Wavefront OBJ files support sub-meshes. + * + * \sa QRegularExpression */ /*! @@ -90,7 +105,17 @@ QMeshPrivate::QMeshPrivate() * * \inherits Qt3DRender::QGeometryRenderer * - * \brief A custom mesh. + * \brief A custom mesh loader. + * + * Loads mesh data from external files in a variety of formats. + * Qt3DRender::QMesh loads data into a single mesh. + * + * In Qt3D 5.9, QMesh supports the following formats: Wavefront OBJ, Stanford Triangle Format PLY, STL (STereoLithography). + * QMesh will also support Autodesk FBX files if the SDK is installed and the fbx geometry loader plugin is built and found. + * + * If you wish to load an entire scene made of several objects, you should rather use the Qt3DRender::QSceneLoader instead. + * + * \sa Qt3DRender::QSceneLoader */ /*! |