<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcustom3dvolume.cpp -->
<title>Custom3DVolume QML Type | Qt Data Visualization 5.12.6</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="qtdatavisualization-index.html">Qt Data Visualization</a></td><td ><a href="qtdatavisualization-qmlmodule.html">QML Types</a></td><td >Custom3DVolume QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtdatavisualization-index.html">Qt Data Visualization | Commercial or GPLv3</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">Custom3DVolume QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Custom3DVolume-brief -->
<p>Adds a volume rendered object to a graph. <a href="#details">More...</a></p>
<!-- @@@Custom3DVolume -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtDataVisualization 1.2</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> QtDataVisualization 1.2</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="qml-qtdatavisualization-custom3dvolume.html"><a href="qcustom3dvolume.html">QCustom3DVolume</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qtdatavisualization-custom3ditem.html">Custom3DItem</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qtdatavisualization-custom3dvolume-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-qtdatavisualization-custom3dvolume.html#alphaMultiplier-prop">alphaMultiplier</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-custom3dvolume.html#drawSliceFrames-prop">drawSliceFrames</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-custom3dvolume.html#drawSlices-prop">drawSlices</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-custom3dvolume.html#preserveOpacity-prop">preserveOpacity</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-custom3dvolume.html#sliceFrameColor-prop">sliceFrameColor</a></b></b> : color</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-custom3dvolume.html#sliceFrameGaps-prop">sliceFrameGaps</a></b></b> : vector3d</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-custom3dvolume.html#sliceFrameThicknesses-prop">sliceFrameThicknesses</a></b></b> : vector3d</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-custom3dvolume.html#sliceFrameWidths-prop">sliceFrameWidths</a></b></b> : vector3d</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-custom3dvolume.html#sliceIndexX-prop">sliceIndexX</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-custom3dvolume.html#sliceIndexY-prop">sliceIndexY</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-custom3dvolume.html#sliceIndexZ-prop">sliceIndexZ</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-custom3dvolume.html#textureDepth-prop">textureDepth</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-custom3dvolume.html#textureHeight-prop">textureHeight</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-custom3dvolume.html#textureWidth-prop">textureWidth</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtdatavisualization-custom3dvolume.html#useHighDefShader-prop">useHighDefShader</a></b></b> : bool</li>
</ul>
<!-- $$$Custom3DVolume-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>A volume rendered object is a box with a 3D texture. Three slice planes are supported for the volume, one along each main axis of the volume.</p>
<p>Rendering volume objects is very performance intensive, especially when the volume is largely transparent, as the contents of the volume are ray-traced. The performance scales nearly linearly with the amount of pixels that the volume occupies on the screen, so showing the volume in a smaller view or limiting the zoom level of the graph are easy ways to improve performance. Similarly, the volume texture dimensions have a large impact on performance. If the frame rate is more important than pixel-perfect rendering of the volume contents, consider turning the high definition shader off by setting the <a href="qml-qtdatavisualization-custom3dvolume.html#useHighDefShader-prop">useHighDefShader</a> property to <code>false</code>.</p>
<p><b>Note: </b>Filling in the volume data would not typically be efficient or practical from pure QML, so properties directly related to that are not fully supported from QML. Create a hybrid QML/C++ application if you want to use volume objects with a Qt Quick UI.</p><p><b>Note: </b>Volumetric objects are only supported with orthographic projection.</p><p><b>Note: </b>Volumetric objects utilize 3D textures, which are not supported in OpenGL ES2 environments.</p><p><b>See also </b><a href="qml-qtdatavisualization-abstractgraph3d.html#orthoProjection-prop">AbstractGraph3D::orthoProjection</a> and <a href="qml-qtdatavisualization-custom3dvolume.html#useHighDefShader-prop">useHighDefShader</a>.</p>
<!-- @@@Custom3DVolume -->
<h2>Property Documentation</h2>
<!-- $$$alphaMultiplier -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="alphaMultiplier-prop">
<td class="tblQmlPropNode"><p>
<a name="alphaMultiplier-prop"></a><span class="name">alphaMultiplier</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The alpha value of every texel of the volume texture is multiplied with this value at the render time. This can be used to introduce uniform transparency to the volume. If <a href="qml-qtdatavisualization-custom3dvolume.html#preserveOpacity-prop">preserveOpacity</a> is <code>true</code>, only texels with at least some transparency to begin with are affected, and fully opaque texels are not affected. The value must not be negative. Defaults to <code>1.0</code>.</p>
<p><b>See also </b><a href="qml-qtdatavisualization-custom3dvolume.html#preserveOpacity-prop">preserveOpacity</a>.</p>
</div></div><!-- @@@alphaMultiplier -->
<br/>
<!-- $$$drawSliceFrames -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="drawSliceFrames-prop">
<td class="tblQmlPropNode"><p>
<a name="drawSliceFrames-prop"></a><span class="name">drawSliceFrames</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>If this property value is <code>true</code>, the frames of slices indicated by slice index properties will be drawn around the volume. If it is <code>false</code>, no slice frames will be drawn. Drawing slice frames is independent of drawing slices, so you can show the full volume and still draw the slice frames around it. Defaults to <code>false</code>.</p>
<p><b>See also </b><a href="qml-qtdatavisualization-custom3dvolume.html#sliceIndexX-prop">sliceIndexX</a>, <a href="qml-qtdatavisualization-custom3dvolume.html#sliceIndexY-prop">sliceIndexY</a>, <a href="qml-qtdatavisualization-custom3dvolume.html#sliceIndexZ-prop">sliceIndexZ</a>, and <a href="qml-qtdatavisualization-custom3dvolume.html#drawSlices-prop">drawSlices</a>.</p>
</div></div><!-- @@@drawSliceFrames -->
<br/>
<!-- $$$drawSlices -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="drawSlices-prop">
<td class="tblQmlPropNode"><p>
<a name="drawSlices-prop"></a><span class="name">drawSlices</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>If this property value is <code>true</code>, the slices indicated by slice index properties will be drawn instead of the full volume. If it is <code>false</code>, the full volume will always be drawn. Defaults to <code>false</code>.</p>
<p><b>Note: </b>The slices are always drawn along the item axes, so if the item is rotated, the slices are rotated as well.</p><p><b>See also </b><a href="qml-qtdatavisualization-custom3dvolume.html#sliceIndexX-prop">sliceIndexX</a>, <a href="qml-qtdatavisualization-custom3dvolume.html#sliceIndexY-prop">sliceIndexY</a>, and <a href="qml-qtdatavisualization-custom3dvolume.html#sliceIndexZ-prop">sliceIndexZ</a>.</p>
</div></div><!-- @@@drawSlices -->
<br/>
<!-- $$$preserveOpacity -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="preserveOpacity-prop">
<td class="tblQmlPropNode"><p>
<a name="preserveOpacity-prop"></a><span class="name">preserveOpacity</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>If this property value is <code>true</code>, <a href="qml-qtdatavisualization-custom3dvolume.html#alphaMultiplier-prop">alphaMultiplier</a> is only applied to texels that already have some transparency. If it is <code>false</code>, the multiplier is applied to the alpha value of all texels. Defaults to <code>true</code>.</p>
<p><b>See also </b><a href="qml-qtdatavisualization-custom3dvolume.html#alphaMultiplier-prop">alphaMultiplier</a>.</p>
</div></div><!-- @@@preserveOpacity -->
<br/>
<!-- $$$sliceFrameColor -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="sliceFrameColor-prop">
<td class="tblQmlPropNode"><p>
<a name="sliceFrameColor-prop"></a><span class="name">sliceFrameColor</span> : <span class="type">color</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The color of the slice frame. Transparent slice frame color is not supported.</p>
<p>Defaults to black.</p>
<p><b>See also </b><a href="qml-qtdatavisualization-custom3dvolume.html#drawSliceFrames-prop">drawSliceFrames</a>.</p>
</div></div><!-- @@@sliceFrameColor -->
<br/>
<!-- $$$sliceFrameGaps -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="sliceFrameGaps-prop">
<td class="tblQmlPropNode"><p>
<a name="sliceFrameGaps-prop"></a><span class="name">sliceFrameGaps</span> : <span class="type">vector3d</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The size of the air gap left between the volume itself and the frame in each dimension. The gap can be different on different dimensions. The values are fractions of the volume thickness in the same dimension. The values cannot be negative.</p>
<p>Defaults to <code>vector3d(0.01, 0.01, 0.01)</code>.</p>
<p><b>See also </b><a href="qml-qtdatavisualization-custom3dvolume.html#drawSliceFrames-prop">drawSliceFrames</a>.</p>
</div></div><!-- @@@sliceFrameGaps -->
<br/>
<!-- $$$sliceFrameThicknesses -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="sliceFrameThicknesses-prop">
<td class="tblQmlPropNode"><p>
<a name="sliceFrameThicknesses-prop"></a><span class="name">sliceFrameThicknesses</span> : <span class="type">vector3d</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The thickness of the slice frames for each dimension. The values are fractions of the volume thickness in the same dimension. The values cannot be negative.</p>
<p>Defaults to <code>vector3d(0.01, 0.01, 0.01)</code>.</p>
<p><b>See also </b><a href="qml-qtdatavisualization-custom3dvolume.html#drawSliceFrames-prop">drawSliceFrames</a>.</p>
</div></div><!-- @@@sliceFrameThicknesses -->
<br/>
<!-- $$$sliceFrameWidths -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="sliceFrameWidths-prop">
<td class="tblQmlPropNode"><p>
<a name="sliceFrameWidths-prop"></a><span class="name">sliceFrameWidths</span> : <span class="type">vector3d</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The widths of the slice frame. The width can be different on different dimensions, so you can for example omit drawing the frames on certain sides of the volume by setting the value for that dimension to zero. The values are fractions of the volume thickness in the same dimension. The values cannot be negative.</p>
<p>Defaults to <code>vector3d(0.01, 0.01, 0.01)</code>.</p>
<p><b>See also </b><a href="qml-qtdatavisualization-custom3dvolume.html#drawSliceFrames-prop">drawSliceFrames</a>.</p>
</div></div><!-- @@@sliceFrameWidths -->
<br/>
<!-- $$$sliceIndexX -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="sliceIndexX-prop">
<td class="tblQmlPropNode"><p>
<a name="sliceIndexX-prop"></a><span class="name">sliceIndexX</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The x-dimension index into the texture data indicating which vertical slice to show. Setting any dimension to negative indicates no slice or slice frame for that dimension is drawn. If all dimensions are negative, no slices or slice frames are drawn and the volume is drawn normally. Defaults to <code>-1</code>.</p>
<p><b>See also </b><a href="qcustom3dvolume.html#textureData-prop">QCustom3DVolume::textureData</a>, <a href="qml-qtdatavisualization-custom3dvolume.html#drawSlices-prop">drawSlices</a>, and <a href="qml-qtdatavisualization-custom3dvolume.html#drawSliceFrames-prop">drawSliceFrames</a>.</p>
</div></div><!-- @@@sliceIndexX -->
<br/>
<!-- $$$sliceIndexY -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="sliceIndexY-prop">
<td class="tblQmlPropNode"><p>
<a name="sliceIndexY-prop"></a><span class="name">sliceIndexY</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The y-dimension index into the texture data indicating which horizontal slice to show. Setting any dimension to negative indicates no slice or slice frame for that dimension is drawn. If all dimensions are negative, no slices or slice frames are drawn and the volume is drawn normally. Defaults to <code>-1</code>.</p>
<p><b>See also </b><a href="qcustom3dvolume.html#textureData-prop">QCustom3DVolume::textureData</a>, <a href="qml-qtdatavisualization-custom3dvolume.html#drawSlices-prop">drawSlices</a>, and <a href="qml-qtdatavisualization-custom3dvolume.html#drawSliceFrames-prop">drawSliceFrames</a>.</p>
</div></div><!-- @@@sliceIndexY -->
<br/>
<!-- $$$sliceIndexZ -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="sliceIndexZ-prop">
<td class="tblQmlPropNode"><p>
<a name="sliceIndexZ-prop"></a><span class="name">sliceIndexZ</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The z-dimension index into the texture data indicating which vertical slice to show. Setting any dimension to negative indicates no slice or slice frame for that dimension is drawn. If all dimensions are negative, no slices or slice frames are drawn and the volume is drawn normally. Defaults to <code>-1</code>.</p>
<p><b>See also </b><a href="qcustom3dvolume.html#textureData-prop">QCustom3DVolume::textureData</a>, <a href="qml-qtdatavisualization-custom3dvolume.html#drawSlices-prop">drawSlices</a>, and <a href="qml-qtdatavisualization-custom3dvolume.html#drawSliceFrames-prop">drawSliceFrames</a>.</p>
</div></div><!-- @@@sliceIndexZ -->
<br/>
<!-- $$$textureDepth -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="textureDepth-prop">
<td class="tblQmlPropNode"><p>
<a name="textureDepth-prop"></a><span class="name">textureDepth</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The depth of the 3D texture defining the volume content in pixels. Defaults to <code>0</code>.</p>
<p><b>Note: </b>Changing this property from QML is not supported, as the texture data cannot be resized accordingly.</p></div></div><!-- @@@textureDepth -->
<br/>
<!-- $$$textureHeight -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="textureHeight-prop">
<td class="tblQmlPropNode"><p>
<a name="textureHeight-prop"></a><span class="name">textureHeight</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The height of the 3D texture defining the volume content in pixels. Defaults to <code>0</code>.</p>
<p><b>Note: </b>Changing this property from QML is not supported, as the texture data cannot be resized accordingly.</p></div></div><!-- @@@textureHeight -->
<br/>
<!-- $$$textureWidth -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="textureWidth-prop">
<td class="tblQmlPropNode"><p>
<a name="textureWidth-prop"></a><span class="name">textureWidth</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The width of the 3D texture defining the volume content in pixels. Defaults to <code>0</code>.</p>
<p><b>Note: </b>Changing this property from QML is not supported, as the texture data cannot be resized accordingly.</p></div></div><!-- @@@textureWidth -->
<br/>
<!-- $$$useHighDefShader -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="useHighDefShader-prop">
<td class="tblQmlPropNode"><p>
<a name="useHighDefShader-prop"></a><span class="name">useHighDefShader</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>If this property value is <code>true</code>, a high definition shader is used to render the volume. If it is <code>false</code>, a low definition shader is used.</p>
<p>The high definition shader guarantees that every visible texel of the volume texture is sampled when the volume is rendered. The low definition shader renders only a rough approximation of the volume contents, but at a much higher frame rate. The low definition shader does not guarantee every texel of the volume texture is sampled, so there may be flickering if the volume contains distinct thin features.</p>
<p><b>Note: </b>This value does not affect the level of detail when rendering the slices of the volume.</p><p>Defaults to <code>true</code>.</p>
</div></div><!-- @@@useHighDefShader -->
<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>
