<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcustom3dlabel.cpp -->
<title>QCustom3DLabel Class | 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-module.html">C++ Classes</a></td><td >QCustom3DLabel</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="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</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">QCustom3DLabel Class</h1>
<!-- $$$QCustom3DLabel-brief -->
<p>The <a href="qcustom3dlabel.html">QCustom3DLabel</a> class adds a custom label to a graph. <a href="#details">More...</a></p>
<!-- @@@QCustom3DLabel -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QCustom3DLabel></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> QtDataVisualization 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qtdatavisualization-custom3dlabel.html">Custom3DLabel</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qcustom3ditem.html">QCustom3DItem</a></td></tr></table></div><ul>
<li><a href="qcustom3dlabel-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<div class="table"><table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><b><a href="qcustom3dlabel.html#backgroundColor-prop">backgroundColor</a></b> : QColor</li>
<li class="fn"><b><a href="qcustom3dlabel.html#backgroundEnabled-prop">backgroundEnabled</a></b> : bool</li>
<li class="fn"><b><a href="qcustom3dlabel.html#borderEnabled-prop">borderEnabled</a></b> : bool</li>
<li class="fn"><b><a href="qcustom3dlabel.html#facingCamera-prop">facingCamera</a></b> : bool</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="qcustom3dlabel.html#font-prop">font</a></b> : QFont</li>
<li class="fn"><b><a href="qcustom3dlabel.html#text-prop">text</a></b> : QString</li>
<li class="fn"><b><a href="qcustom3dlabel.html#textColor-prop">textColor</a></b> : QColor</li>
</ul>
</td></tr>
</table></div>
<ul>
<li class="fn">9 properties inherited from <a href="qcustom3ditem.html#properties">QCustom3DItem</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#QCustom3DLabel">QCustom3DLabel</a></b>(QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#QCustom3DLabel-1">QCustom3DLabel</a></b>(const QString &<i>text</i>, const QFont &<i>font</i>, const QVector3D &<i>position</i>, const QVector3D &<i>scaling</i>, const QQuaternion &<i>rotation</i>, QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#dtor.QCustom3DLabel">~QCustom3DLabel</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QColor </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#backgroundColor-prop">backgroundColor</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QFont </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#font-prop">font</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#backgroundEnabled-prop">isBackgroundEnabled</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#borderEnabled-prop">isBorderEnabled</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#facingCamera-prop">isFacingCamera</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#backgroundColor-prop">setBackgroundColor</a></b>(const QColor &<i>color</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#backgroundEnabled-prop">setBackgroundEnabled</a></b>(bool <i>enabled</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#borderEnabled-prop">setBorderEnabled</a></b>(bool <i>enabled</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#facingCamera-prop">setFacingCamera</a></b>(bool <i>enabled</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#font-prop">setFont</a></b>(const QFont &<i>font</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#text-prop">setText</a></b>(const QString &<i>text</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#textColor-prop">setTextColor</a></b>(const QColor &<i>color</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#text-prop">text</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QColor </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#textColor-prop">textColor</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">20 public functions inherited from <a href="qcustom3ditem.html#public-functions">QCustom3DItem</a></li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#backgroundColor-prop">backgroundColorChanged</a></b>(const QColor &<i>color</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#backgroundEnabled-prop">backgroundEnabledChanged</a></b>(bool <i>enabled</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#borderEnabled-prop">borderEnabledChanged</a></b>(bool <i>enabled</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#facingCamera-prop">facingCameraChanged</a></b>(bool <i>enabled</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#font-prop">fontChanged</a></b>(const QFont &<i>font</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#text-prop">textChanged</a></b>(const QString &<i>text</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#textColor-prop">textColorChanged</a></b>(const QColor &<i>color</i>)</td></tr>
</table></div>
<ul>
<li class="fn">9 signals inherited from <a href="qcustom3ditem.html#signals">QCustom3DItem</a></li>
</ul>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qcustom3dlabel.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QCustom3DLabel-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qcustom3dlabel.html">QCustom3DLabel</a> class adds a custom label to a graph.</p>
<p>The text, font, position, scaling, rotation, and colors of a custom label can be set. In addition, the visibility of the borders and background of the label can be toggled. Colors, borders, and background are determined by the active theme unless set explicitly.</p>
<p><b>Note: </b>In scaling, the z-coordinate has no effect. Setting the same x- and y-coordinates retains the original font dimensions.</p></div>
<p><b>See also </b><a href="qabstract3dgraph.html#addCustomItem">QAbstract3DGraph::addCustomItem</a>().</p>
<!-- @@@QCustom3DLabel -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$backgroundColor-prop$$$backgroundColor$$$setBackgroundColorconstQColor&$$$backgroundColorChangedconstQColor& -->
<h3 class="fn" id="backgroundColor-prop"><a name="backgroundColor-prop"></a><span class="name">backgroundColor</span> : <span class="type">QColor</span></h3>
<p>This property holds the color for the label background, if enabled.</p>
<p>Defaults to <code>Qt::gray</code>.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QColor </td><td class="memItemRight bottomAlign"><span class="name"><b>backgroundColor</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setBackgroundColor</b></span>(const QColor &<i>color</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>backgroundColorChanged</b></span>(const QColor &<i>color</i>)</td></tr>
</table></div>
<p><b>See also </b><a href="qcustom3dlabel.html#backgroundEnabled-prop">backgroundEnabled</a>.</p>
<!-- @@@backgroundColor -->
<!-- $$$backgroundEnabled-prop$$$isBackgroundEnabled$$$setBackgroundEnabledbool$$$backgroundEnabledChangedbool -->
<h3 class="fn" id="backgroundEnabled-prop"><a name="backgroundEnabled-prop"></a><span class="name">backgroundEnabled</span> : <span class="type">bool</span></h3>
<p>This property holds whether the label background is enabled.</p>
<p>If set to <code>false</code>, <a href="qcustom3dlabel.html#backgroundColor-prop">backgroundColor</a>() has no effect. Defaults to <code>true</code>.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isBackgroundEnabled</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setBackgroundEnabled</b></span>(bool <i>enabled</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>backgroundEnabledChanged</b></span>(bool <i>enabled</i>)</td></tr>
</table></div>
<!-- @@@backgroundEnabled -->
<!-- $$$borderEnabled-prop$$$isBorderEnabled$$$setBorderEnabledbool$$$borderEnabledChangedbool -->
<h3 class="fn" id="borderEnabled-prop"><a name="borderEnabled-prop"></a><span class="name">borderEnabled</span> : <span class="type">bool</span></h3>
<p>This property holds whether label borders are enabled.</p>
<p>Defaults to <code>true</code>.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isBorderEnabled</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setBorderEnabled</b></span>(bool <i>enabled</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>borderEnabledChanged</b></span>(bool <i>enabled</i>)</td></tr>
</table></div>
<!-- @@@borderEnabled -->
<!-- $$$facingCamera-prop$$$isFacingCamera$$$setFacingCamerabool$$$facingCameraChangedbool -->
<h3 class="fn" id="facingCamera-prop"><a name="facingCamera-prop"></a><span class="name">facingCamera</span> : <span class="type">bool</span></h3>
<p>This property holds whether the label will always face the camera.</p>
<p>Defaults to <code>false</code>. If set to <code>true</code>, <a href="qcustom3ditem.html#rotation-prop">rotation</a>() has no effect.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isFacingCamera</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setFacingCamera</b></span>(bool <i>enabled</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>facingCameraChanged</b></span>(bool <i>enabled</i>)</td></tr>
</table></div>
<!-- @@@facingCamera -->
<!-- $$$font-prop$$$font$$$setFontconstQFont&$$$fontChangedconstQFont& -->
<h3 class="fn" id="font-prop"><a name="font-prop"></a><span class="name">font</span> : <span class="type">QFont</span></h3>
<p>This property holds the font to be used for the label.</p>
<p>Defaults to <code>QFont("Arial", 20)</code>. Special formatting (for example, outlined) is not supported.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QFont </td><td class="memItemRight bottomAlign"><span class="name"><b>font</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setFont</b></span>(const QFont &<i>font</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>fontChanged</b></span>(const QFont &<i>font</i>)</td></tr>
</table></div>
<!-- @@@font -->
<!-- $$$text-prop$$$text$$$setTextconstQString&$$$textChangedconstQString& -->
<h3 class="fn" id="text-prop"><a name="text-prop"></a><span class="name">text</span> : <span class="type">QString</span></h3>
<p>This property holds the text for the label.</p>
<p>Rich text is not supported.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b>text</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setText</b></span>(const QString &<i>text</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>textChanged</b></span>(const QString &<i>text</i>)</td></tr>
</table></div>
<!-- @@@text -->
<!-- $$$textColor-prop$$$textColor$$$setTextColorconstQColor&$$$textColorChangedconstQColor& -->
<h3 class="fn" id="textColor-prop"><a name="textColor-prop"></a><span class="name">textColor</span> : <span class="type">QColor</span></h3>
<p>This property holds the color for the label text.</p>
<p>Also affects the label border, if enabled. Defaults to <code>Qt::white</code>.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QColor </td><td class="memItemRight bottomAlign"><span class="name"><b>textColor</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setTextColor</b></span>(const QColor &<i>color</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>textColorChanged</b></span>(const QColor &<i>color</i>)</td></tr>
</table></div>
<p><b>See also </b><a href="qcustom3dlabel.html#borderEnabled-prop">borderEnabled</a>.</p>
<!-- @@@textColor -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QCustom3DLabel[overload1]$$$QCustom3DLabelQObject* -->
<h3 class="fn" id="QCustom3DLabel"><a name="QCustom3DLabel"></a>QCustom3DLabel::<span class="name">QCustom3DLabel</span>(<span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>Constructs a custom 3D label with the given <i>parent</i>.</p>
<!-- @@@QCustom3DLabel -->
<!-- $$$QCustom3DLabel$$$QCustom3DLabelconstQString&constQFont&constQVector3D&constQVector3D&constQQuaternion&QObject* -->
<h3 class="fn" id="QCustom3DLabel-1"><a name="QCustom3DLabel-1"></a>QCustom3DLabel::<span class="name">QCustom3DLabel</span>(const <span class="type">QString</span> &<i>text</i>, const <span class="type">QFont</span> &<i>font</i>, const <span class="type">QVector3D</span> &<i>position</i>, const <span class="type">QVector3D</span> &<i>scaling</i>, const <span class="type">QQuaternion</span> &<i>rotation</i>, <span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>Constructs a custom 3D label with the given <i>text</i>, <i>font</i>, <i>position</i>, <i>scaling</i>, <i>rotation</i>, and optional <i>parent</i>.</p>
<p><b>Note: </b>Setting the same x- and y-coordinates for <i>scaling</i> retains the original font dimensions.</p><!-- @@@QCustom3DLabel -->
<!-- $$$~QCustom3DLabel[overload1]$$$~QCustom3DLabel -->
<h3 class="fn" id="dtor.QCustom3DLabel"><a name="dtor.QCustom3DLabel"></a><code>[virtual] </code>QCustom3DLabel::<span class="name">~QCustom3DLabel</span>()</h3>
<p>Deletes the custom 3D label.</p>
<!-- @@@~QCustom3DLabel -->
</div>
</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-updates
>
by-pkgid
>
845e36bb3ecce380666d628d88446962
>
files
>
107
