<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qt3dextras-module.qdoc -->
<title>Qt 3D Extras C++ Classes | Qt 3D 5.12.2</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.12</td><td ><a href="qt3d-index.html">Qt 3D</a></td><td >Qt 3D Extras C++ Classes</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qt3d-index.html">Qt 5.12.2 Reference Documentation</a></td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#classes">Classes</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
<li class="level2"><a href="#overview">Overview</a></li>
<li class="level2"><a href="#reference">Reference</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Qt 3D Extras C++ Classes</h1>
<span class="subtitle"></span>
<!-- $$$Qt3DExtras-brief -->
<p>The Qt 3D Extras module provides a set of prebuilt elements to help you get started with Qt 3D. <a href="#details">More...</a></p>
<!-- @@@Qt3DExtras -->
<p><b>This module is under development and is subject to change.</b></p>
<a name="classes"></a>
<h2 id="classes">Classes</h2>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qabstractcameracontroller.html">Qt3DExtras::QAbstractCameraController</a></p></td><td class="tblDescr"><p>Basic functionality for camera controllers</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qconegeometry.html">Qt3DExtras::QConeGeometry</a></p></td><td class="tblDescr"><p>Allows creation of a cone in 3D space. * * * * * The QConeGeometry class is most commonly used internally by the QConeMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses. The class * allows for creation of both a cone and a truncated cone</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qconemesh.html">Qt3DExtras::QConeMesh</a></p></td><td class="tblDescr"><p>A conical mesh</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qcuboidgeometry.html">Qt3DExtras::QCuboidGeometry</a></p></td><td class="tblDescr"><p>Allows creation of a cuboid in 3D space. * * * * * The QCuboidGeometry class is most commonly used internally by the QCuboidMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qcuboidmesh.html">Qt3DExtras::QCuboidMesh</a></p></td><td class="tblDescr"><p>A cuboid mesh</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qcylindergeometry.html">Qt3DExtras::QCylinderGeometry</a></p></td><td class="tblDescr"><p>Allows creation of a cylinder in 3D space. * * * * * The QCylinderGeometry class is most commonly used internally by the QCylinderMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qcylindermesh.html">Qt3DExtras::QCylinderMesh</a></p></td><td class="tblDescr"><p>A cylindrical mesh</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qdiffusespecularmaterial.html">Qt3DExtras::QDiffuseSpecularMaterial</a></p></td><td class="tblDescr"><p>Default implementation of the phong lighting effect</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qextrudedtextgeometry.html">Qt3DExtras::QExtrudedTextGeometry</a></p></td><td class="tblDescr"><p>Allows creation of a 3D extruded text in 3D space</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qextrudedtextmesh.html">Qt3DExtras::QExtrudedTextMesh</a></p></td><td class="tblDescr"><p>A 3D extruded Text mesh</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qfirstpersoncameracontroller.html">Qt3DExtras::QFirstPersonCameraController</a></p></td><td class="tblDescr"><p>Allows controlling the scene camera from the first person perspective</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qforwardrenderer.html">Qt3DExtras::QForwardRenderer</a></p></td><td class="tblDescr"><p>Default FrameGraph implementation of a forward renderer</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qgoochmaterial.html">Qt3DExtras::QGoochMaterial</a></p></td><td class="tblDescr"><p>Material that implements the Gooch shading model, popular in CAD and CAM applications</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qmetalroughmaterial.html">Qt3DExtras::QMetalRoughMaterial</a></p></td><td class="tblDescr"><p>Default implementation of PBR lighting</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qmorphphongmaterial.html">Qt3DExtras::QMorphPhongMaterial</a></p></td><td class="tblDescr"><p>Default implementation of the phong lighting effect</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qorbitcameracontroller.html">Qt3DExtras::QOrbitCameraController</a></p></td><td class="tblDescr"><p>Allows controlling the scene camera along orbital path</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qpervertexcolormaterial.html">Qt3DExtras::QPerVertexColorMaterial</a></p></td><td class="tblDescr"><p>Default implementation for rendering the color properties set for each vertex</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qplanegeometry.html">Qt3DExtras::QPlaneGeometry</a></p></td><td class="tblDescr"><p>Allows creation of a plane in 3D space. * * * * The QPlaneGeometry class is most commonly used internally by the QPlaneMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qplanemesh.html">Qt3DExtras::QPlaneMesh</a></p></td><td class="tblDescr"><p>A square planar mesh</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qskyboxentity.html">Qt3DExtras::QSkyboxEntity</a></p></td><td class="tblDescr"><p>Qt3DExtras::QSkyboxEntity is a convenience Qt3DCore::QEntity subclass that can be used to insert a skybox in a 3D scene</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qspheregeometry.html">Qt3DExtras::QSphereGeometry</a></p></td><td class="tblDescr"><p>Allows creation of a sphere in 3D space. * * * * * The QSphereGeometry class is most commonly used internally by the QSphereMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qspheremesh.html">Qt3DExtras::QSphereMesh</a></p></td><td class="tblDescr"><p>A spherical mesh</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qtext2dentity.html">Qt3DExtras::QText2DEntity</a></p></td><td class="tblDescr"><p>Allows creation of a 2D text in 3D space</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qtexturematerial.html">Qt3DExtras::QTextureMaterial</a></p></td><td class="tblDescr"><p>Default implementation of a simple unlit texture material</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qtorusgeometry.html">Qt3DExtras::QTorusGeometry</a></p></td><td class="tblDescr"><p>Allows creation of a torus in 3D space. * * * * * The QTorusGeometry class is most commonly used internally by the QTorusMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qtorusmesh.html">Qt3DExtras::QTorusMesh</a></p></td><td class="tblDescr"><p>A toroidal mesh</p></td></tr>
</table></div>
<!-- $$$Qt3DExtras-description -->
<a name="details"></a>
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>This module is still in development but is available as a technology preview. This means it is unstable, likely to change and provided as a convenience only.</p>
<pre class="cpp">
<span class="preprocessor">#include <Qt3DExtras></span>
</pre>
<p>To link against the corresponding C++ library, add the following to your qmake project file:</p>
<pre class="cpp plain">
QT += 3dextras
</pre>
<p>Classes, types, and functions are declared under the <a href="qt3dextras-sub-qt3d.html">Qt3DExtras</a> namespace.</p>
<a name="overview"></a>
<h3 >Overview</h3>
<a name="materials"></a>
<h4 >Materials</h4>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qdiffusespecularmaterial.html">Qt3DExtras::QDiffuseSpecularMaterial</a></p></td><td class="tblDescr"><p>Default implementation of the phong lighting effect</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qgoochmaterial.html">Qt3DExtras::QGoochMaterial</a></p></td><td class="tblDescr"><p>Material that implements the Gooch shading model, popular in CAD and CAM applications</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qmetalroughmaterial.html">Qt3DExtras::QMetalRoughMaterial</a></p></td><td class="tblDescr"><p>Default implementation of PBR lighting</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qmorphphongmaterial.html">Qt3DExtras::QMorphPhongMaterial</a></p></td><td class="tblDescr"><p>Default implementation of the phong lighting effect</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qpervertexcolormaterial.html">Qt3DExtras::QPerVertexColorMaterial</a></p></td><td class="tblDescr"><p>Default implementation for rendering the color properties set for each vertex</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qtexturematerial.html">Qt3DExtras::QTextureMaterial</a></p></td><td class="tblDescr"><p>Default implementation of a simple unlit texture material</p></td></tr>
</table></div>
<a name="meshes-and-geometries"></a>
<h4 >Meshes and Geometries</h4>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qconegeometry.html">Qt3DExtras::QConeGeometry</a></p></td><td class="tblDescr"><p>Allows creation of a cone in 3D space. * * * * * The QConeGeometry class is most commonly used internally by the QConeMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses. The class * allows for creation of both a cone and a truncated cone</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qconemesh.html">Qt3DExtras::QConeMesh</a></p></td><td class="tblDescr"><p>A conical mesh</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qcuboidgeometry.html">Qt3DExtras::QCuboidGeometry</a></p></td><td class="tblDescr"><p>Allows creation of a cuboid in 3D space. * * * * * The QCuboidGeometry class is most commonly used internally by the QCuboidMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qcuboidmesh.html">Qt3DExtras::QCuboidMesh</a></p></td><td class="tblDescr"><p>A cuboid mesh</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qcylindergeometry.html">Qt3DExtras::QCylinderGeometry</a></p></td><td class="tblDescr"><p>Allows creation of a cylinder in 3D space. * * * * * The QCylinderGeometry class is most commonly used internally by the QCylinderMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qcylindermesh.html">Qt3DExtras::QCylinderMesh</a></p></td><td class="tblDescr"><p>A cylindrical mesh</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qplanegeometry.html">Qt3DExtras::QPlaneGeometry</a></p></td><td class="tblDescr"><p>Allows creation of a plane in 3D space. * * * * The QPlaneGeometry class is most commonly used internally by the QPlaneMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qplanemesh.html">Qt3DExtras::QPlaneMesh</a></p></td><td class="tblDescr"><p>A square planar mesh</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qspheregeometry.html">Qt3DExtras::QSphereGeometry</a></p></td><td class="tblDescr"><p>Allows creation of a sphere in 3D space. * * * * * The QSphereGeometry class is most commonly used internally by the QSphereMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qspheremesh.html">Qt3DExtras::QSphereMesh</a></p></td><td class="tblDescr"><p>A spherical mesh</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qtorusgeometry.html">Qt3DExtras::QTorusGeometry</a></p></td><td class="tblDescr"><p>Allows creation of a torus in 3D space. * * * * * The QTorusGeometry class is most commonly used internally by the QTorusMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qtorusmesh.html">Qt3DExtras::QTorusMesh</a></p></td><td class="tblDescr"><p>A toroidal mesh</p></td></tr>
</table></div>
<a name="camera-controllers"></a>
<h4 >Camera Controllers</h4>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qt3dextras-qfirstpersoncameracontroller.html">Qt3DExtras::QFirstPersonCameraController</a></p></td><td class="tblDescr"><p>Allows controlling the scene camera from the first person perspective</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qt3dextras-qorbitcameracontroller.html">Qt3DExtras::QOrbitCameraController</a></p></td><td class="tblDescr"><p>Allows controlling the scene camera along orbital path</p></td></tr>
</table></div>
<a name="entities"></a>
<h4 >Entities</h4>
<ul>
<li><a href="qt3dextras-qskyboxentity.html">Qt3DExtras::QSkyboxEntity</a></li>
</ul>
<a name="framegraphs"></a>
<h4 >FrameGraphs</h4>
<ul>
<li><a href="qt3dextras-qforwardrenderer.html">Qt3DExtras::QForwardRenderer</a></li>
</ul>
<a name="window"></a>
<h4 >Window</h4>
<ul>
<li><a href="qt3dextras-qt3dwindow.html">Qt3DExtras::Qt3DWindow</a></li>
</ul>
<p><b>Note: </b>The Quick3DExtras module also specifies a Qt3DExtras::Quick::Qt3DQuickWindow.</p><a name="reference"></a>
<h3 >Reference</h3>
<ul>
<li><a href="qt3dextras-module.html">Qt 3D Extras C++ Classes</a></li>
<li><a href="qt3d-examples.html">Qt 3D Examples</a></li>
</ul>
</div>
<!-- @@@Qt3DExtras -->
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
