diff options
| author | Mats Honkamaa <mats.honkamaa@qt.io> | 2019-06-13 12:41:11 +0300 |
|---|---|---|
| committer | Mats Honkamaa <mats.honkamaa@qt.io> | 2019-06-19 16:15:32 +0300 |
| commit | c31b28180b8bd0c1cbcbad7874b653d31ce2d920 (patch) | |
| tree | 253e81bcfd35acb586c8fb2c64ff5ce724ff5134 | |
| parent | 899724924e71ed7e13e5698dec9ade21ba8d40e4 (diff) | |
Initial OpenGL runtime documentation structure
Copied from Qt3D runtime docs with some modifications.
Task-number: QT3DS-3561
Change-Id: I67fc9bc59290b34e788cf4a79676c9e04e634979
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Reviewed-by: Pasi Keränen <pasi.keranen@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
33 files changed, 1942 insertions, 239 deletions
diff --git a/src/api/studio3d/doc/doc.pri b/src/api/studio3d/doc/doc.pri new file mode 100644 index 0000000..f2817aa --- /dev/null +++ b/src/api/studio3d/doc/doc.pri @@ -0,0 +1,9 @@ +build_online_docs: \ + QMAKE_DOCS = $$PWD/online/qt3dstudio-opengl-runtime.qdocconf +else: \ + QMAKE_DOCS = $$PWD/qt3dstudio-opengl-runtime.qdocconf + +OTHER_FILES += \ + $$PWD/src/*.qdoc \ + $$PWD/src/*.html \ + $$PWD/src/images/*.png \ diff --git a/src/api/studio3d/doc/online/qt3dstudio-opengl-runtime.qdocconf b/src/api/studio3d/doc/online/qt3dstudio-opengl-runtime.qdocconf new file mode 100644 index 0000000..a1dd74d --- /dev/null +++ b/src/api/studio3d/doc/online/qt3dstudio-opengl-runtime.qdocconf @@ -0,0 +1,2 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults-online-commercial.qdocconf) +include(../qt3dstudio-opengl-runtime-project.qdocconf) diff --git a/src/api/studio3d/doc/qt3dstudio-opengl-runtime-project.qdocconf b/src/api/studio3d/doc/qt3dstudio-opengl-runtime-project.qdocconf new file mode 100644 index 0000000..9729d50 --- /dev/null +++ b/src/api/studio3d/doc/qt3dstudio-opengl-runtime-project.qdocconf @@ -0,0 +1,65 @@ +project = Qt3DStudioOpenGLRuntime +description = Qt 3D Studio OpenGL Runtime Reference +version = $QT_VERSION +# url is relative to the parent project +url = openglruntime + +moduleheader = QtStudio3D + +sourcedirs += ./src \ + ../.. \ + ../../../qmlstreamer + +headerdirs += ../.. \ + ../../../qmlstreamer + +imagedirs += ./src/images + +depends = qtcore qtgui qtwidgets qtqml qtquick qtquickcontrols qt3dstudio qt3dstudioruntime2 qtdoc qmake + +qhp.projects = Qt3DStudioOpenGLRuntime + +qhp.Qt3DStudioOpenGLRuntime.file = qt3dstudio-openglruntime.qhp +qhp.Qt3DStudioOpenGLRuntime.namespace = io.qt.qt3dstudio-openglruntime.$QT_VERSION_TAG +qhp.Qt3DStudioOpenGLRuntime.virtualFolder = qt3dstudio-openglruntime +qhp.Qt3DStudioOpenGLRuntime.indexTitle = Qt 3D Studio OpenGL Runtime +qhp.Qt3DStudioOpenGLRuntime.indexRoot = + +qhp.Qt3DStudioOpenGLRuntime.filterAttributes = qt3dstudio-openglruntime $QT_VER +qhp.Qt3DStudioOpenGLRuntime.customFilters.Qt.name = Qt3DStudioOpenGLRuntime $QT_VER +qhp.Qt3DStudioOpenGLRuntime.customFilters.Qt.filterAttributes = qt3dstudio-openglruntime $QT_VER + +qhp.Qt3DStudioOpenGLRuntime.subprojects = manual qmltypes classes + +qhp.Qt3DStudioOpenGLRuntime.subprojects.manual.title = Qt 3D Studio OpenGL Runtime +qhp.Qt3DStudioOpenGLRuntime.subprojects.manual.indexTitle = Qt 3D Studio OpenGL Runtime TOC +qhp.Qt3DStudioOpenGLRuntime.subprojects.manual.type = manual + +qhp.Qt3DStudioOpenGLRuntime.subprojects.qmltypes.title = QML Types +qhp.Qt3DStudioOpenGLRuntime.subprojects.qmltypes.indexTitle = Qt 3D Studio OpenGL Runtime QML Types +qhp.Qt3DStudioOpenGLRuntime.subprojects.qmltypes.selectors = qmltype +qhp.Qt3DStudioOpenGLRuntime.subprojects.qmltypes.sortPages = true + +qhp.Qt3DStudioOpenGLRuntime.subprojects.classes.title = C++ Classes +qhp.Qt3DStudioOpenGLRuntime.subprojects.classes.indexTitle = Qt 3D Studio OpenGL Runtime C++ Classes +qhp.Qt3DStudioOpenGLRuntime.subprojects.classes.selectors = class namespace doc:headerfile +qhp.Qt3DStudioOpenGLRuntime.subprojects.classes.sortPages = true + +# Add an .html file with sidebar content, used in the online style +HTML.stylesheets += style/qt5-sidebar.html + +navigation.homepage = "Qt 3D Studio OpenGL Runtime" +navigation.hometitle = "OpenGL Runtime" +navigation.landingpage = "Qt 3D Studio OpenGL Runtime" +navigation.landingtitle = OpenGL Runtime +navigation.cppclassespage = Qt 3D Studio OpenGL Runtime C++ Classes +navigation.qmltypespage = Qt 3D Studio OpenGL Runtime QML Types +buildversion = "Qt 3D Studio OpenGL Runtime $QT_VER Manual" + +macro.RUNTIME = Qt 3D Studio OpenGL Runtime + +#TODO: adjust these once we have runtime-specific examples +# examplesinstallpath = studio3d +# exampledirs += ../examples/studio3d + +Cpp.ignoretokens += Q3DSV_EXPORT Q_STUDIO3D_EXPORT diff --git a/src/api/studio3d/doc/qt3dstudio-opengl-runtime.qdocconf b/src/api/studio3d/doc/qt3dstudio-opengl-runtime.qdocconf new file mode 100644 index 0000000..9b76104 --- /dev/null +++ b/src/api/studio3d/doc/qt3dstudio-opengl-runtime.qdocconf @@ -0,0 +1,2 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) +include(qt3dstudio-opengl-runtime-project.qdocconf) diff --git a/src/api/studio3d/doc/src/attributenames.html b/src/api/studio3d/doc/src/attributenames.html new file mode 100644 index 0000000..fca55df --- /dev/null +++ b/src/api/studio3d/doc/src/attributenames.html @@ -0,0 +1,911 @@ +\raw HTML +<table id='scripting-attributes'> +<tbody></tbody> +<tr><th colspan="4">Scenes</td></tr> +<tr> +<td class='formal'>Name</td> +<td class='scripting'>name</td> +<td class='type'>string</td> +</tr> +<tr> +<td class='formal'>Enable Background Color</td> +<td class='scripting'>bgcolorenable</td> +<td class='type'>boolean</td> +</tr> +<tr> +<td class='formal'>Background Color R</td> +<td class='scripting'>backgroundcolor.r</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Background Color G</td> +<td class='scripting'>backgroundcolor.g</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Background Color B</td> +<td class='scripting'>backgroundcolor.b</td> +<td class='type'>number</td> +</tr> +<tbody></tbody> +<tr><th colspan="4">Elements other than Scenes</td></tr> +<tr> +<td class='formal'>Element Name</td> +<td class='scripting'>name</td> +<td class='type'>string</td> +</tr> +<tr> +<td class='formal'>(Eyeball)</td> +<td class='scripting'>eyeball</td> +<td class='type'>boolean</td> +</tr> +<tr> +<td class='formal'>Timebar Start</td> +<td class='scripting'>starttime</td> +<td class='type'>number</td> +<td class='note'> +in integer milliseconds +</td> +</tr> +<tr> +<td class='formal'>Timebar End</td> +<td class='scripting'>endtime</td> +<td class='type'>number</td> +<td class='note'> +in integer milliseconds +</td> +</tr> +<tbody></tbody> +<tr><th colspan="4">Layers</td></tr> +<tr> +<td class='formal'>Disable Depth Test</td> +<td class='scripting'>disabledepthtest</td> +<td class='type'>boolean</td> +</tr> +<tr> +<td class='formal'>Progressive AA</td> +<td class='scripting'>progressiveaa</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'None'</code>, <code>'2x'</code>, <code>'4x'</code>, <code>'8x'</code> +</td> +</tr> +<tr> +<td class='formal'>Multisample AA</td> +<td class='scripting'>multisampleaa</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'None'</code>, <code>'2x'</code>, <code>'4x'</code> +</td> +</tr> +<tr> +<td class='formal'>Temporal AA</td> +<td class='scripting'>temporalaa</td> +<td class='type'>boolean</td> +</tr> +<tr> +<td class='formal'>Layer Background</td> +<td class='scripting'>background</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'Transparent'</code>, <code>'Unspecified'</code>, <code>'SolidColor'</code> +</td> +</tr> +<tr> +<td class='formal'>Background Color R</td> +<td class='scripting'>backgroundcolor.r</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Background Color G</td> +<td class='scripting'>backgroundcolor.g</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Background Color B</td> +<td class='scripting'>backgroundcolor.b</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Blend Type</td> +<td class='scripting'>blendtype</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'Normal'</code>, <code>'Screen'</code>, <code>'Multiply'</code>, <code>'Add'</code>, <code>'*Overlay'</code>, <code>'*ColorBurn'</code>, <code>'*ColorDodge'</code> +</td> +</tr> +<tr> +<td class='formal'>Horizontal Fields</td> +<td class='scripting'>horzfields</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'Left/Width'</code>, <code>'Left/Right'</code>, <code>'Width/Right'</code> +</td> +</tr> +<tr> +<td class='formal'>Left</td> +<td class='scripting'>left</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Left Units</td> +<td class='scripting'>leftunits</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'pixels'</code>, <code>'percent'</code> +</td> +</tr> +<tr> +<td class='formal'>Width</td> +<td class='scripting'>width</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Width Units</td> +<td class='scripting'>widthunits</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'pixels'</code>, <code>'percent'</code> +</td> +</tr> +<tr> +<td class='formal'>Right</td> +<td class='scripting'>right</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Right Units</td> +<td class='scripting'>rightunits</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'pixels'</code>, <code>'percent'</code> +</td> +</tr> +<tr> +<td class='formal'>Vertical Fields</td> +<td class='scripting'>vertfields</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'Top/Height'</code>, <code>'Top/Bottom'</code>, <code>'Height/Bottom'</code> +</td> +</tr> +<tr> +<td class='formal'>Top</td> +<td class='scripting'>top</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Top Units</td> +<td class='scripting'>topunits</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'pixels'</code>, <code>'percent'</code> +</td> +</tr> +<tr> +<td class='formal'>Height</td> +<td class='scripting'>height</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Height Units</td> +<td class='scripting'>heightunits</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'pixels'</code>, <code>'percent'</code> +</td> +</tr> +<tr> +<td class='formal'>Bottom</td> +<td class='scripting'>bottom</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Bottom Units</td> +<td class='scripting'>bottomunits</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'pixels'</code>, <code>'percent'</code> +</td> +</tr> +<tr> +<td class='formal'>Ambient Occlusion</td> +<td class='scripting'>aostrength</td> +<td class='type'>number</td> +<td class='note'> +values between 0 and 100 +</td> +</tr> +<tr> +<td class='formal'>AO Distance</td> +<td class='scripting'>aodistance</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>AO Softness</td> +<td class='scripting'>aosoftness</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>AO Threshold</td> +<td class='scripting'>aobias</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>AO Sampling Rate</td> +<td class='scripting'>aosamplerate</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>AO Dithering</td> +<td class='scripting'>aodither</td> +<td class='type'>boolean</td> +</tr> +<tr> +<td class='formal'>Shadow Strength</td> +<td class='scripting'>shadowstrength</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Shadow Distance</td> +<td class='scripting'>shadowdist</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Shadow Softness</td> +<td class='scripting'>shadowsoftness</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Shadow Threshold</td> +<td class='scripting'>shadowbias</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Light Probe</td> +<td class='scripting'>lightprobe</td> +<td class='type'>image element</td> +</tr> +<tr> +<td class='formal'>IBL Horizon Cutoff</td> +<td class='scripting'>probehorizon</td> +<td class='type'>number</td> +<td class='note'> +values from -1 (no horizon) to -0.001 (hard edge) +</td> +</tr> +<tr> +<td class='formal'>Sub-Presentation</td> +<td class='scripting'>sourcepath</td> +<td class='type'>string</td> +<td class='note'> +id of the sub-presentation to display +</td> +</tr> +<tbody></tbody> +<tr><th colspan="4">Nodes</td></tr> +<tr> +<td class='formal'>Position X</td> +<td class='scripting'>position.x</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Position Y</td> +<td class='scripting'>position.y</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Position Z</td> +<td class='scripting'>position.z</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Rotation X</td> +<td class='scripting'>rotation.x</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Rotation Y</td> +<td class='scripting'>rotation.y</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Rotation Z</td> +<td class='scripting'>rotation.z</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Scale X</td> +<td class='scripting'>scale.x</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Scale Y</td> +<td class='scripting'>scale.y</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Scale Z</td> +<td class='scripting'>scale.z</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Pivot X</td> +<td class='scripting'>pivot.x</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Pivot Y</td> +<td class='scripting'>pivot.y</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Pivot Z</td> +<td class='scripting'>pivot.z</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Opacity</td> +<td class='scripting'>opacity</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'></td> +<td class='scripting'>orientation</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'Left Handed'</code>, <code>'Right Handed'</code> +</td> +</tr> +<tr> +<td class='formal'></td> +<td class='scripting'>rotationorder</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'XYZ'</code>, <code>'YZX'</code>, <code>'ZXY'</code>, <code>'XZY'</code>, <code>'YXZ'</code>, <code>'ZYX'</code>, <code>'XYZr'</code>, <code>'YZXr'</code>, <code>'ZXYr'</code>, <code>'XZYr'</code>, <code>'YXZr'</code>, <code>'ZYXr'</code> +</td> +</tr> +<tr> +<td class='formal'></td> +<td class='scripting'>ignoresparent</td> +<td class='type'>boolean</td> +<td class='note'> +prevents parent transformation from being applied [ignored as of 2.0] +</td> +</tr> +<tbody></tbody> +<tr><th colspan="4">Aliases</td></tr> +<tr> +<td class='formal'>Reference</td> +<td class='scripting'>referencednode</td> +<td class='type'>string</td> +<td class='note'> +relative or absolute element path +</td> +</tr> +<tbody></tbody> +<tr><th colspan="4">Cameras</td></tr> +<tr> +<td class='formal'>Orthographic</td> +<td class='scripting'>orthographic</td> +<td class='type'>boolean</td> +</tr> +<tr> +<td class='formal'>Field of View</td> +<td class='scripting'>fov</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Clipping Start</td> +<td class='scripting'>clipnear</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Clipping End</td> +<td class='scripting'>clipfar</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Runtime Scale Mode</td> +<td class='scripting'>scalemode</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'Fit'</code>, <code>'Same Size'</code> +</td> +</tr> +<tr> +<td class='formal'>Runtime Scale Anchor</td> +<td class='scripting'>scaleanchor</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'Center'</code>, <code>'NW'</code>, <code>'N'</code>, <code>'NE'</code>, <code>'E'</code>, <code>'SE'</code>, <code>'S'</code>, <code>'SW'</code>, <code>'W'</code> +</td> +</tr> +<tbody></tbody> +<tr><th colspan="4">Lights</td></tr> +<tr> +<td class='formal'>Scope</td> +<td class='scripting'>scope</td> +<td class='type'>string</td> +<td class='note'> +full path to the element +</td> +</tr> +<tr> +<td class='formal'>Light Type</td> +<td class='scripting'>lighttype</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'Directional'</code>, <code>'Point'</code>, <code>'Area'</code> +</td> +</tr> +<tr> +<td class='formal'>Light Color R</td> +<td class='scripting'>lightdiffuse.r</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Light Color G</td> +<td class='scripting'>lightdiffuse.g</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Light Color B</td> +<td class='scripting'>lightdiffuse.b</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Specular Color R</td> +<td class='scripting'>lightspecular.r</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Specular Color G</td> +<td class='scripting'>lightspecular.g</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Specular Color B</td> +<td class='scripting'>lightspecular.b</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Ambient Color R</td> +<td class='scripting'>lightambient.r</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Ambient Color G</td> +<td class='scripting'>lightambient.g</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Ambient Color B</td> +<td class='scripting'>lightambient.b</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Brightness</td> +<td class='scripting'>brightness</td> +<td class='type'>number</td> +<td class='note'> +only applies to point lights +</td> +</tr> +<tr> +<td class='formal'>Linear Fade</td> +<td class='scripting'>linearfade</td> +<td class='type'>number</td> +<td class='note'> +only applies to point lights +</td> +</tr> +<tr> +<td class='formal'>Exponential Fade</td> +<td class='scripting'>expfade</td> +<td class='type'>number</td> +<td class='note'> +only applies to point lights +</td> +</tr> +<tr> +<td class='formal'>Cast Shadows?</td> +<td class='scripting'>castshadow</td> +<td class='type'>boolean</td> +</tr> +<tr> +<td class='formal'>Shadow Darkness</td> +<td class='scripting'>shdwfactor</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Shadow Softness</td> +<td class='scripting'>shdwfilter</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Shadow Resolution</td> +<td class='scripting'>shdwmapres</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'256'</code>, <code>'512'</code>, <code>'1024'</code>, <code>'2048'</code> +</td> +</tr> +<tr> +<td class='formal'>Shadow Depth Bias</td> +<td class='scripting'>shdwbias</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Shadow Far Clip</td> +<td class='scripting'>shdwmapfar</td> +<td class='type'>number</td> +<tr> +<td class='formal'>Shadow Field of View</td> +<td class='scripting'>shdwmapfov</td> +<td class='type'>number</td> +</tr> +<tbody></tbody> +<tr><th colspan="4">Groups</td></tr> +<tr> +<td class='formal'>Import</td> +<td class='scripting'>sourcepath</td> +<td class='type'>string</td> +</tr> +<tbody></tbody> +<tr><th colspan="4">Text</td></tr> +<tr> +<td class='formal'>Text String</td> +<td class='scripting'>textstring</td> +<td class='type'>string</td> +</tr> +<tr> +<td class='formal'>Text Color R</td> +<td class='scripting'>textcolor.r</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Text Color G</td> +<td class='scripting'>textcolor.g</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Text Color B</td> +<td class='scripting'>textcolor.b</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Font</td> +<td class='scripting'>font</td> +<td class='type'>string</td> +</tr> +<tr> +<td class='formal'>Font Size</td> +<td class='scripting'>size</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Horizontal Alignment</td> +<td class='scripting'>horzalign</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'Left'</code>, <code>'Center'</code>, <code>'Right'</code> +</td> +</tr> +<tr> +<td class='formal'>Vertical Alignment</td> +<td class='scripting'>vertalign</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'Top'</code>, <code>'Middle'</code>, <code>'Bottom'</code> +</td> +</tr> +<tr> +<td class='formal'>Leading</td> +<td class='scripting'>leading</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Tracking</td> +<td class='scripting'>tracking</td> +<td class='type'>number</td> +</tr> +<tbody></tbody> +<tr><th colspan="4">Models</td></tr> +<tr> +<td class='formal'>Mesh</td> +<td class='scripting'>sourcepath</td> +<td class='type'>string</td> +</tr> +<tr> +<td class='formal'>Tessellation Mode</td> +<td class='scripting'>tessellation</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'None'</code>, <code>'Linear'</code>, <code>'Phong'</code>, <code>'NPatch'</code> [ignored as of 2.0] +</td> +</tr> +<tr> +<td class='formal'>Edge Tessellation</td> +<td class='scripting'>edgetess</td> +<td class='type'>number</td> +<td class='note'> +[ignored as of 2.0] +</td> +</tr> +<tr> +<td class='formal'>Inner Tessellation</td> +<td class='scripting'>innertess</td> +<td class='type'>number</td> +<td class='note'> +[ignored as of 2.0] +</td> +</tr> +<tbody></tbody> +<tr><th colspan="4">Standard Materials</td></tr> +<tr> +<td class='formal'>Lighting</td> +<td class='scripting'>shaderlighting</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'Vertex'</code>, <code>'Pixel'</code>, <code>'None'</code> +</td> +</tr> +<tr> +<td class='formal'>Blending Mode</td> +<td class='scripting'>blendmode</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'Normal'</code>, <code>'Screen'</code>, <code>'Multiply'</code> +</td> +</tr> +<tr> +<td class='formal'>Diffuse Color R</td> +<td class='scripting'>diffuse.r</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Diffuse Color G</td> +<td class='scripting'>diffuse.g</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Diffuse Color B</td> +<td class='scripting'>diffuse.b</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Diffuse Map</td> +<td class='scripting'>diffusemap</td> +<td class='type'>image element</td> +<td class='note'> +to change the image set the <code>sourcepath</code> attribute on the image element +</td> +</tr> +<tr> +<td class='formal'>Diffuse Map 2</td> +<td class='scripting'>diffusemap2</td> +<td class='type'>image element</td> +<td class='note'> +to change the image set the <code>sourcepath</code> attribute on the image element +</td> +</tr> +<tr> +<td class='formal'>Diffuse Map 3</td> +<td class='scripting'>diffusemap3</td> +<td class='type'>image element</td> +<td class='note'> +to change the image set the <code>sourcepath</code> attribute on the image element +</td> +</tr> +<tr> +<td class='formal'>Specular Reflection</td> +<td class='scripting'>specularreflection</td> +<td class='type'>image element</td> +<td class='note'> +to change the image set the <code>sourcepath</code> attribute on the image element +</td> +</tr> +<tr> +<td class='formal'>Specular Tint R</td> +<td class='scripting'>speculartint.r</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Specular Tint G</td> +<td class='scripting'>speculartint.g</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Specular Tint B</td> +<td class='scripting'>speculartint.b</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Specular Amount</td> +<td class='scripting'>specularamount</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Specular Map</td> +<td class='scripting'>specularmap</td> +<td class='type'>image element</td> +<td class='note'> +to change the image set the <code>sourcepath</code> attribute on the image element +</td> +</tr> +<tr> +<td class='formal'>Specular Model</td> +<td class='scripting'>specularmodel</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'Default'</code>, <code>'KGGX'</code>, <code>'KWard'</code> +</td> +</tr> +<tr> +<td class='formal'>Fresnel Power</td> +<td class='scripting'>fresnelPower</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Index of Refraction</td> +<td class='scripting'>ior</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Specular Roughness</td> +<td class='scripting'>specularroughness</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Bump Map</td> +<td class='scripting'>bumpmap</td> +<td class='type'>image element</td> +<td class='note'> +to change the image set the <code>sourcepath</code> attribute on the image element +</td> +</tr> +<tr> +<td class='formal'>Normal Map</td> +<td class='scripting'>normalmap</td> +<td class='type'>image element</td> +<td class='note'> +to change the image set the <code>sourcepath</code> attribute on the image element +</td> +</tr> +<tr> +<td class='formal'>Bump Amount</td> +<td class='scripting'>bumpamount</td> +<td class='type'>number</td> +<td class='note'> +affects both bump and normal maps +</td> +</tr> +<tr> +<td class='formal'>Displacement Map</td> +<td class='scripting'>displacementmap</td> +<td class='type'>image element</td> +<td class='note'> +to change the image set the <code>sourcepath</code> attribute on the image element +</td> +</tr> +<tr> +<td class='formal'>Displacement Amount</td> +<td class='scripting'>displaceamount</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Opacity</td> +<td class='scripting'>opacity</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Opacity Map</td> +<td class='scripting'>opacitymap</td> +<td class='type'>image element</td> +<td class='note'> +to change the image set the <code>sourcepath</code> attribute on the image element +</td> +</tr> +<tr> +<td class='formal'>Emissive Power</td> +<td class='scripting'>emissivepower</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Emissive Map</td> +<td class='scripting'>emissivemap</td> +<td class='type'>image element</td> +<td class='note'> +to change the image set the <code>sourcepath</code> attribute on the image element +</td> +</tr> +<tbody></tbody> +<tr><th colspan="4">Material References</td></tr> +<tr> +<td class='formal'>Referenced Material</td> +<td class='scripting'>referencedmaterial</td> +<td class='type'>string</td> +<td class='note'> +relative or absolute element path +</td> +</tr> +<tbody></tbody> +<tr><th colspan="4">Images</td></tr> +<tr> +<td class='formal'>U Repeat</td> +<td class='scripting'>scaleu</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>V Repeat</td> +<td class='scripting'>scalev</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Texture Mapping</td> +<td class='scripting'>mappingmode</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'UV Mapping'</code>, <code>'Environmental Mapping'</code> +</td> +</tr> +<tr> +<td class='formal'>U Tiling</td> +<td class='scripting'>tilingmodehorz</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'Tiled'</code>, <code>'Mirrored'</code>, <code>'No Tiling'</code> +</td> +</tr> +<tr> +<td class='formal'>V Tiling</td> +<td class='scripting'>tilingmodevert</td> +<td class='type'>string</td> +<td class='note'> +values: <code>'Tiled'</code>, <code>'Mirrored'</code>, <code>'No Tiling'</code> +</td> +</tr> +<tr> +<td class='formal'>UV Rotation</td> +<td class='scripting'>rotationuv</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>U Position</td> +<td class='scripting'>positionu</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>V Position</td> +<td class='scripting'>positionv</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>U Pivot</td> +<td class='scripting'>pivotu</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>V Pivot</td> +<td class='scripting'>pivotv</td> +<td class='type'>number</td> +</tr> +<tr> +<td class='formal'>Sub-Presentation</td> +<td class='scripting'>subpresentation</td> +<td class='type'>string</td> +<td class='note'> +id of the sub-presentation to display +</td> +</tr> +<tr> +<td class='formal'>Source Path</td> +<td class='scripting'>sourcepath</td> +<td class='type'>string</td> +<td class='note'> +path to the image +</td> +</tr> +</table> +\endraw diff --git a/src/api/studio3d/doc/src/attributenames.qdoc b/src/api/studio3d/doc/src/attributenames.qdoc new file mode 100644 index 0000000..e499f17 --- /dev/null +++ b/src/api/studio3d/doc/src/attributenames.qdoc @@ -0,0 +1,71 @@ +!/**************************************************************************** +** +** Copyright (C) 1993-2009 NVIDIA Corporation. +** Copyright (C) 2019 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qt 3D Studio. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +// Pull in attributenames.html into qdoc. Note that attributenames.html is +// manually maintained since 2.0 and is not auto-generated. + +/*! + \page qt3dstudio-opengl-runtime-attribute-names.html + \title Attribute Names + \keyword Attributes + + Below is a list of the attributes that can be set on the various scene + objects via Q3DSPresentation::setAttribute() or Q3DSElement::setAttribute(). + + \note vector (e.g. a group's or model's \c rotation) and color (e.g. a + material's \c diffuse) attributes allow setting/getting all components in + one operation, and are mapped to QVector3D and QColor, respectively. + + \note As of Qt 3D Studio 2.1 not all properties can be changed on the fly at + run time. As a general rule attributes that are animatable in the Qt 3D + Studio application are freely changeable by the applications during run time + as well. + + \note When possible, applications are recommended to rely on the \c{data + input} functionality of Qt 3D Studio instead. This avoids the need to refer + to hard-coded attribute names, and instead allows the designers to expose + the interesting attributes with arbitrary data input names to the + application developers, thus offering a fixed, well-known interface from the + 3D presentation to the application code. See \l Q3DSDataInput, \l DataInput, + \l Q3DSDataOutput, and \l DataOutput for more information. + + \include attributenames.html + + Custom materials and effects have their custom set of properties that are + defined in the \c{.material} or \c{.effect} file. For example, an instances + of an effect with the following metadata will have an attribute \c HBlurBias + with the type \c number that can be set and queried as if it was a built-in + attribute. + + \badcode + <Effect> + <MetaData> + <Property name="HBlurBias" formalName="Horizontal Blur" min="0" max="10" default="2" description="Amount of corona horizontally."/> + ... + \endcode +*/ diff --git a/src/api/studio3d/doc/src/copyright.qdoc b/src/api/studio3d/doc/src/copyright.qdoc new file mode 100644 index 0000000..f358919 --- /dev/null +++ b/src/api/studio3d/doc/src/copyright.qdoc @@ -0,0 +1,37 @@ +/**************************************************************************** +** +** Copyright (C) 2019 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qt 3D Studio. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! +\page copyright-notices.html +\title Copyright Notices +\section1 Third-party Licenses + +The following table lists parts (modules) of \RUNTIME that +incorporate code licensed under third-party open-source licenses: + +\annotatedlist attributions-qt3dstudio-opengl-runtime +*/ diff --git a/src/api/studio3d/doc/src/embedded.qdoc b/src/api/studio3d/doc/src/embedded.qdoc new file mode 100644 index 0000000..b468070 --- /dev/null +++ b/src/api/studio3d/doc/src/embedded.qdoc @@ -0,0 +1,32 @@ +/**************************************************************************** +** +** Copyright (C) 2019 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qt 3D Studio. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qt3dstudio-opengl-runtime-embedded.html + \title Using the Runtime on Embedded Devices + +*/ diff --git a/src/api/studio3d/doc/src/examples.qdoc b/src/api/studio3d/doc/src/examples.qdoc new file mode 100644 index 0000000..f7a78b4 --- /dev/null +++ b/src/api/studio3d/doc/src/examples.qdoc @@ -0,0 +1,41 @@ +/**************************************************************************** +** +** Copyright (C) 2019 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qt 3D Studio. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \title Examples + \ingroup examples + \page qt3dstudio-opengl-runtime-examples.html + + Included in the \RUNTIME you will find a set of examples. These are + located in the \c {examples} folder in the installation folder. + + \section1 More Examples + + You can find more examples from + \l{https://git.qt.io/public-demos/qt3dstudio}, these examples are more + visually appealing and suitable to use as demos for example. +*/ diff --git a/src/api/studio3d/doc/src/gettingstarted.qdoc b/src/api/studio3d/doc/src/gettingstarted.qdoc new file mode 100644 index 0000000..9289b54 --- /dev/null +++ b/src/api/studio3d/doc/src/gettingstarted.qdoc @@ -0,0 +1,117 @@ +/**************************************************************************** +** +** Copyright (C) 2019 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qt 3D Studio. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qt3dstudio-opengl-runtime-gettingstarted.html + \title Getting Started + + The \RUNTIME provides C++ and QML APIs for integrating Qt 3D + Studio scenes into Qt applications, as well as the viewer application that + is used in combination with the Qt 3D Studio application during the design + phase. + + Below is an example scene in the Qt 3D Studio application. + + \image intro-editor.png + + During the design phase, the standalone viewer is typically launched from + the editor several times to check and verify the presentation in the + runtime. + + \image intro-viewer.png + + Once the design is done and the \c{.uia}, \c{.uip}, and other asset files + are available, these can be loaded, rendered, and manipulated in Qt + applications. This is done via the APIs provided in the \c studio3d + module and the \c QtStudio3D.OpenGL QML plugin. + + Below is the same scene loaded into a simple Qt Quick application + (the \l{Qt 3D Studio Runtime: Simple QML Example}{simpleqml + example}) that composes the 3D content with the other Qt Quick + items, for example the ones provided by \l{Qt Quick Controls + 2}. In addition to displaying the presentation, the application + can also control many aspects of it (slides, timeline, object + properties) and can react on certain conditions, such as when a 3D + object is clicked on (picked) by mouse or touch input. + + \image intro-app.png + + \section1 Rendering Scenes + + APIs are provided for the following Qt UI technologies: + + \list + + \li Qt Quick: here applications import QtStudio3D.OpenGL \QtVer which + provides the \l [QML] Studio3D QML type, a Qt Quick item that can be + added to Qt Quick scenes. Under the hood this is similar to adding a + \l [QML] Scene3D (when working directly with the lower level Qt 3D + framework) or a custom item based on \l QQuickFramebufferObject into + the scene. + + \li QWindow or offscreen render targets (OpenGL texture): Q3DSSurfaceViewer + can be used both to render to an on-screen QWindow, as well as off-screen + into an OpenGL texture. The latter allows reading back and saving the + frames, to generate pre-rendered video sequences for example. + + \endlist + + \section1 Manipulating Scenes + + Rendering Qt 3D Studio scenes is only part of the story since many scenes + are not static and will not just display all their contents as they were + done by designers in the Qt 3D Studio application. Rather, properties of + scene objects (for example, the rotation property of a 3D model, or the + diffuse color of the material associated with such a model) may need to be + changed dynamically, at run time. The timeline or the current slide may + also need to be adjusted based on the user's actions or other application + state. + + Above functionality is exposed via the following types: + + \table + \header + \li C++ Class + \li QML Type + \row + \li Q3DSPresentation + \li \l [QML] Presentation + \row + \li Q3DSElement + \li \l Element + \row + \li Q3DSSceneElement + \li \l [QML] SceneElement + \row + \li Q3DSDataInput + \li \l [QML] DataInput + + \endtable + + Advanced scene manipulation (for example, dynamically spawning and + removing objects in a 3D scene) will be introduced in future versions. +*/ diff --git a/src/api/studio3d/doc/src/images/customsignal.png b/src/api/studio3d/doc/src/images/customsignal.png Binary files differnew file mode 100644 index 0000000..eb0e0ba --- /dev/null +++ b/src/api/studio3d/doc/src/images/customsignal.png diff --git a/src/api/studio3d/doc/src/images/intro-app.png b/src/api/studio3d/doc/src/images/intro-app.png Binary files differnew file mode 100644 index 0000000..3658190 --- /dev/null +++ b/src/api/studio3d/doc/src/images/intro-app.png diff --git a/src/api/studio3d/doc/src/images/intro-editor.png b/src/api/studio3d/doc/src/images/intro-editor.png Binary files differnew file mode 100644 index 0000000..52e5a69 --- /dev/null +++ b/src/api/studio3d/doc/src/images/intro-editor.png diff --git a/src/api/studio3d/doc/src/images/intro-viewer.png b/src/api/studio3d/doc/src/images/intro-viewer.png Binary files differnew file mode 100644 index 0000000..f964b58 --- /dev/null +++ b/src/api/studio3d/doc/src/images/intro-viewer.png diff --git a/src/api/studio3d/doc/src/images/twolayers.png b/src/api/studio3d/doc/src/images/twolayers.png Binary files differnew file mode 100644 index 0000000..2f4b66f --- /dev/null +++ b/src/api/studio3d/doc/src/images/twolayers.png diff --git a/src/api/studio3d/doc/src/index.qdoc b/src/api/studio3d/doc/src/index.qdoc new file mode 100644 index 0000000..aa6ab2e --- /dev/null +++ b/src/api/studio3d/doc/src/index.qdoc @@ -0,0 +1,44 @@ +/**************************************************************************** +** +** Copyright (C) 2019 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qt 3D Studio. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! +\title \RUNTIME +\page qt3dstudio-opengl-runtime-index.html + +\section1 Table of Contents + +\list + \li \l {Getting Started} + \li \l {System and Application Requirements} + \li \l {\RUNTIME C++ Classes} + \li \l {\RUNTIME QML Types} + \li \l {Attribute Names}{Scene Object Attribute List} + \li \l {Examples} + \li \l {Copyright Notices} +\endlist + +*/ diff --git a/src/api/studio3d/doc/src/mobile.qdoc b/src/api/studio3d/doc/src/mobile.qdoc new file mode 100644 index 0000000..2ede51a --- /dev/null +++ b/src/api/studio3d/doc/src/mobile.qdoc @@ -0,0 +1,32 @@ +/**************************************************************************** +** +** Copyright (C) 2019 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qt 3D Studio. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qt3dstudio-opengl-runtime-mobile.html + \title Using the OpenGL Runtime on Android/iOS Devices + +*/ diff --git a/src/api/studio3d/doc/src/module.qdoc b/src/api/studio3d/doc/src/module.qdoc new file mode 100644 index 0000000..98b134e --- /dev/null +++ b/src/api/studio3d/doc/src/module.qdoc @@ -0,0 +1,111 @@ +/**************************************************************************** +** +** Copyright (C) 2019 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qt 3D Studio. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \module OpenGLRuntime + \title \RUNTIME C++ Classes + \ingroup modules + + \brief The \RUNTIME provides a number of C++ classes to + integrate and control Qt 3D Studio presentations in Qt applications. + + To include the definitions of the module's classes, use the following directive: + + \code + #include <QtStudio3D> + \endcode + + To link against the module, add this line to your \l qmake \c .pro file: + + \badcode + QT += studio3d + \endcode + + \section1 Integrating + + The main class is \l Q3DSSurfaceViewer. Q3DSSurfaceViewer allows targeting a QWindow or an + offscreen render target (an OpenGL texture). + + \note Qt applications based on QML and Qt Quick will rather want to use the + \l Studio3D type from \l {\RUNTIME QML Types}. + + \section1 Controlling + + Each \l Q3DSSurfaceViewer instance exposes a \l + Q3DSPresentation. This, possibly in combination with \l Q3DSDataInput or + \l Q3DSElement objects, allows: + + \list + + \li changing scene object properties (for example, the transform of a + model, colors and other settings of a material, etc.), + + \li changing slides (thus starting the relevant animations and applying the + scene object property changes associated with the new slide), + + \li and controlling the timeline (the current playback position for the + key-frame based animations) both on the main scene and on individual + Component nodes. + + \endlist + + \section1 Classes +*/ + +/*! + \qmlmodule QtStudio3D.OpenGL \QtVer + \title \RUNTIME QML Types + \ingroup qmlmodules + + \brief QML Types for the \RUNTIME module. + + The \RUNTIME provides a number of QML types to integrate and + control Qt 3D Studio presentations in Qt Quick applications. These types + can be imported into your application using the following import statement + in your \c{.qml} file: + + \qml \QtVer + import QtStudio3D.OpenGL \1 + \endqml + + The main type for embedding a Qt 3D Studio presentations into a Qt Quick + scene is \l Studio3D. Many of the other types correspond to a C++ class in + the API offered to non-QML based applications, providing the same level of + control described in \l{\RUNTIME C++ Classes}{the C++ reference}. + + There are also QML types that offer functionality not available via the C++ + classes. The \l SubPresentationSettings type allows defining \c{QML + sub-presentations} (live Qt Quick scenes composed into the 3D scene either + as Qt 3D Studio layers or as texture maps) in-line, inside a Studio3D + element, without having to deploy them as separate \c .qml files. + + \note the \l Behavior type is to be used by \c{behavior scripts} (\c .qml + snippets associated with scene objects during the design phase in Qt 3D + Studio) and is not available in the main application code. + + \section1 QML Types +*/ diff --git a/src/api/studio3d/doc/src/requirements.qdoc b/src/api/studio3d/doc/src/requirements.qdoc new file mode 100644 index 0000000..f93483c --- /dev/null +++ b/src/api/studio3d/doc/src/requirements.qdoc @@ -0,0 +1,100 @@ +/**************************************************************************** +** +** Copyright (C) 2019 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qt 3D Studio. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qt3dstudio-opengl-runtime-requirements.html + \title System and Application Requirements + + \section1 OpenGL Requirements + + Qt 3D Studio requires OpenGL or OpenGL ES. The recommended minimum versions + are \c{3.3 core profile} and \c{3.0}, respectively. + + When it comes to OpenGL ES, a limited subset of the functionality is + available when running on plain \c{OpenGL ES 2.0} implementations. In + practice this means losing shadow mapping, image based lighting, and many + other advanced features and is therefore not recommended. On the other hand, + this allows bringing up Qt 3D Studio scenes on boards like the Raspberry Pi + (with the original proprietary graphics stack) or the Beaglebone Black, or + in hypervisor-based virtualized environments where the GPU virtualization + only supports GLES 2.0, and can therefore still be valuable in certain + special situations. + + Non-native implementations, like \c ANGLE or software implementations like + \c{Mesa's llvmpipe} may work but are not tested and can fail in unexpected + ways. + + \section1 Application Integration Notes + + \section2 C++ + + A typical Qt C++ application using the \RUNTIME is expected to + query and honor the runtime's \c{ideal surface format}. This way the OpenGL + contexts will all be created with the OpenGL version and profile that best + match the runtime's needs: + + \code + #include <Q3DSSurfaceViewer> // or <q3dsruntimeglobal.h> if only Q3DS::surfaceFormat() is interesting for main() + + int main(int argc, char *argv[]) + { + QApplication app(argc, argv); + + QSurfaceFormat::setDefaultFormat(Q3DS::surfaceFormat()); + + Q3DSSurfaceViewer w; + ... + return app.exec(); + } + \endcode + + To enable using Qt 3D Studio headers and libraries in the application, add + the \c studio3d module in the application's \c{.pro} file: + + \badcode + QT += studio3d + \endcode + + \section2 QML/Qt Quick + + When no C++ classes are used, the \c studio3d module can be omitted + in the \c{.pro}. To use the \l Studio3D element in QML code, it is + enough to add the corresponding import statement: + + \qml + import QtStudio3D.OpenGL \QtVer + \endqml + + It is nonetheless strongly recommended to set the the default surface format + as shown above. Make sure the + \c{QSurfaceFormat::setDefaultFormat(Q3DS::surfaceFormat())} call is made + after constructing QGuiApplication but before the first QQuickWindow or + QQuickView. When this is not possible, for example because the QML contents + is hosted in an application that has no knowledge of the Qt Quick scene's 3D + needs, Studio3D may still be usable but this may be dependent on the OpenGL + implementation and the context versions it offers, and is therefore more fragile. +*/ diff --git a/src/api/studio3d/doc/src/toc.qdoc b/src/api/studio3d/doc/src/toc.qdoc new file mode 100644 index 0000000..e8f5837 --- /dev/null +++ b/src/api/studio3d/doc/src/toc.qdoc @@ -0,0 +1,40 @@ +/**************************************************************************** +** +** Copyright (C) 2019 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qt 3D Studio. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! +\contentspage \RUNTIME +\page qt3dstudio-opengl-runtime-toc.html +\title \RUNTIME TOC + +\omit +This file is used for generating a TOC in a .qch file. +\endomit + +\list + \li \l {index.html}{Overview} +\endlist +*/ diff --git a/src/api/studio3d/doc/style/qt5-sidebar.html b/src/api/studio3d/doc/style/qt5-sidebar.html new file mode 100644 index 0000000..bde0069 --- /dev/null +++ b/src/api/studio3d/doc/style/qt5-sidebar.html @@ -0,0 +1,26 @@ +<div class="sectionlist normallist"> + <div> + <a name="reference"></a> + <h2 id="reference">Qt 3D OpenGL Studio Runtime</h2> + </div> + <div class="indexboxcont indexboxbar"> + <ul> + <li><a href="qt3dstudio-opengl-runtime-index.html">Home</a></li> + <li><a href="qt3dstudio-opengl-runtime-gettingstarted.html">Getting Started</a></li> + <li><a href="qtstudio3d-opengl-qmlmodule.html">QML API Reference</a></li> + <li><a href="qtstudio3d-module.html">C++ API Reference</a></li> + <li><a href="copyright-notices.html">Copyright Notices</a></li> + </ul> + </div> +</div> +<div class="sectionlist normallist"> + <div> + <a name="reference"></a> + <h2 id="reference">Qt 3D Studio</h2> + </div> + <div class="indexboxcont indexboxbar"> + <ul> + <li><a href="../index.html">Home</a></li> + </ul> + </div> +</div> diff --git a/src/api/studio3d/q3dsdatainput.cpp b/src/api/studio3d/q3dsdatainput.cpp index eb8e24e..2a52963 100644 --- a/src/api/studio3d/q3dsdatainput.cpp +++ b/src/api/studio3d/q3dsdatainput.cpp @@ -38,9 +38,10 @@ QT_BEGIN_NAMESPACE /*! \qmltype DataInput \instantiates Q3DSDataInput - \inqmlmodule Qt3DStudio + \inqmlmodule QtStudio3D.OpenGL \ingroup OpenGLRuntime \brief Controls a data input entry in a Qt 3D Studio presentation. + This class is a convenience class for controlling a data input in a presentation. DataInput provides a clean contract between the presentation design and the code. It hides the presentation details from the code while providing a contractual access @@ -79,8 +80,10 @@ QT_BEGIN_NAMESPACE \note There is a performance cost for each registered DataInput, so try to avoid creating unnecessary DataInputs. - \sa Presentation, DataOutput, Presentation::slideExited, Presentation::slideEntered - \sa Presentation::customSignalEmitted + \sa Presentation, DataOutput + \sa {QtStudio3D.OpenGL::Presentation::slideExited()}{Presentation.slideExited()} + \sa {QtStudio3D.OpenGL::Presentation::slideEntered()}{Presentation.slideEntered()} + \sa {QtStudio3D.OpenGL::Presentation::customSignalEmitted()}{Presentation.customSignalEmitted()} */ /*! @@ -109,6 +112,10 @@ QT_BEGIN_NAMESPACE */ /*! + \dontdocument QMetaTypeId +*/ + +/*! \internal */ Q3DSDataInput::Q3DSDataInput(QObject *parent) @@ -128,6 +135,8 @@ Q3DSDataInput::Q3DSDataInput(const QString &name, QObject *parent) } /*! + \fn Q3DSDataInput::Q3DSDataInput(Q3DSPresentation *presentation, const QString &name, QObject *parent) + Constructs a Q3DSDataInput instance and initializes the \a name. The constructed instance is automatically associated with the specified \a presentation. An optional \a parent object can be specified. @@ -284,6 +293,8 @@ bool Q3DSDataInput::isValid() const } /*! + \qmlmethod string DataInput::metadata(string key) + Returns the metadata defined for this datainput with metadata \a key. Metadata is user-defined key-value table that can be used, for example, to better describe the @@ -292,8 +303,8 @@ bool Q3DSDataInput::isValid() const \note Datainput metadata is read-only. */ + /*! - \qmlmethod string DataInput::metadata Returns the metadata defined for this datainput with metadata \a key. Metadata is user-defined key-value table that can be used, for example, to better describe the diff --git a/src/api/studio3d/q3dsdataoutput.cpp b/src/api/studio3d/q3dsdataoutput.cpp index 3cb13a0..9ca0d03 100644 --- a/src/api/studio3d/q3dsdataoutput.cpp +++ b/src/api/studio3d/q3dsdataoutput.cpp @@ -34,9 +34,10 @@ /*! \qmltype DataOutput \instantiates Q3DSDataOutput - \inqmlmodule Qt3DStudio + \inqmlmodule QtStudio3D.OpenGL \ingroup OpenGLRuntime \brief Provides notifications from data output entries in Qt 3D Studio presentation. + This class is a convenience class for listening for changes in the Qt 3D Studio presentation attributes. DataOutput provides a clean contract between the presentation design and the code. It hides the presentation details from the code while providing a @@ -59,6 +60,7 @@ \inmodule OpenGLRuntime \since Qt 3D Studio 2.4 \brief Provides notifications from data output entries in Qt 3D Studio presentation. + This class is a convenience class for listening for changes in the Qt 3D Studio presentation attributes. DataOutput provides a clean contract between the presentation design and the code. It hides the presentation details from the code while providing a @@ -66,8 +68,8 @@ (e.g. movement of an element in the presentation due to timeline animation). DataOutput can be attached to same attributes in the design as DataInput is, including - presentation timeline. Only excaption is slide changes Slide changes are already notified - through \c{Q3DSPresentation::slideEntered} and \c{Q3DSPresentation::slideExited} signals. + presentation timeline. Only exception is slide changes (slide changes are already notified + through \c{Q3DSPresentation::slideEntered} and \c{Q3DSPresentation::slideExited} signals). \note There is a performance cost for each registered DataOutput, so try to avoid creating unnecessary DataOutputs. @@ -135,7 +137,8 @@ void Q3DSDataOutput::setName(const QString &name) } /*! - \qmlproperty DataOutput::value + \qmlproperty var DataOutput::value + \readonly Contains the read-only value of the controlled data output element in the presentation. @@ -161,17 +164,17 @@ QVariant Q3DSDataOutput::value() const } /*! - * \qmlsignal DataOutput::valueChanged - Emitted when the value of the observed DataOutput has changed in the - presentation. - \param newValue The new value of the observed DataOutput. + \qmlsignal DataOutput::valueChanged(var newValue) + + Emitted when the value of the observed DataOutput has changed to + \a newValue in the presentation. */ /*! - \fn Q3DSDataOutput::valueChanged - Emitted when the value of the observed DataOutput has changed in the - presentation. - \param newValue The new value of the observed DataOutput. + \fn Q3DSDataOutput::valueChanged(const QVariant &newValue) + + Emitted when the value of the observed DataOutput has changed to + \a newValue in the presentation. */ /*! diff --git a/src/api/studio3d/q3dselement.cpp b/src/api/studio3d/q3dselement.cpp index 16ae110..5731001 100644 --- a/src/api/studio3d/q3dselement.cpp +++ b/src/api/studio3d/q3dselement.cpp @@ -40,7 +40,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype Element \instantiates Q3DSElement - \inqmlmodule Qt3DStudio + \inqmlmodule QtStudio3D.OpenGL \ingroup OpenGLRuntime \brief Control type for elements in a Qt 3D Studio presentation. @@ -64,7 +64,7 @@ QT_BEGIN_NAMESPACE \inmodule OpenGLRuntime \since Qt 3D Studio 2.0 - \brief Controls a scene object (node) in a Qt 3D Studio presentation. + \brief Controls a scene object (element) in a Qt 3D Studio presentation. This class is provided for backwards compatibility. We recommend using DataInput and DataOutput APIs for contractual and clean API between @@ -74,7 +74,7 @@ QT_BEGIN_NAMESPACE object (such as, model, material, camera, layer) in a Qt 3D Studio presentation. - \sa Q3DSWidget, Q3DSSurfaceViewer, Q3DSSceneElement + \sa Q3DSSurfaceViewer, Q3DSSceneElement */ /*! diff --git a/src/api/studio3d/q3dspresentation.cpp b/src/api/studio3d/q3dspresentation.cpp index 62bff0a..4990da7 100644 --- a/src/api/studio3d/q3dspresentation.cpp +++ b/src/api/studio3d/q3dspresentation.cpp @@ -79,9 +79,54 @@ QT_BEGIN_NAMESPACE information is available regardless. \note This class should not be instantiated directly when working with the - C++ APIs. Q3DSSurfaceViewer and Q3DSWidget create a Q3DSPresentation + C++ APIs. Q3DSSurfaceViewer creates a Q3DSPresentation instance implicitly. This can be queried via - Q3DSSurfaceViewer::presentation() or Q3DSWidget::presentation(). + Q3DSSurfaceViewer::presentation(). + */ + +/*! + \qmltype Presentation + \instantiates Q3DSPresentationItem + \inqmlmodule QtStudio3D.OpenGL + \ingroup OpenGLRuntime + \inherits Q3DSPresentation + \keyword Studio3D + + \brief Represents a Qt 3D Studio presentation. + + This item provides properties and methods for controlling a + presentation. + + Qt 3D Studio supports multiple presentations in one project. There + is always a main presentation and zero or more + sub-presentations. The sub-presentations are composed into the + main presentations either as contents of Qt 3D Studio layers or as + texture maps. + + In the filesystem each presentation corresponds to one \c{.uip} + presentation file. When present, the \c{.uia} project file ties + these together by specifying a name for each of the + (sub-)presentations and specifies which one is the main one. + + The \c{.uia} project also defines \l{DataInput}s and + \l{DataOutput}s that are exported by the presentations. + \l{DataInput}s provide a way to provide input to the presentation + to e.g. control a timeline of a subpresentation from code. + \l{DataOutput}s provide a way to get notified when an attribute + is changed in the presentation by animation timeline, + by behavior scripts or by a \l{DataInput}. + + The Presentation type handles child objects of the types \l Element, \l + SceneElement, \l DataInput, \l DataOutput, and \l SubPresentationSettings specially. These + will get automatically associated with the presentation and can control + certain aspects of it from that point on. + + From the API point of view Presentation corresponds to the + main presentation. The source property can refer either to a + \c{.uia} or \c{.uip} file. When specifying a file with \c{.uip} + extension and a \c{.uia} is present with the same name, the + \c{.uia} is loaded automatically and thus sub-presentation + information is available regardless. */ /*! @@ -299,7 +344,7 @@ Q3DSDataOutput *Q3DSPresentation::registeredDataOutput(const QString &name) cons interface to set a datainput value using datainput name, or call Q3DSDataInput::setValue directly for a specific datainput. - \sa setDataInputValue + \sa setDataInputValue() \sa Q3DSDataInput */ QVector<Q3DSDataInput *> Q3DSPresentation::dataInputs() const @@ -327,7 +372,7 @@ QVector<Q3DSDataInput *> Q3DSPresentation::dataInputs() const interface to set a datainput value using datainput name, or call Q3DSDataInput::setValue directly for a specific datainput. - \sa setDataInputValue + \sa setDataInputValue() \sa Q3DSDataInput */ QVariantList Q3DSPresentation::getDataInputs() const @@ -342,19 +387,19 @@ QVariantList Q3DSPresentation::getDataInputs() const } /*! + \qmlmethod var Presentation::getDataInputs(string metadataKey) Returns a list of datainputs defined for this presentation that have the specified \a metadataKey. - \sa setDataInputValue - \sa Q3DSDataInput + \sa DataInput */ /*! - \qmlmethod var Presentation::getDataInputs Returns a list of datainputs defined for this presentation that have the specified \a metadataKey. - \sa DataInput + \sa setDataInputValue() + \sa Q3DSDataInput */ QVariantList Q3DSPresentation::getDataInputs(const QString &metadataKey) const { @@ -371,7 +416,7 @@ QVariantList Q3DSPresentation::getDataInputs(const QString &metadataKey) const Returns a list of datainputs defined for this presentation that have the specified \a metadataKey. - \sa setDataInputValue + \sa setDataInputValue() \sa Q3DSDataInput */ QVector<Q3DSDataInput *> Q3DSPresentation::dataInputs(const QString &metadataKey) const @@ -405,7 +450,7 @@ QVector<Q3DSDataOutput *> Q3DSPresentation::dataOutputs() const \c{valueChanged()} signal in the required \l{DataOutput}s to get notified when the value tracked by the DataOutput is changed. - \sa SDataOutput + \sa Q3DSDataOutput */ /*! * \brief Q3DSPresentation::getDataOutputs Returns \l{DataOutput}s. @@ -465,16 +510,44 @@ void Q3DSPresentation::setDelayedLoading(bool enable) } /*! - \qmlmethod Presentation::preloadSlide - Preloads slide resources to memory. All resources required by the given slide will be - loaded in the background. This function has effect only when delayed loading is enabled. - \param elementPath + \qmlmethod Presentation::preloadSlide(string elementPath) + + Preloads slide resources identified by \a elementPath to memory. All resources required + by the given slide will load in the background. + + \a elementPath is the identifier of a slide in a presentation and component. + + The presentation, component and slide are separated by ":", for example + My-presentation:Scene.Layer.Speedometer:Main-slide. + + If \a elementPath does not contain any ":", then it specifies the name of a slide in the + main presentation and main component. If it contains one ":", it specifies component:slide + in the main presentation, and if it contains two ":", it + specifies presentation:component:slide. + + If you want to indicate the main slide in a sub-presentation, you will need to specify the + full path. For example My-sub-presentation:Scene:Main-slide. + + This function has effect only when delayed loading is enabled. */ /*! - \brief Q3DSPresentation::preloadSlide - Preloads slide resources to memory. All resources required by the given slide will be - loaded in the background. This function has effect only when delayed loading is enabled. - \param elementPath + Preloads slide resources identified by \a elementPath to memory. All resources required + by the given slide will load in the background. + + \a elementPath is the identifier of a slide in a presentation and component. + + The presentation, component and slide are separated by ":", for example + My-presentation:Scene.Layer.Speedometer:Main-slide. + + If \a elementPath does not contain any ":", then it specifies the name of a slide in the + main presentation and main component. If it contains one ":", it specifies component:slide + in the main presentation, and if it contains two ":", it + specifies presentation:component:slide. + + If you want to indicate the main slide in a sub-presentation, you will need to specify the + full path. For example My-sub-presentation:Scene:Main-slide. + + This function has effect only when delayed loading is enabled. */ void Q3DSPresentation::preloadSlide(const QString &elementPath) { @@ -485,17 +558,45 @@ void Q3DSPresentation::preloadSlide(const QString &elementPath) } /*! - \qmlmethod Presentation::unloadSlide - Unloads slide resources from memory. If the slide is current, then the resources are unloaded - when the slide is changed. This function has effect only when delayed loading is enabled. - \param elementPath + \qmlmethod Presentation::unloadSlide(string elementPath) + + Unloads slide resources identified by \a elementPath from memory. If the + slide is current, the resources are unloaded when the slide is changed. + + \a elementPath is the identifier of a slide in a presentation and component. + + The presentation, component and slide are separated by ":", for example + my-presentation:Scene.Layer.Speedometer:Main-slide. + + If \a elementPath does not contain any ":", then it specifies the name of a slide in the + main presentation and main component. If it contains one ":", it specifies component:slide + in the main presentation, and if it contains two ":", it + specifies presentation:component:slide. + + If you want to indicate the main slide in a sub-presentation, you will need to specify the + full path. For example My-sub-presentation:Scene:Main-slide. + + This function has effect only when delayed loading is enabled. */ /*! - \brief Q3DSPresentation::unloadSlide - Unloads slide resources from memory. If the slide is current, then the resources are unloaded - when the slide is changed. This function has effect only when delayed loading is enabled. - \param elementPath + Unloads slide resources identified by \a elementPath from memory. If the + slide is current, the resources are unloaded when the slide is changed. + + \a elementPath is the identifier of a slide in a presentation and component. + + The presentation, component and slide are separated by ":", for example + My-presentation:speedometer:main-slide. + + If \a elementPath does not contain any ":", then it specifies the name of a slide in the + main presentation and main component. If it contains one ":", it specifies component:slide + in the main presentation, and if it contains two ":", it + specifies presentation:Scene.Layer.Speedometer:Main-slide. + + If you want to indicate the main slide in a sub-presentation, you will need to specify the + full path. For example My-sub-presentation:Scene:Main-slide. + + This function has effect only when delayed loading is enabled. */ void Q3DSPresentation::unloadSlide(const QString &elementPath) { @@ -506,7 +607,7 @@ void Q3DSPresentation::unloadSlide(const QString &elementPath) } /*! - This API is for backwards compatibility. We recommend using \l{DataInput}s to control + This function is for backwards compatibility. We recommend using \l{DataInput}s to control slide changes. \l{DataInput} provides stronger contract between the design and code as it avoids use of elementPath (a reference to design's internal structure). @@ -531,7 +632,7 @@ void Q3DSPresentation::goToSlide(const QString &elementPath, unsigned int index) } /*! - This API is for backwards compatibility. We recommend using \l{DataInput}s to control + This function is for backwards compatibility. We recommend using \l{DataInput}s to control slide changes. \l{DataInput} provides stronger contract between the design and code as it avoids use of elementPath (a reference to design's internal structure). @@ -557,7 +658,7 @@ void Q3DSPresentation::goToSlide(const QString &elementPath, const QString &name } /*! - This API is for backwards compatibility. We recommend using \l{DataInput}s to control + This function is for backwards compatibility. We recommend using \l{DataInput}s to control slide changes. \l{DataInput} provides stronger contract between the design and code as it avoids use of elementPath (a reference to design's internal structure). @@ -584,12 +685,12 @@ void Q3DSPresentation::goToSlide(const QString &elementPath, bool next, bool wra } /*! - This API is for backwards compatibility. We recommend using \l{DataInput}s to control + This function is for backwards compatibility. We recommend using \l{DataInput}s to control slide changes. \l{DataInput} provides stronger contract between the design and code as it avoids use of elementPath (a reference to design's internal structure). Moves the timeline for a time context (a Scene or a Component element) to a - specific position. The position is given in seconds in \a timeSeconds. + specific position. The position is given in seconds in \a time. If \a elementPath points to a time context, that element is controlled. For all other element types the time context owning @@ -624,7 +725,7 @@ void Q3DSPresentation::goToTime(const QString &elementPath, float time) } /*! - This API is for backwards compatibility. We recommend using \l{DataInput}s to control + This function is for backwards compatibility. We recommend using \l{DataInput}s to control attributes in the presentation. \l{DataInput} provides stronger contract between the design and code as it avoids use of elementPath (a reference to design's internal structure). @@ -784,12 +885,12 @@ void Q3DSPresentation::setDataInputValue(const QString &name, const QVariant &va support removing strings for performance reasons, so always using new unique names will leak memory. - \sa createElements - \sa createMaterial - \sa createMesh - \sa elementsCreated - \sa setAttribute - \sa dataInputs + \sa createElements() + \sa createMaterial() + \sa createMesh() + \sa elementsCreated() + \sa setAttribute() + \sa dataInputs() */ void Q3DSPresentation::createElement(const QString &parentElementPath, const QString &slideName, const QHash<QString, QVariant> &properties) @@ -804,8 +905,8 @@ void Q3DSPresentation::createElement(const QString &parentElementPath, const QSt specified with \a slideName. Element properties are specified in \a properties. For more details, see createElement(). - \sa createElement - \sa elementsCreated + \sa createElement() + \sa elementsCreated() */ void Q3DSPresentation::createElements(const QString &parentElementPath, const QString &slideName, const QVector<QHash<QString, QVariant>> &properties) @@ -826,8 +927,8 @@ void Q3DSPresentation::createElements(const QString &parentElementPath, const QS Deleting elements is supported only for elements that have been dynamically created with createElement() or createElements(). - \sa deleteElements - \sa createElement + \sa deleteElements() + \sa createElement() */ void Q3DSPresentation::deleteElement(const QString &elementPath) { @@ -841,7 +942,7 @@ void Q3DSPresentation::deleteElement(const QString &elementPath) Deleting elements is supported only for elements that have been dynamically created with createElement() or createElements(). - \sa deleteElement + \sa deleteElement() */ void Q3DSPresentation::deleteElements(const QStringList &elementPaths) { @@ -858,6 +959,7 @@ void Q3DSPresentation::deleteElements(const QStringList &elementPaths) /*! \qmlproperty list<string> Presentation::createdElements + \readonly This property contains a list of all dynamically created elements on this presentation. @@ -865,8 +967,8 @@ void Q3DSPresentation::deleteElements(const QStringList &elementPaths) \note Elements can only be dynamically created via C++ API. - \sa createElement - \sa createElements + \sa createElement() + \sa createElements() */ /*! @@ -876,8 +978,8 @@ void Q3DSPresentation::deleteElements(const QStringList &elementPaths) This property is read-only. - \sa createElement - \sa createElements + \sa createElement() + \sa createElements() */ QStringList Q3DSPresentation::createdElements() const { @@ -916,9 +1018,9 @@ QStringList Q3DSPresentation::createdElements() const Typical symptom of this is black texture on another element after creating a new element using the custom material. - \sa createMaterials - \sa createElement - \sa materialsCreated + \sa createMaterials() + \sa createElement() + \sa materialsCreated() */ void Q3DSPresentation::createMaterial(const QString &materialDefinition, const QString &subPresId) @@ -935,8 +1037,8 @@ void Q3DSPresentation::createMaterial(const QString &materialDefinition, For more details, see createMaterial(). - \sa createMaterial - \sa materialsCreated + \sa createMaterial() + \sa materialsCreated() */ void Q3DSPresentation::createMaterials(const QStringList &materialDefinitions, const QString &subPresId) @@ -959,8 +1061,8 @@ void Q3DSPresentation::createMaterials(const QStringList &materialDefinitions, Deleting materials is supported only for materials that have been dynamically created with createMaterial() or createMaterials(). - \sa deleteMaterials - \sa createMaterial + \sa deleteMaterials() + \sa createMaterial() */ void Q3DSPresentation::deleteMaterial(const QString &materialName) { @@ -977,7 +1079,7 @@ void Q3DSPresentation::deleteMaterial(const QString &materialName) Deleting materials is supported only for materials that have been dynamically created with createMaterial() or createMaterials(). - \sa deleteMaterial + \sa deleteMaterial() */ void Q3DSPresentation::deleteMaterials(const QStringList &materialNames) { @@ -994,6 +1096,7 @@ void Q3DSPresentation::deleteMaterials(const QStringList &materialNames) /*! \qmlproperty list<string> Presentation::createdMaterials + \readonly This property contains a list of all dynamically created materials on this presentation. @@ -1001,8 +1104,8 @@ void Q3DSPresentation::deleteMaterials(const QStringList &materialNames) \note Materials can only be dynamically created via C++ API. - \sa createMaterial - \sa createMaterials + \sa createMaterial() + \sa createMaterials() */ /*! @@ -1012,8 +1115,8 @@ void Q3DSPresentation::deleteMaterials(const QStringList &materialNames) This property is read-only. - \sa createMaterial - \sa createMaterials + \sa createMaterial() + \sa createMaterials() */ QStringList Q3DSPresentation::createdMaterials() const { @@ -1026,9 +1129,9 @@ QStringList Q3DSPresentation::createdMaterials() const The mesh is ready for use once meshesCreated() signal is received for it. - \sa createElement - \sa createMeshes - \sa meshesCreated + \sa createElement() + \sa createMeshes() + \sa meshesCreated() */ void Q3DSPresentation::createMesh(const QString &meshName, const Q3DSGeometry &geometry) { @@ -1045,12 +1148,12 @@ void Q3DSPresentation::createMesh(const QString &meshName, const Q3DSGeometry &g \note If your application is creating and deleting a lot of meshes, it is recommended that you reuse previously deleted mesh names when creating new materials. - This is because the internal string table implementation of Qt 3D Studio ogl-runtime doesn't + This is because the internal string table implementation of \RUNTIME doesn't support removing strings for performance reasons, so always using new unique names will leak memory. - \sa createMesh - \sa meshesCreated + \sa createMesh() + \sa meshesCreated() */ void Q3DSPresentation::createMeshes(const QHash<QString, const Q3DSGeometry *> &meshData) { @@ -1076,8 +1179,8 @@ void Q3DSPresentation::createMeshes(const QHash<QString, const Q3DSGeometry *> & Deleting meshes is supported only for meshes that have been dynamically created with createMesh() or createMeshes(). - \sa deleteMeshes - \sa createMesh + \sa deleteMeshes() + \sa createMesh() */ void Q3DSPresentation::deleteMesh(const QString &meshName) { @@ -1091,7 +1194,7 @@ void Q3DSPresentation::deleteMesh(const QString &meshName) Deleting meshes is supported only for meshes that have been dynamically created with createMesh() or createMeshes(). - \sa deleteMesh + \sa deleteMesh() */ void Q3DSPresentation::deleteMeshes(const QStringList &meshNames) { @@ -1108,6 +1211,7 @@ void Q3DSPresentation::deleteMeshes(const QStringList &meshNames) /*! \qmlproperty list<string> Presentation::createdMeshes + \readonly This property contains a list of all dynamically created meshes on this presentation. @@ -1115,8 +1219,8 @@ void Q3DSPresentation::deleteMeshes(const QStringList &meshNames) \note Meshes can only be dynamically created via C++ API. - \sa createMesh - \sa createMeshes + \sa createMesh() + \sa createMeshes() */ /*! @@ -1126,8 +1230,8 @@ void Q3DSPresentation::deleteMeshes(const QStringList &meshNames) This property is read-only. - \sa createMesh - \sa createMeshes + \sa createMesh() + \sa createMeshes() */ QStringList Q3DSPresentation::createdMeshes() const { @@ -1233,123 +1337,124 @@ void Q3DSPresentation::keyReleaseEvent(QKeyEvent *e) // #TODO: QT3DS-3562 Most Presentation signals missing documentation /*! - * \qmlsignal Presentation::slideEntered - * Emitted when - * \param elementPath - * \param index - * \param name + \qmlsignal Presentation::slideEntered(string elementPath, int index, string name) + //! TODO */ /*! - * \fn Q3DSPresentation::slideEntered - * Emitted when - * \param elementPath - * \param index - * \param name + \fn Q3DSPresentation::slideEntered(const QString &elementPath, unsigned int index, const QString &name) + //! TODO */ /*! - * \qmlsignal Presentation::slideExited - * Emitted when - * \param elementPath - * \param index - * \param name + \qmlsignal Presentation::slideExited(string elementPath, int index, string name) + //! TODO */ /*! - * \fn Q3DSPresentation::slideExited - * Emitted when - * \param elementPath - * \param index - * \param name - */ + \fn Q3DSPresentation::slideExited(const QString &elementPath, unsigned int index, const QString &name) + //! TODO +*/ /*! - * \fn Q3DSPresentation::dataInputsReady - * Emitted when \l{DataInput}s in the Studio project have been parsed and data inputs are available - * through dataInputs() and getDataInputs() methods. - */ + \fn Q3DSPresentation::dataInputsReady() + + Emitted when \l{DataInput}s in the Studio project have been parsed and data inputs are available + through dataInputs() and getDataInputs() methods. +*/ /*! - * \fn Q3DSPresentation::dataOutputsReady - * Emitted when \l{DataOutput}s in the Studio project have been parsed and data outputs are available - * through dataOutputs() and getDataOutputs() methods. + \fn Q3DSPresentation::dataOutputsReady() + + Emitted when \l{DataOutput}s in the Studio project have been parsed and data outputs are available + through dataOutputs() and getDataOutputs() methods. */ /*! - * \qmlsignal Presentation::customSignalEmitted - * Emitted when - * \param elementPath - * \param name + \qmlsignal Presentation::customSignalEmitted(string elementPath, string name) + //! TODO */ /*! - * \fn Q3DSPresentation::customSignalEmitted - * Emitted when - * \param elementPath - * \param name + \fn Q3DSPresentation::customSignalEmitted(const QString &elementPath, const QString &name) + //! TODO */ /*! - \qmlsignal Presentation::elementsCreated + \qmlsignal Presentation::elementsCreated(list<string> elementPaths, string error) + Emitted when one or more elements have been created in response to createElement() or createElements() calls. The \a elementPaths list contains the element paths of the created - elements. If creation failed, \a error string indicates the reason. + elements. + + If creation failed, \a error string indicates the reason. - \sa createElement - \sa createElements + \sa createElement() + \sa createElements() */ /*! - \fn Q3DSPresentation::elementsCreated + \fn Q3DSPresentation::elementsCreated(const QStringList &elementPaths, const QString &error) + Emitted when one or more elements have been created in response to createElement() or createElements() calls. The \a elementPaths list contains the element paths of the created elements. If creation failed, \a error string indicates the reason. - \sa createElement - \sa createElements + \sa createElement() + \sa createElements() */ /*! - \qmlsignal Presentation::materialsCreated + \qmlsignal Presentation::materialsCreated(list<string> materialNames, string error) + Emitted when one or more materials have been created in response to createMaterial() or createMaterials() calls. The \a materialNames list contains the names of the created materials. If the material is created into a subpresentation, the name is prefixed with subpresentation ID followed by a colon. + If creation failed, \a error string indicates the reason. - \sa createMaterial - \sa createMaterials + \sa createMaterial() + \sa createMaterials() */ /*! - \fn Q3DSPresentation::materialsCreated + \fn Q3DSPresentation::materialsCreated(const QStringList &materialNames, const QString &error) + Emitted when one or more materials have been created in response to createMaterial() or createMaterials() calls. The \a materialNames list contains the names of the created - materials. If creation failed, \a error string indicates the reason. + materials. - \sa createMaterial - \sa createMaterials + If creation failed, \a error string indicates the reason. + + \sa createMaterial() + \sa createMaterials() */ /*! - \qmlsignal Presentation::meshesCreated + \qmlsignal Presentation::meshesCreated(list<string> meshNames, string error) + Emitted when one or more meshes have been created in response to createMesh() or createMeshes() calls. The \a meshNames list contains the names of the created - meshes. If creation failed, \a error string indicates the reason. + meshes. - \sa createMesh - \sa createMeshes + If creation failed, \a error string indicates the reason. + + \sa createMesh() + \sa createMeshes() */ /*! - \fn Q3DSPresentation::meshesCreated + \fn Q3DSPresentation::meshesCreated(const QStringList &meshNames, const QString &error) + Emitted when one or more meshes have been created in response to createMesh() or createMeshes() calls. The \a meshNames list contains the names of the created - meshes. If creation failed, \a error string indicates the reason. + meshes. + + If creation failed, \a error string indicates the reason. - \sa createMesh - \sa createMeshes + \sa createMesh() + \sa createMeshes() */ /*! diff --git a/src/api/studio3d/q3dssceneelement.cpp b/src/api/studio3d/q3dssceneelement.cpp index 3f860d6..8de03eb 100644 --- a/src/api/studio3d/q3dssceneelement.cpp +++ b/src/api/studio3d/q3dssceneelement.cpp @@ -40,7 +40,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype SceneElement \instantiates Q3DSSceneElement - \inqmlmodule Qt3DStudio + \inqmlmodule QtStudio3D.OpenGL \ingroup OpenGLRuntime \brief Controls the special Scene or Component scene objects in a Qt 3D Studio presentation. @@ -70,7 +70,7 @@ QT_BEGIN_NAMESPACE \note The functionality of Q3DSSceneElement is equivalent to Q3DSPresentation::goToTime() and Q3DSPresentation::goToSlide(). - \sa Q3DSPresentation, Q3DSWidget, Q3DSSurfaceViewer, Q3DSElement + \sa Q3DSPresentation, Q3DSSurfaceViewer, Q3DSElement */ /*! @@ -156,11 +156,10 @@ void Q3DSSceneElement::setCurrentSlideIndex(int currentSlideIndex) } /*! - \property int SceneElement::previousSlideIndex + \qmlproperty int SceneElement::previousSlideIndex + \readonly Holds the index of the previously active slide of the tracked time context. - - Note: This property is read-only. */ /*! \property Q3DSSceneElement::previousSlideIndex @@ -224,11 +223,10 @@ void Q3DSSceneElement::setCurrentSlideName(const QString ¤tSlideName) } /*! - \qmlmproperty string SceneElement::previousSlideName + \qmlproperty string SceneElement::previousSlideName + \readonly Holds the name of the previously active slide of the tracked time context. - - Note: This property is read-only. */ /*! \property Q3DSSceneElement::previousSlideName @@ -257,7 +255,7 @@ void Q3DSSceneElement::goToSlide(bool next, bool wrap) /*! Moves the timeline for a time context (a Scene or a Component element) to a - specific position. The position is given in seconds in \a timeSeconds. + specific position. The position is given in seconds in \a time. */ void Q3DSSceneElement::goToTime(float time) { diff --git a/src/api/studio3d/q3dssurfaceviewer.cpp b/src/api/studio3d/q3dssurfaceviewer.cpp index 32ffb99..48e5e25 100644 --- a/src/api/studio3d/q3dssurfaceviewer.cpp +++ b/src/api/studio3d/q3dssurfaceviewer.cpp @@ -94,7 +94,6 @@ QT_BEGIN_NAMESPACE } \endcode - \sa Q3DSWidget */ /*! diff --git a/src/api/studio3d/q3dsviewersettings.cpp b/src/api/studio3d/q3dsviewersettings.cpp index 187729a..01f82df 100644 --- a/src/api/studio3d/q3dsviewersettings.cpp +++ b/src/api/studio3d/q3dsviewersettings.cpp @@ -40,11 +40,11 @@ QT_BEGIN_NAMESPACE /*! \qmltype ViewerSettings \instantiates Q3DSViewerSettings - \inqmlmodule Qt3DStudio + \inqmlmodule QtStudio3D.OpenGL \ingroup OpenGLRuntime \brief Qt 3D Studio presentation viewer settings. - This type provides properties to define presentation independent viewer settings. + This type provides properties to define presentation-independent viewer settings. \note ViewerSettings are only applicable when \l Studio3D is used in the default mode, showing the final, composed image from the Qt 3D Studio @@ -60,13 +60,12 @@ QT_BEGIN_NAMESPACE \brief Qt 3D Studio presentation viewer settings. - Q3DSViewerSettings provides properties to define presentation independent + Q3DSViewerSettings provides properties to define presentation-independent viewer settings. \note This class should not be instantiated directly when working with the - C++ APIs. Q3DSSurfaceViewer and Q3DSWidget create a Q3DSViewerSettings - instance implicitly. This can be queried via Q3DSSurfaceViewer::settings() - or Q3DSWidget::settings(). + C++ APIs. Q3DSSurfaceViewer creates a Q3DSViewerSettings + instance implicitly. This can be queried via Q3DSSurfaceViewer::settings(). */ /*! @@ -156,11 +155,15 @@ void Q3DSViewerSettings::setShowRenderStats(bool show) } } -/*! - \qmlproperty ViewerSettings::shadeMode +/* + //! TODO + \internal + \qmlproperty enumeration ViewerSettings::shadeMode */ -/*! +/* + // TODO + \internal \property Q3DSViewerSettings::shadeMode */ Q3DSViewerSettings::ShadeMode Q3DSViewerSettings::shadeMode() const @@ -226,20 +229,15 @@ void Q3DSViewerSettings::setScaleMode(Q3DSViewerSettings::ScaleMode mode) } /*! - \qmmlmethod ViewerSettings::save + \qmlmethod ViewerSettings::save(string group, string organization, string application) + Persistently saves the viewer \l{QSettings}{settings} using \a group, \a organization and \a application. - \param group - \param organization - \param application */ + /*! - * \brief Q3DSViewerSettings::save Persistently saves the viewer \l{QSettings}{settings} Persistently saves the viewer \l{QSettings}{settings} using \a group, \a organization and \a application. - \param group - \param organization - \param application */ void Q3DSViewerSettings::save(const QString &group, const QString &organization, const QString &application) @@ -248,20 +246,14 @@ void Q3DSViewerSettings::save(const QString &group, const QString &organization, } /*! - \qmlmethod ViewerSettings::load + \qmlmethod ViewerSettings::load(string group, string organization, string application) Loads previously saved viewer \l{QSettings}{settings} using \a group, \a organization and \a application. - \param group - \param organization - \param application */ + /*! - * \brief Q3DSViewerSettings::load Loads previously saved viewer \l{QSettings}{settings} Loads previously saved viewer \l{QSettings}{settings} using \a group, \a organization and \a application. - \param group - \param organization - \param application */ void Q3DSViewerSettings::load(const QString &group, const QString &organization, const QString &application) diff --git a/src/api/studio3d/studio3d.pro b/src/api/studio3d/studio3d.pro index 8b9fbb0..6749a57 100644 --- a/src/api/studio3d/studio3d.pro +++ b/src/api/studio3d/studio3d.pro @@ -3,6 +3,8 @@ TARGET = QtStudio3D include($$PWD/../../commoninclude.pri) QT += opengl widgets qml +include($$PWD/doc/doc.pri) + qtHaveModule(multimedia) { DEFINES += PLATFORM_HAS_QT_MULTIMEDIA_LIB QT += multimedia diff --git a/src/api/studio3dqml/q3dspresentationitem.cpp b/src/api/studio3dqml/q3dspresentationitem.cpp index 6372f2f..4eb7c96 100644 --- a/src/api/studio3dqml/q3dspresentationitem.cpp +++ b/src/api/studio3dqml/q3dspresentationitem.cpp @@ -37,50 +37,6 @@ QT_BEGIN_NAMESPACE -/*! - \qmltype Presentation - \instantiates Q3DSPresentationItem - \inqmlmodule QtStudio3D - \ingroup OpenGLRuntime - \inherits Q3DSPresentation - \keyword Studio3D - - \brief Represents a Qt 3D Studio presentation. - - This item provides properties and methods for controlling a - presentation. - - Qt 3D Studio supports multiple presentations in one project. There - is always a main presentation and zero or more - sub-presentations. The sub-presentations are composed into the - main presentations either as contents of Qt 3D Studio layers or as - texture maps. - - In the filesystem each presentation corresponds to one \c{.uip} - presentation file. When present, the \c{.uia} project file ties - these together by specifying a name for each of the - (sub-)presentations and specifies which one is the main one. - - The \c{.uia} project also defines \l{DataInput}s and - \l{DataOutput}s that are exported by the presentations. - \l{DataInput}s provide a way to provide input to the presentation - to e.g. control a timeline of a subpresentation from code. - \l{DataOutput}s provide a way to get notified when an attribute - is changed in the presentation by animation timeline, - by behavior scripts or by a \l{DataInput}. - - The Presentation type handles child objects of the types \l Element, \l - SceneElement, \l DataInput, and \l SubPresentationSettings specially. These - will get automatically associated with the presentation and can control - certain aspects of it from that point on. - - From the API point of view Presentation corresponds to the - main presentation. The source property can refer either to a - \c{.uia} or \c{.uip} file. When specifying a file with \c{.uip} - extension and a \c{.uia} is present with the same name, the - \c{.uia} is loaded automatically and thus sub-presentation - information is available regardless. - */ Q3DSPresentationItem::Q3DSPresentationItem(QObject *parent) : Q3DSPresentation(parent) , m_subPresentationSettings(nullptr) diff --git a/src/api/studio3dqml/q3dsstudio3d.cpp b/src/api/studio3dqml/q3dsstudio3d.cpp index 2cf8ed2..c7d4ace 100644 --- a/src/api/studio3dqml/q3dsstudio3d.cpp +++ b/src/api/studio3dqml/q3dsstudio3d.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype Studio3D \instantiates Q3DSStudio3D - \inqmlmodule QtStudio3D + \inqmlmodule QtStudio3D.OpenGL \ingroup OpenGLRuntime \inherits Item \keyword Studio3D diff --git a/src/qmlstreamer/q3dsqmlstream.cpp b/src/qmlstreamer/q3dsqmlstream.cpp index e1b9e85..c0dc6a2 100644 --- a/src/qmlstreamer/q3dsqmlstream.cpp +++ b/src/qmlstreamer/q3dsqmlstream.cpp @@ -32,7 +32,7 @@ /*! \qmltype QmlStream \instantiates Q3DSQmlStream - \inqmlmodule Qt3DStudio + \inqmlmodule QtStudio3D.OpenGL \ingroup OpenGLRuntime \brief Allows streaming of QML as subpresentation. @@ -43,12 +43,10 @@ \inmodule OpenGLRuntime \since Qt 3D Studio 2.0 \brief Allows streaming of QML as subpresentation. - \param parent */ /*! - * \brief Q3DSQmlStream::Q3DSQmlStream Constructor - * \param parent Optional parent object. + Constructs a Q3DSQmlStream object with \a parent as parent. */ Q3DSQmlStream::Q3DSQmlStream(QObject *parent) : QObject(parent) @@ -56,9 +54,6 @@ Q3DSQmlStream::Q3DSQmlStream(QObject *parent) { } -/*! - * \brief Q3DSQmlStream::~Q3DSQmlStream Destructor. - */ Q3DSQmlStream::~Q3DSQmlStream() { } diff --git a/src/qmlstreamer/q3dsqmlsubpresentationsettings.cpp b/src/qmlstreamer/q3dsqmlsubpresentationsettings.cpp index bde5ad3..664b9e4 100644 --- a/src/qmlstreamer/q3dsqmlsubpresentationsettings.cpp +++ b/src/qmlstreamer/q3dsqmlsubpresentationsettings.cpp @@ -33,9 +33,9 @@ /*! \qmltype SubPresentationSettings \instantiates Q3DSSubPresentationSettings - \inqmlmodule Qt3DStudio + \inqmlmodule QtStudio3D.OpenGL \ingroup OpenGLRuntime - \brief + \brief Settings for subpresentations. \sa Studio3D, Presentation, QmlStream */ @@ -44,7 +44,6 @@ \inmodule OpenGLRuntime \since Qt 3D Studio 2.0 \brief Settings for subpresentations. - \param parent \sa Q3DSPresentation, Q3DSQmlStream */ @@ -71,6 +70,9 @@ QQmlListProperty<Q3DSQmlStream> Q3DSSubPresentationSettings::qmlStreams() return QQmlListProperty<Q3DSQmlStream>(this, m_list); } +/*! + Returns the list of QML streams to be used as subpresentations. +*/ QList<Q3DSQmlStream *> Q3DSSubPresentationSettings::qmlStreamsList() { return m_list; |
