<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qscene2d.cpp -->
<title>Scene2D QML Type | 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 ><a href="qt3d-qml.html">QML Types</a></td><td >Scene2D QML Type</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="#properties">Properties</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Scene2D QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Scene2D-brief -->
<p>This type enables rendering qml into a texture, which then can be used as a part of 3D scene. <a href="#details">More...</a></p>
<!-- @@@Scene2D -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQuick.Scene2D 2.12</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.9</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="qml-qtquick-scene2d-scene2d.html"><a href="qt3drender-quick-qscene2d.html">QScene2D</a></td></tr></table></div><ul>
<li><a href="qml-qtquick-scene2d-scene2d-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtquick-scene2d-scene2d.html#entities-prop">entities</a></b></b> : list<Entity></li>
<li class="fn"><b><b><a href="qml-qtquick-scene2d-scene2d.html#item-prop">item</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-scene2d-scene2d.html#mouseEnabled-prop">mouseEnabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-scene2d-scene2d.html#output-prop">output</a></b></b> : RenderTargetOutput</li>
<li class="fn"><b><b><a href="qml-qtquick-scene2d-scene2d.html#renderPolicy-prop">renderPolicy</a></b></b> : enumeration</li>
</ul>
<!-- $$$Scene2D-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>This object uses RenderControl to render the given Item into an offscreen surface, which is attached to a texture provided by the user. This allows the component to directly render into the texture without intermediate copy and the user to freely specify how the texture is used in the 3D scene.</p>
<p>The entities using the <a href="qt3dscene2d-module.html#scene2d">Scene2D</a> can be associated with the type to enable interaction with the item; if an entity has an <a href="qml-qt3d-render-objectpicker.html">ObjectPicker</a> component, the pick events from that picker are sent to the <a href="qt3dscene2d-module.html#scene2d">Scene2D</a> and converted to mouse events and finally sent to the item.</p>
<p>Usage:</p>
<pre class="qml">
</pre>
<!-- @@@Scene2D -->
<h2>Property Documentation</h2>
<!-- $$$entities -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="entities-prop">
<td class="tblQmlPropNode"><p>
<a name="entities-prop"></a><span class="name">entities</span> : <span class="type">list</span><<span class="type"><a href="qml-qt3d-core-entity.html">Entity</a></span>></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds the list of entities which are associated with the <a href="qt3dscene2d-module.html#scene2d">Scene2D</a> object. If the entities have <a href="qml-qt3d-render-objectpicker.html">ObjectPicker</a>, the pick events from that entity are sent to <a href="qt3dscene2d-module.html#scene2d">Scene2D</a> and converted to mouse events.</p>
</div></div><!-- @@@entities -->
<br/>
<!-- $$$item -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="item-prop">
<td class="tblQmlPropNode"><p>
<a name="item-prop"></a><span class="name">item</span> : <span class="type">Item</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds the Item, which is rendered by <a href="qt3dscene2d-module.html#scene2d">Scene2D</a> to the texture.</p>
</div></div><!-- @@@item -->
<br/>
<!-- $$$mouseEnabled -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="mouseEnabled-prop">
<td class="tblQmlPropNode"><p>
<a name="mouseEnabled-prop"></a><span class="name">mouseEnabled</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds whether mouse events are enabled for the rendered item. The mouse events are generated from object picking events of the entities added to the <a href="qt3dscene2d-module.html#scene2d">Scene2D</a>. Mouse is enabled by default.</p>
<p><b>Note: </b>Events sent to items are delayed by one frame due to object picking happening in the backend.</p></div></div><!-- @@@mouseEnabled -->
<br/>
<!-- $$$output -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="output-prop">
<td class="tblQmlPropNode"><p>
<a name="output-prop"></a><span class="name">output</span> : <span class="type"><a href="qml-qt3d-render-rendertargetoutput.html">RenderTargetOutput</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds the <a href="qml-qt3d-render-rendertargetoutput.html">RenderTargetOutput</a>, which specifies where the <a href="qt3dscene2d-module.html#scene2d">Scene2D</a> is rendering to.</p>
</div></div><!-- @@@output -->
<br/>
<!-- $$$renderPolicy -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="renderPolicy-prop">
<td class="tblQmlPropNode"><p>
<a name="renderPolicy-prop"></a><span class="name">renderPolicy</span> : <span class="type">enumeration</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds the render policy of this <a href="qt3dscene2d-module.html#scene2d">Scene2D</a>.</p>
<ul>
<li>Continuous The <a href="qt3dscene2d-module.html#scene2d">Scene2D</a> is rendering continuously. This is the default render policy.</li>
<li>SingleShot The <a href="qt3dscene2d-module.html#scene2d">Scene2D</a> renders to the texture only once after which the resources allocated for rendering are released.</li>
</ul>
</div></div><!-- @@@renderPolicy -->
<br/>
</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>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
c936229ef0138f42857f36beadbeda30
>
files
>
437
